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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 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
…		…
190	the message into vi commands to load the file.	223	the message into vi commands to load the file.
191		224
192	=item tabbed	225	=item tabbed
193		226
194	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
195	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
196	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
197	button per tab.	230	button per tab.
198		231
199	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
200	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,
201	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
202		235
203	=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):
204		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
205	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
206	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
207	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
208	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.
209		258
210	=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.
211		263
212	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
213	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
214	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
215		267
216	@@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.
217		315
218	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
219		317
220	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
221	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
222	similar-looking ascii character.	320	similar-looking ascii character.
223		321
224	=item digital-clock	322	=item digital-clock
225		323
226	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.
227		393
228	=item example-refresh-hooks	394	=item example-refresh-hooks
229		395
230	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
231	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
232	overlays or changes.	398	overlays or changes.
233		399
234	=item selection-pastebin	400	=item confirm-paste
235		401
236	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
237	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
238	not currently secure for use in a multiuser environment as it writes to
239	F</tmp> directly.).
240		404
241	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
242	i.e.
243		406
244	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:
245		410
246	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
247	the textfile. This command can be set via a resource:
248
249	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
250
251	And the default is likely not useful to anybody but the few people around
252	here :)
253
254	The name of the textfile is the hex encoded md5 sum of the selection, so
255	the same content should lead to the same filename.
256
257	After a successful upload the selection will be replaced by the text given
258	in the C<selection-pastebin-url> resource (again, the % is the placeholder
259	for the filename):
260
261	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
262		412
263	=back	413	=back
264		414
265	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
266		416
…		…
282		432
283	=over 4	433	=over 4
284		434
285	=item $text	435	=item $text
286		436
287	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
288	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.
289		439
290	=item $string	440	=item $string
291		441
292	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
…		…
296	=item $octets	446	=item $octets
297		447
298	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
299	locale-specific way.	449	locale-specific way.
300		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
301	=back	457	=back
302		458
303	=head2 Extension Objects	459	=head2 Extension Objects
304		460
305	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
306	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
307	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
308	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
309	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
310	use.	467	internal use.
311		468
312	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
313	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
314		471
315	It has the following methods and data members:	472	It has the following methods and data members:
…		…
336	=head2 Hooks	493	=head2 Hooks
337		494
338	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
339	called whenever the relevant event happens.	496	called whenever the relevant event happens.
340		497
341	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
342	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
343		500
344	B<All> of these hooks must return a boolean value. If any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
345	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
346	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
359	place.	516	place.
360		517
361	=item on_start $term	518	=item on_start $term
362		519
363	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
364	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
365		522
366	=item on_destroy $term	523	=item on_destroy $term
367		524
368	Called whenever something tries to destroy terminal, before doing anything	525	Called whenever something tries to destroy terminal, when the terminal is
369	yet. If this hook returns true, then destruction is skipped, but this is	526	still fully functional (not for long, though).
370	rarely a good idea.
371		527
372	=item on_reset $term	528	=item on_reset $term
373		529
374	Called after the screen is "reset" for any reason, such as resizing or	530	Called after the screen is "reset" for any reason, such as resizing or
375	control sequences. Here is where you can react on changes to size-related	531	control sequences. Here is where you can react on changes to size-related
…		…
397		553
398	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
399	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
400	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
401		557
402	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
403		559
404	=item on_sel_extend $term	560	=item on_sel_extend $term
405		561
406	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
407	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
408	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
409	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
410	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
411	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
412		568
413	See the F<selection> example extension.	569	See the F<selection> example extension.
414		570
415	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
416		572
417	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
418	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
419	show this many lines of scrollback.	575	show this many lines of scrollback.
420		576
421	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
422		578
…		…
426		582
427	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
428	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
429	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
430		586
431	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
432		598
433	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
434	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
435	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
436	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
437	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
438	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
439		615
440	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
441	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
442	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
443		622
444	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
445		624
446	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
447	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
452	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
453		632
454	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
455	suppress or filter tty input.	634	suppress or filter tty input.
456		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
457	=item on_line_update $term, $row	643	=item on_line_update $term, $row
458		644
459	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
460	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
461	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
468	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
469	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
470		656
471	=item on_refresh_begin $term	657	=item on_refresh_begin $term
472		658
473	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
474	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
475	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
476	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
477		663
478	=item on_refresh_end $term	664	=item on_refresh_end $term
479		665
480	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
481		667
482	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
483		669
484	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
485	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
486	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_resize_all_windows $term, $new_width, $new_height
		678
		679	Called just after the new window size has been calculated, but before
		680	windows are actually being resized or hints are being set. If this hook
		681	returns TRUE, setting of the window hints is being skipped.
487		682
488	=item on_x_event $term, $event	683	=item on_x_event $term, $event
489		684
490	Called on every X event received on the vt window (and possibly other	685	Called on every X event received on the vt window (and possibly other
491	windows). Should only be used as a last resort. Most event structure	686	windows). Should only be used as a last resort. Most event structure
492	members are not passed.	687	members are not passed.
493		688
		689	=item on_root_event $term, $event
		690
		691	Like C<on_x_event>, but is called for events on the root window.
		692
494	=item on_focus_in $term	693	=item on_focus_in $term
495		694
496	Called whenever the window gets the keyboard focus, before rxvt-unicode	695	Called whenever the window gets the keyboard focus, before rxvt-unicode
497	does focus in processing.	696	does focus in processing.
498		697
499	=item on_focus_out $term	698	=item on_focus_out $term
500		699
501	Called wheneever the window loses keyboard focus, before rxvt-unicode does	700	Called whenever the window loses keyboard focus, before rxvt-unicode does
502	focus out processing.	701	focus out processing.
503		702
504	=item on_configure_notify $term, $event	703	=item on_configure_notify $term, $event
505		704
506	=item on_property_notify $term, $event	705	=item on_property_notify $term, $event
…		…
517		716
518	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
519		718
520	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
521		720
522	Called whenever the corresponding X event is received for the terminal If	721	Called whenever the corresponding X event is received for the terminal. If
523	the hook returns true, then the even will be ignored by rxvt-unicode.	722	the hook returns true, then the event will be ignored by rxvt-unicode.
524		723
525	The event is a hash with most values as named by Xlib (see the XEvent	724	The event is a hash with most values as named by Xlib (see the XEvent
526	manpage), with the additional members C<row> and C<col>, which are the	725	manpage), with the additional members C<row> and C<col>, which are the
527	(real, not screen-based) row and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
528		727
…		…
537		736
538	=item on_wm_delete_window $term, $event	737	=item on_wm_delete_window $term, $event
539		738
540	Called when various types of ClientMessage events are received (all with	739	Called when various types of ClientMessage events are received (all with
541	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	740	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		741
		742	=item on_bell $term
		743
		744	Called on receipt of a bell character.
542		745
543	=back	746	=back
544		747
545	=cut	748	=cut
546		749
…		…
589	The current terminal. This variable stores the current C<urxvt::term>	792	The current terminal. This variable stores the current C<urxvt::term>
590	object, whenever a callback/hook is executing.	793	object, whenever a callback/hook is executing.
591		794
592	=item @urxvt::TERM_INIT	795	=item @urxvt::TERM_INIT
593		796
594	All coderefs in this array will be called as methods of the next newly	797	All code references in this array will be called as methods of the next newly
595	created C<urxvt::term> object (during the C<on_init> phase). The array	798	created C<urxvt::term> object (during the C<on_init> phase). The array
596	gets cleared before the codereferences that were in it are being executed,	799	gets cleared before the code references that were in it are being executed,
597	so coderefs can push themselves onto it again if they so desire.	800	so references can push themselves onto it again if they so desire.
598		801
599	This complements to the perl-eval commandline option, but gets executed	802	This complements to the perl-eval command line option, but gets executed
600	first.	803	first.
601		804
602	=item @urxvt::TERM_EXT	805	=item @urxvt::TERM_EXT
603		806
604	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	807	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
611		814
612	=over 4	815	=over 4
613		816
614	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
615		818
616	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
617	costs! The only time this is acceptable is when the terminal process	820	include a trailing newline). Avoid at all costs! The only time this
618	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
619		823
620	=item urxvt::warn $string	824	=item urxvt::warn $string
621		825
622	Calls C<rxvt_warn> with the given string which should not include a	826	Calls C<rxvt_warn> with the given string which should include a trailing
623	newline. The module also overwrites the C<warn> builtin with a function	827	newline. The module also overwrites the C<warn> builtin with a function
624	that calls this function.	828	that calls this function.
625		829
626	Using this function has the advantage that its output ends up in the	830	Using this function has the advantage that its output ends up in the
627	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
628		832
629	Messages have a size limit of 1023 bytes currently.	833	Messages have a size limit of 1023 bytes currently.
		834
		835	=item @terms = urxvt::termlist
		836
		837	Returns all urxvt::term objects that exist in this process, regardless of
		838	whether they are started, being destroyed etc., so be careful. Only term
		839	objects that have perl extensions attached will be returned (because there
		840	is no urxvt::term object associated with others).
630		841
631	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
632		843
633	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
634		845
…		…
677		888
678	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
679		890
680	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
681		892
682	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	893	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		894	urxvt::RS_RVid, urxvt::RS_Uline
683		895
684	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
685	underline, respectively. To enable such a style, just logically OR it into	897	underline, respectively. To enable such a style, just logically OR it into
686	the bitset.	898	the bitset.
687		899
…		…
692	Return the foreground/background colour index, respectively.	904	Return the foreground/background colour index, respectively.
693		905
694	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	906	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
695		907
696	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	908	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		909
		910	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
697		911
698	Replace the foreground/background colour in the rendition mask with the	912	Replace the foreground/background colour in the rendition mask with the
699	specified one.	913	specified one.
700		914
701	=item $value = urxvt::GET_CUSTOM $rend	915	=item $value = urxvt::GET_CUSTOM $rend
…		…
767	sub invoke {	981	sub invoke {
768	local $TERM = shift;	982	local $TERM = shift;
769	my $htype = shift;	983	my $htype = shift;
770		984
771	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
772	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
773		987
774	my %ext_arg;	988	my %ext_arg;
775		989
776	{	990	{
777	my @init = @TERM_INIT;	991	my @init = @TERM_INIT;
778	@TERM_INIT = ();	992	@TERM_INIT = ();
…		…
792	} else {	1006	} else {
793	$ext_arg{$_} \|\|= [];	1007	$ext_arg{$_} \|\|= [];
794	}	1008	}
795	}	1009	}
796		1010
797	while (my ($ext, $argv) = each %ext_arg) {	1011	for my $ext (sort keys %ext_arg) {
798	my @files = grep -f $_, map "$_/$ext", @dirs;	1012	my @files = grep -f $_, map "$_/$ext", @dirs;
799		1013
800	if (@files) {	1014	if (@files) {
801	$TERM->register_package (extension_package $files[0], $argv);	1015	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
802	} else {	1016	} else {
803	warn "perl extension '$ext' not found in perl library search path\n";	1017	warn "perl extension '$ext' not found in perl library search path\n";
804	}	1018	}
805	}	1019	}
806		1020
…		…
812		1026
813	if (my $cb = $TERM->{_hook}[$htype]) {	1027	if (my $cb = $TERM->{_hook}[$htype]) {
814	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1028	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
815	if $verbosity >= 10;	1029	if $verbosity >= 10;
816		1030
817	keys %$cb;	1031	for my $pkg (keys %$cb) {
818
819	while (my ($pkg, $cb) = each %$cb) {
820	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1032	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
821	$retval \|\|= $retval_;	1033	$retval \|\|= $retval_;
822		1034
823	if ($@) {	1035	if ($@) {
824	$TERM->ungrab; # better to lose the grab than the session	1036	$TERM->ungrab; # better to lose the grab than the session
825	warn $@;	1037	warn $@;
…		…
837	# clear package	1049	# clear package
838	%$TERM = ();	1050	%$TERM = ();
839	}	1051	}
840		1052
841	$retval	1053	$retval
		1054	}
		1055
		1056	sub SET_COLOR($$$) {
		1057	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1058	}
		1059
		1060	sub rend2mask {
		1061	no strict 'refs';
		1062	my ($str, $mask) = (@_, 0);
		1063	my %color = ( fg => undef, bg => undef );
		1064	my @failed;
		1065	for my $spec ( split /\s+/, $str ) {
		1066	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1067	$color{lc($1)} = $2;
		1068	} else {
		1069	my $neg = $spec =~ s/^[-^]//;
		1070	unless ( exists &{"RS_$spec"} ) {
		1071	push @failed, $spec;
		1072	next;
		1073	}
		1074	my $cur = &{"RS_$spec"};
		1075	if ( $neg ) {
		1076	$mask &= ~$cur;
		1077	} else {
		1078	$mask \|= $cur;
		1079	}
		1080	}
		1081	}
		1082	($mask, @color{qw(fg bg)}, \@failed)
842	}	1083	}
843		1084
844	# urxvt::term::extension	1085	# urxvt::term::extension
845		1086
846	package urxvt::term::extension;	1087	package urxvt::term::extension;
…		…
917	is that you cannot use blocking APIs, but the non-blocking variant should	1158	is that you cannot use blocking APIs, but the non-blocking variant should
918	work.	1159	work.
919		1160
920	=cut	1161	=cut
921		1162
922	our $VERSION = 1;	1163	our $VERSION = '5.23';
923		1164
924	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
925	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
926		1167
927	sub timer {	1168	sub timer {
…		…
929		1170
930	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
931		1172
932	urxvt::timer	1173	urxvt::timer
933	->new	1174	->new
934	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
935	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
936	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
937	$cb->();	1178	$cb->();
938	})	1179	})
939	}	1180	}
940		1181
941	sub io {	1182	sub io {
942	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
943		1184
944	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
945		1188
946	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
947	->new	1190	->new
948	->fd (fileno $arg{fh})	1191	->fd ($fd)
949	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
950	\| ($arg{poll} =~ /w/ ? 2 : 0))	1193	\| ($arg{poll} =~ /w/ ? 2 : 0))
951	->start	1194	->start
952	->cb (sub {	1195	->cb ($cb)
953	$cb->(($_[1] & 1 ? 'r' : '')
954	. ($_[1] & 2 ? 'w' : ''));
955	})],
956	urxvt::anyevent::	1196	], urxvt::anyevent::
		1197	}
		1198
		1199	sub idle {
		1200	my ($class, %arg) = @_;
		1201
		1202	my $cb = $arg{cb};
		1203
		1204	urxvt::iw
		1205	->new
		1206	->start
		1207	->cb ($cb)
		1208	}
		1209
		1210	sub child {
		1211	my ($class, %arg) = @_;
		1212
		1213	my $cb = $arg{cb};
		1214
		1215	urxvt::pw
		1216	->new
		1217	->start ($arg{pid})
		1218	->cb (sub {
		1219	$_[0]->stop; # need to cancel manually
		1220	$cb->($_[0]->rpid, $_[0]->rstatus);
		1221	})
957	}	1222	}
958		1223
959	sub DESTROY {	1224	sub DESTROY {
960	$_[0][1]->stop;	1225	$_[0][1]->stop;
961	}	1226	}
962		1227
963	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
964	bless \my $flag, urxvt::anyevent::condvar::	1229	sub one_event {
965	}
966
967	sub urxvt::anyevent::condvar::broadcast {
968	${$_[0]}++;
969	}
970
971	sub urxvt::anyevent::condvar::wait {
972	unless (${$_[0]}) {
973	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1230	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
974	}
975	}	1231	}
976		1232
977	package urxvt::term;	1233	package urxvt::term;
978		1234
979	=head2 The C<urxvt::term> Class	1235	=head2 The C<urxvt::term> Class
…		…
1015	hash which defines the environment of the new terminal.	1271	hash which defines the environment of the new terminal.
1016		1272
1017	Croaks (and probably outputs an error message) if the new instance	1273	Croaks (and probably outputs an error message) if the new instance
1018	couldn't be created. Returns C<undef> if the new instance didn't	1274	couldn't be created. Returns C<undef> if the new instance didn't
1019	initialise perl, and the terminal object otherwise. The C<init> and	1275	initialise perl, and the terminal object otherwise. The C<init> and
1020	C<start> hooks will be called during this call.	1276	C<start> hooks will be called before this call returns, and are free to
		1277	refer to global data (which is race free).
1021		1278
1022	=cut	1279	=cut
1023		1280
1024	sub new {	1281	sub new {
1025	my ($class, $env, @args) = @_;	1282	my ($class, $env, @args) = @_;
1026		1283
		1284	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1285	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1286
1027	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1287	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1028	}	1288	}
1029		1289
1030	=item $term->destroy	1290	=item $term->destroy
1031		1291
1032	Destroy the terminal object (close the window, free resources	1292	Destroy the terminal object (close the window, free resources
…		…
1062		1322
1063	Returns true if the option specified by C<$optval> is enabled, and	1323	Returns true if the option specified by C<$optval> is enabled, and
1064	optionally change it. All option values are stored by name in the hash	1324	optionally change it. All option values are stored by name in the hash
1065	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1325	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1066		1326
1067	Here is a a likely non-exhaustive list of option names, please see the	1327	Here is a likely non-exhaustive list of option names, please see the
1068	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
1069		1329
1070	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
1071	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1072	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1073	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1074	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1075	transparent tripleclickwords utmpInhibit visualBell	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1336	urgentOnBell utmpInhibit visualBell
1076		1337
1077	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
1078		1339
1079	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
1080	optionally sets a new value. Setting values is most useful in the C<init>	1341	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1089	likely change).	1350	likely change).
1090		1351
1091	Please note that resource strings will currently only be freed when the	1352	Please note that resource strings will currently only be freed when the
1092	terminal is destroyed, so changing options frequently will eat memory.	1353	terminal is destroyed, so changing options frequently will eat memory.
1093		1354
1094	Here is a a likely non-exhaustive list of resource names, not all of which	1355	Here is a likely non-exhaustive list of resource names, not all of which
1095	are supported in every build, please see the source file F</src/rsinc.h>	1356	are supported in every build, please see the source file F</src/rsinc.h>
1096	to see the actual list:	1357	to see the actual list:
1097		1358
1098	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1099	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1100	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1101	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1362	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1363	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1102	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1103	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1104	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1105	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1106	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1107	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1108	secondaryScreen secondaryScroll selectstyle shade term_name title	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1109	transient_for transparent transparent_all tripleclickwords utmpInhibit	1371	term_name title transient_for transparent tripleclickwords urgentOnBell
1110	visualBell	1372	utmpInhibit visualBell
1111		1373
1112	=cut	1374	=cut
1113		1375
1114	sub resource($$;$) {	1376	sub resource($$;$) {
1115	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
1116	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1117	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
1118	}	1380	}
1119		1381
1120	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
1121		1383
1122	Returns the X-Resource for the given pattern, excluding the program or	1384	Returns the X-Resource for the given pattern, excluding the program or
…		…
1126		1388
1127	This method should only be called during the C<on_start> hook, as there is	1389	This method should only be called during the C<on_start> hook, as there is
1128	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
1129	the wrong resources.	1391	the wrong resources.
1130		1392
1131	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
1132		1394
1133	Adds a keymap translation exactly as specified via a resource. See the	1395	Adds a key binding exactly as specified via a resource. See the
1134	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1135		1397
1136	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
1137		1399
1138	Return and optionally change the current rendition. Text that is output by	1400	Return and optionally change the current rendition. Text that is output by
…		…
1147		1409
1148	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
1149		1411
1150	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
1151		1413
1152	Return the current values of the selection mark, begin or end positions,	1414	Return the current values of the selection mark, begin or end positions.
1153	and optionally set them to new values.	1415
		1416	When arguments are given, then the selection coordinates are set to
		1417	C<$row> and C<$col>, and the selection screen is set to the current
		1418	screen.
		1419
		1420	=item $screen = $term->selection_screen ([$screen])
		1421
		1422	Returns the current selection screen, and then optionally sets it.
1154		1423
1155	=item $term->selection_make ($eventtime[, $rectangular])	1424	=item $term->selection_make ($eventtime[, $rectangular])
1156		1425
1157	Tries to make a selection as set by C<selection_beg> and	1426	Tries to make a selection as set by C<selection_beg> and
1158	C<selection_end>. If C<$rectangular> is true (default: false), a	1427	C<selection_end>. If C<$rectangular> is true (default: false), a
1159	rectangular selection will be made. This is the prefered function to make	1428	rectangular selection will be made. This is the preferred function to make
1160	a selection.	1429	a selection.
1161		1430
1162	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1163		1432
1164	Try to request the primary selection text from the server (for example, as	1433	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1434	true) selection from the server. The corresponding text can be set
1165	set by the next method). No visual feedback will be given. This function	1435	with the next method. No visual feedback will be given. This function
1166	is mostly useful from within C<on_sel_grab> hooks.	1436	is mostly useful from within C<on_sel_grab> hooks.
1167		1437
1168	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
1169		1439
1170	Return the current selection text and optionally replace it by C<$newtext>.	1440	Return the current selection (clipboard if C<$clipboard> is true) text
		1441	and optionally replace it by C<$newtext>.
		1442
		1443	=item $term->selection_clear ([$clipboard])
		1444
		1445	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1171		1446
1172	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
1173		1448
1174	Create a simple multi-line overlay box. See the next method for details.	1449	Create a simple multi-line overlay box. See the next method for details.
1175		1450
…		…
1205		1480
1206	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
1207		1482
1208	=over 4	1483	=over 4
1209		1484
1210	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
1211		1486
1212	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1487	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1213	text in rxvt-unicode's special encoding and an array of rendition values	1488	text in rxvt-unicode's special encoding and an array of rendition values
1214	at a specific position inside the overlay.	1489	at a specific position inside the overlay.
		1490
		1491	If C<$rend> is missing, then the rendition will not be changed.
1215		1492
1216	=item $overlay->hide	1493	=item $overlay->hide
1217		1494
1218	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
1219		1496
…		…
1301	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1302	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1303		1580
1304	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1305		1582
1306	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1307	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1308	to the locale-specific encoding using C<< $term->locale_encode >>.	1585	to the locale-specific encoding using C<< $term->locale_encode >>.
		1586
		1587	=item $term->tt_paste ($octets)
		1588
		1589	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1590	CR and bracketing the data with control sequences if bracketed paste mode
		1591	is set.
1309		1592
1310	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1311		1594
1312	Replaces the event mask of the pty watcher by the given event mask. Can	1595	Replaces the event mask of the pty watcher by the given event mask. Can
1313	be used to suppress input and output handling to the pty/tty. See the	1596	be used to suppress input and output handling to the pty/tty. See the
…		…
1332	Adds the specified events to the vt event mask. Useful e.g. when you want	1615	Adds the specified events to the vt event mask. Useful e.g. when you want
1333	to receive pointer events all the times:	1616	to receive pointer events all the times:
1334		1617
1335	$term->vt_emask_add (urxvt::PointerMotionMask);	1618	$term->vt_emask_add (urxvt::PointerMotionMask);
1336		1619
		1620	=item $term->focus_in
		1621
		1622	=item $term->focus_out
		1623
		1624	=item $term->key_press ($state, $keycode[, $time])
		1625
		1626	=item $term->key_release ($state, $keycode[, $time])
		1627
		1628	Deliver various fake events to to terminal.
		1629
1337	=item $window_width = $term->width	1630	=item $window_width = $term->width
1338		1631
1339	=item $window_height = $term->height	1632	=item $window_height = $term->height
1340		1633
1341	=item $font_width = $term->fwidth	1634	=item $font_width = $term->fwidth
…		…
1371	=item $env = $term->env	1664	=item $env = $term->env
1372		1665
1373	Returns a copy of the environment in effect for the terminal as a hashref	1666	Returns a copy of the environment in effect for the terminal as a hashref
1374	similar to C<\%ENV>.	1667	similar to C<\%ENV>.
1375		1668
		1669	=item @envv = $term->envv
		1670
		1671	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1672
		1673	=item @argv = $term->argv
		1674
		1675	Return the argument vector as this terminal, similar to @ARGV, but
		1676	includes the program name as first element.
		1677
1376	=cut	1678	=cut
1377		1679
1378	sub env {	1680	sub env {
1379	if (my $env = $_[0]->_env) {
1380	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1681	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1381	} else {
1382	+{ %ENV }
1383	}
1384	}	1682	}
1385		1683
1386	=item $modifiermask = $term->ModLevel3Mask	1684	=item $modifiermask = $term->ModLevel3Mask
1387		1685
1388	=item $modifiermask = $term->ModMetaMask	1686	=item $modifiermask = $term->ModMetaMask
…		…
1396		1694
1397	Returns the currently displayed screen (0 primary, 1 secondary).	1695	Returns the currently displayed screen (0 primary, 1 secondary).
1398		1696
1399	=item $cursor_is_hidden = $term->hidden_cursor	1697	=item $cursor_is_hidden = $term->hidden_cursor
1400		1698
1401	Returns wether the cursor is currently hidden or not.	1699	Returns whether the cursor is currently hidden or not.
1402		1700
1403	=item $view_start = $term->view_start ([$newvalue])	1701	=item $view_start = $term->view_start ([$newvalue])
1404		1702
1405	Returns the row number of the topmost displayed line. Maximum value is	1703	Returns the row number of the topmost displayed line. Maximum value is
1406	C<0>, which displays the normal terminal contents. Lower values scroll	1704	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1414		1712
1415	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1416		1714
1417	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1418		1716
1419	Returns the text of the entire row with number C<$row_number>. Row C<0>	1717	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1420	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1718	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1421	terminal line. The scrollback buffer starts at line C<-1> and extends to
1422	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1423	is requested.	1720	is requested.
1424		1721
1425	If C<$new_text> is specified, it will replace characters in the current	1722	If C<$new_text> is specified, it will replace characters in the current
1426	line, starting at column C<$start_col> (default C<0>), which is useful	1723	line, starting at column C<$start_col> (default C<0>), which is useful
1427	to replace only parts of a line. The font index in the rendition will	1724	to replace only parts of a line. The font index in the rendition will
1428	automatically be updated.	1725	automatically be updated.
1429		1726
1430	C<$text> is in a special encoding: tabs and wide characters that use more	1727	C<$text> is in a special encoding: tabs and wide characters that use more
1431	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1728	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1432	characters. Characters with combining characters and other characters that	1729	characters. Characters with combining characters and other characters that
1433	do not fit into the normal tetx encoding will be replaced with characters	1730	do not fit into the normal text encoding will be replaced with characters
1434	in the private use area.	1731	in the private use area.
1435		1732
1436	You have to obey this encoding when changing text. The advantage is	1733	You have to obey this encoding when changing text. The advantage is
1437	that C<substr> and similar functions work on screen cells and not on	1734	that C<substr> and similar functions work on screen cells and not on
1438	characters.	1735	characters.
…		…
1583	where one character corresponds to one screen cell. See	1880	where one character corresponds to one screen cell. See
1584	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1585		1882
1586	=item $string = $term->special_decode $text	1883	=item $string = $term->special_decode $text
1587		1884
1588	Converts rxvt-unicodes text reprsentation into a perl string. See	1885	Converts rxvt-unicodes text representation into a perl string. See
1589	C<< $term->ROW_t >> for details.	1886	C<< $term->ROW_t >> for details.
1590		1887
1591	=item $success = $term->grab_button ($button, $modifiermask)	1888	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1592		1889
		1890	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1891
1593	Registers a synchronous button grab. See the XGrabButton manpage.	1892	Register/unregister a synchronous button grab. See the XGrabButton
		1893	manpage.
1594		1894
1595	=item $success = $term->grab ($eventtime[, $sync])	1895	=item $success = $term->grab ($eventtime[, $sync])
1596		1896
1597	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1897	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1598	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1898	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1599		1899
1600	=item $term->allow_events_async	1900	=item $term->allow_events_async
1601		1901
1602	Calls XAllowEvents with AsyncBoth for the most recent grab.	1902	Calls XAllowEvents with AsyncBoth for the most recent grab.
1603		1903
…		…
1610	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1611	recent grab.	1911	recent grab.
1612		1912
1613	=item $term->ungrab	1913	=item $term->ungrab
1614		1914
1615	Calls XUngrab for the most recent grab. Is called automatically on	1915	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1616	evaluation errors, as it is better to lose the grab in the error case as	1916	evaluation errors, as it is better to lose the grab in the error case as
1617	the session.	1917	the session.
1618		1918
1619	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1620		1920
…		…
1622		1922
1623	=item @atoms = $term->XListProperties ($window)	1923	=item @atoms = $term->XListProperties ($window)
1624		1924
1625	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626		1926
1627	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1628		1928
1629	=item $term->XDeleteProperty ($window, $property)	1929	=item $term->XDeleteProperty ($window, $property)
1630		1930
1631	=item $window = $term->DefaultRootWindow	1931	=item $window = $term->DefaultRootWindow
1632		1932
…		…
1639	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1640		1940
1641	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1642		1942
1643	=item $term->XChangeInput ($window, $add_events[, $del_events])	1943	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1944
		1945	=item $keysym = $term->XStringToKeysym ($string)
		1946
		1947	=item $string = $term->XKeysymToString ($keysym)
1644		1948
1645	Various X or X-related functions. The C<$term> object only serves as	1949	Various X or X-related functions. The C<$term> object only serves as
1646	the source of the display, otherwise those functions map more-or-less	1950	the source of the display, otherwise those functions map more-or-less
1647	directory onto the X functions of the same name.	1951	directly onto the X functions of the same name.
1648		1952
1649	=back	1953	=back
1650		1954
1651	=cut	1955	=cut
1652		1956
…		…
1716	my ($self, $text, $cb) = @_;	2020	my ($self, $text, $cb) = @_;
1717		2021
1718	$self->add_item ({ type => "button", text => $text, activate => $cb});	2022	$self->add_item ({ type => "button", text => $text, activate => $cb});
1719	}	2023	}
1720		2024
1721	=item $popup->add_toggle ($text, $cb, $initial_value)	2025	=item $popup->add_toggle ($text, $initial_value, $cb)
1722		2026
1723	Adds a toggle/checkbox item to the popup. Teh callback gets called	2027	Adds a toggle/checkbox item to the popup. The callback gets called
1724	whenever it gets toggled, with a boolean indicating its value as its first	2028	whenever it gets toggled, with a boolean indicating its new value as its
1725	argument.	2029	first argument.
1726		2030
1727	=cut	2031	=cut
1728		2032
1729	sub add_toggle {	2033	sub add_toggle {
1730	my ($self, $text, $cb, $value) = @_;	2034	my ($self, $text, $value, $cb) = @_;
1731		2035
1732	my $item; $item = {	2036	my $item; $item = {
1733	type => "button",	2037	type => "button",
1734	text => " $text",	2038	text => " $text",
1735	value => $value,	2039	value => $value,
…		…
1754	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1755	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2059	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1756	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1757	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1758		2062
1759	urxvt::term->new ($env, "popup",	2063	my $term = urxvt::term->new (
		2064	$env, "popup",
1760	"--perl-lib" => "", "--perl-ext-common" => "",	2065	"--perl-lib" => "", "--perl-ext-common" => "",
1761	"-pty-fd" => -1, "-sl" => 0,	2066	"-pty-fd" => -1, "-sl" => 0,
1762	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1763	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1764	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1765	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1766	or die "unable to create popup window\n";	2071	) or die "unable to create popup window\n";
		2072
		2073	unless (delete $term->{urxvt_popup_init_done}) {
		2074	$term->ungrab;
		2075	$term->destroy;
		2076	die "unable to initialise popup window\n";
		2077	}
1767	}	2078	}
1768		2079
1769	sub DESTROY {	2080	sub DESTROY {
1770	my ($self) = @_;	2081	my ($self) = @_;
1771		2082
…		…
1776	=back	2087	=back
1777		2088
1778	=cut	2089	=cut
1779		2090
1780	package urxvt::watcher;	2091	package urxvt::watcher;
1781
1782	@urxvt::timer::ISA = __PACKAGE__;
1783	@urxvt::iow::ISA = __PACKAGE__;
1784	@urxvt::pw::ISA = __PACKAGE__;
1785	@urxvt::iw::ISA = __PACKAGE__;
1786		2092
1787	=head2 The C<urxvt::timer> Class	2093	=head2 The C<urxvt::timer> Class
1788		2094
1789	This class implements timer watchers/events. Time is represented as a	2095	This class implements timer watchers/events. Time is represented as a
1790	fractional number of seconds since the epoch. Example:	2096	fractional number of seconds since the epoch. Example:
…		…
1794	->new	2100	->new
1795	->interval (1)	2101	->interval (1)
1796	->cb (sub {	2102	->cb (sub {
1797	$term->{overlay}->set (0, 0,	2103	$term->{overlay}->set (0, 0,
1798	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2104	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1799	});	2105	});
1800		2106
1801	=over 4	2107	=over 4
1802		2108
1803	=item $timer = new urxvt::timer	2109	=item $timer = new urxvt::timer
1804		2110
…		…
1807		2113
1808	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1809		2115
1810	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
1811		2117
1812	=item $tstamp = $timer->at
1813
1814	Return the time this watcher will fire next.
1815
1816	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
1817		2119
1818	Set the time the event is generated to $tstamp.	2120	Set the time the event is generated to $tstamp (and optionally specifies a
		2121	new $interval).
1819		2122
1820	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
1821		2124
1822	Normally (and when C<$interval> is C<0>), the timer will automatically	2125	By default (and when C<$interval> is C<0>), the timer will automatically
1823	stop after it has fired once. If C<$interval> is non-zero, then the timer	2126	stop after it has fired once. If C<$interval> is non-zero, then the timer
1824	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
1825		2128
1826	=item $timer = $timer->start	2129	=item $timer = $timer->start
1827		2130
1828	Start the timer.	2131	Start the timer.
1829		2132
1830	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
1831		2134
1832	Set the event trigger time to C<$tstamp> and start the timer.	2135	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2136	also replaces the interval.
1833		2137
1834	=item $timer = $timer->after ($delay)	2138	=item $timer = $timer->after ($delay[, $interval])
1835		2139
1836	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2140	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1837		2141
1838	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
1839		2143
…		…
1847		2151
1848	$term->{socket} = ...	2152	$term->{socket} = ...
1849	$term->{iow} = urxvt::iow	2153	$term->{iow} = urxvt::iow
1850	->new	2154	->new
1851	->fd (fileno $term->{socket})	2155	->fd (fileno $term->{socket})
1852	->events (urxvt::EVENT_READ)	2156	->events (urxvt::EV_READ)
1853	->start	2157	->start
1854	->cb (sub {	2158	->cb (sub {
1855	my ($iow, $revents) = @_;	2159	my ($iow, $revents) = @_;
1856	# $revents must be 1 here, no need to check	2160	# $revents must be 1 here, no need to check
1857	sysread $term->{socket}, my $buf, 8192	2161	sysread $term->{socket}, my $buf, 8192
…		…
1870	Set the callback to be called when io events are triggered. C<$reventmask>	2174	Set the callback to be called when io events are triggered. C<$reventmask>
1871	is a bitset as described in the C<events> method.	2175	is a bitset as described in the C<events> method.
1872		2176
1873	=item $iow = $iow->fd ($fd)	2177	=item $iow = $iow->fd ($fd)
1874		2178
1875	Set the filedescriptor (not handle) to watch.	2179	Set the file descriptor (not handle) to watch.
1876		2180
1877	=item $iow = $iow->events ($eventmask)	2181	=item $iow = $iow->events ($eventmask)
1878		2182
1879	Set the event mask to watch. The only allowed values are	2183	Set the event mask to watch. The only allowed values are
1880	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2184	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1881	together, or C<urxvt::EVENT_NONE>.	2185	together, or C<urxvt::EV_NONE>.
1882		2186
1883	=item $iow = $iow->start	2187	=item $iow = $iow->start
1884		2188
1885	Start watching for requested events on the given handle.	2189	Start watching for requested events on the given handle.
1886		2190
1887	=item $iow = $iow->stop	2191	=item $iow = $iow->stop
1888		2192
1889	Stop watching for events on the given filehandle.	2193	Stop watching for events on the given file handle.
1890		2194
1891	=back	2195	=back
1892		2196
1893	=head2 The C<urxvt::iw> Class	2197	=head2 The C<urxvt::iw> Class
1894		2198
…		…
1927	->new	2231	->new
1928	->start ($pid)	2232	->start ($pid)
1929	->cb (sub {	2233	->cb (sub {
1930	my ($pw, $exit_status) = @_;	2234	my ($pw, $exit_status) = @_;
1931	...	2235	...
1932	});	2236	});
1933		2237
1934	=over 4	2238	=over 4
1935		2239
1936	=item $pw = new urxvt::pw	2240	=item $pw = new urxvt::pw
1937		2241
…		…
1941		2245
1942	Set the callback to be called when the timer triggers.	2246	Set the callback to be called when the timer triggers.
1943		2247
1944	=item $pw = $timer->start ($pid)	2248	=item $pw = $timer->start ($pid)
1945		2249
1946	Tells the wqtcher to start watching for process C<$pid>.	2250	Tells the watcher to start watching for process C<$pid>.
1947		2251
1948	=item $pw = $pw->stop	2252	=item $pw = $pw->stop
1949		2253
1950	Stop the watcher.	2254	Stop the watcher.
1951		2255
…		…
1964		2268
1965	=item >= 3 - script loading and management	2269	=item >= 3 - script loading and management
1966		2270
1967	=item >=10 - all called hooks	2271	=item >=10 - all called hooks
1968		2272
1969	=item >=11 - hook reutrn values	2273	=item >=11 - hook return values
1970		2274
1971	=back	2275	=back
1972		2276
1973	=head1 AUTHOR	2277	=head1 AUTHOR
1974		2278
1975	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
1976	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
1977		2281
1978	=cut	2282	=cut
1979		2283
1980	1	2284	1
		2285
		2286	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC vs. Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC