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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.130 by root, Wed Jan 25 15:32:48 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: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	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
97	runtime.	100	runtime.
98		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	};
		118
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	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
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	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
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	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
110	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.
111	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
112	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
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	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
116	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
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	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>
133	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
134	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
135	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
136	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
137	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.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	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
142	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
143	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
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	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
203	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
204	button per tab.	230	button per tab.
205		231
206	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
207	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,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=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):
211		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
212	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
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	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
215	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		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
216		278
217	=item xim-onthespot	279	=item xim-onthespot
218		280
219	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
220	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
221	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
222	kinput2.	284	kinput2.
223		285
224	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
225	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
226		288
227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228		290
229	=item automove-background	291	=item kuake<hotkey>
230		292
231	This is basically a one-line extension that dynamically changes the background pixmap offset	293	A very primitive quake-console-like extension. It was inspired by a
232	to the window position, in effect creating the same effect as pseudo transparency with	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
233	a custom pixmap. No scaling is supported in this mode. Exmaple:	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.
234		298
235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
236		315
237	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
238		317
239	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
240	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
241	similar-looking ascii character.	320	similar-looking ascii character.
242		321
243	=item digital-clock	322	=item digital-clock
244		323
245	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
246		325
247	=item remote-clipboard	326	=item remote-clipboard
248		327
249	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
250	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
251	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
252		331
253	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
254	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
255	reads it.	334	reads it.
…		…
264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266		345
267	=item selection-pastebin	346	=item selection-pastebin
268		347
269	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
270	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
271	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
272	F</tmp> directly.).	351	F</tmp> directly.).
273		352
274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
291	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
292	for the filename):	371	for the filename):
293		372
294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295		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.
		393
296	=item example-refresh-hooks	394	=item example-refresh-hooks
297		395
298	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
299	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
300	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		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:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
301		412
302	=back	413	=back
303		414
304	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
305		416
…		…
321		432
322	=over 4	433	=over 4
323		434
324	=item $text	435	=item $text
325		436
326	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
327	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.
328		439
329	=item $string	440	=item $string
330		441
331	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
…		…
335	=item $octets	446	=item $octets
336		447
337	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
338	locale-specific way.	449	locale-specific way.
339		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
340	=back	457	=back
341		458
342	=head2 Extension Objects	459	=head2 Extension Objects
343		460
344	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
345	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,
346	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
347	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
348	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
349	use.	467	internal use.
350		468
351	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
352	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
353		471
354	It has the following methods and data members:	472	It has the following methods and data members:
…		…
375	=head2 Hooks	493	=head2 Hooks
376		494
377	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
378	called whenever the relevant event happens.	496	called whenever the relevant event happens.
379		497
380	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
381	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
382		500
383	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
384	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
385	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
398	place.	516	place.
399		517
400	=item on_start $term	518	=item on_start $term
401		519
402	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
403	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
404		522
405	=item on_destroy $term	523	=item on_destroy $term
406		524
407	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
408	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
435		553
436	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
437	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
438	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
439		557
440	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.
441		559
442	=item on_sel_extend $term	560	=item on_sel_extend $term
443		561
444	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
445	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
446	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
447	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
448	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
449	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
450		568
451	See the F<selection> example extension.	569	See the F<selection> example extension.
452		570
453	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
454		572
455	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
456	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
457	show this many lines of scrollback.	575	show this many lines of scrollback.
458		576
459	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
460		578
…		…
464		582
465	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,
466	$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
467	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
468		586
469	=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
470		598
471	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
473	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
474	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,
475	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
476	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	}
477		615
478	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,
479	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
480	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.
481		622
482	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
483		624
484	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
485	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
…		…
490	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
491		632
492	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
493	suppress or filter tty input.	634	suppress or filter tty input.
494		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
495	=item on_line_update $term, $row	643	=item on_line_update $term, $row
496		644
497	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
498	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
499	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,
…		…
506	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
507	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
508		656
509	=item on_refresh_begin $term	657	=item on_refresh_begin $term
510		658
511	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
512	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
513	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
514	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
515		663
516	=item on_refresh_end $term	664	=item on_refresh_end $term
517		665
518	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>.
519		667
520	=item on_user_command $term, $string	668	=item on_user_command $term, $string
521		669
522	Called whenever the a user-configured event is being activated (e.g. via	670	Called whenever a user-configured event is being activated (e.g. via
523	a C<perl:string> action bound to a key, see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
524	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
525		673
526	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
527	slightly in the future.	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.
528		682
529	=item on_x_event $term, $event	683	=item on_x_event $term, $event
530		684
531	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
532	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
533	members are not passed.	687	members are not passed.
534		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
535	=item on_focus_in $term	693	=item on_focus_in $term
536		694
537	Called whenever the window gets the keyboard focus, before rxvt-unicode	695	Called whenever the window gets the keyboard focus, before rxvt-unicode
538	does focus in processing.	696	does focus in processing.
539		697
540	=item on_focus_out $term	698	=item on_focus_out $term
541		699
542	Called wheneever the window loses keyboard focus, before rxvt-unicode does	700	Called whenever the window loses keyboard focus, before rxvt-unicode does
543	focus out processing.	701	focus out processing.
544		702
545	=item on_configure_notify $term, $event	703	=item on_configure_notify $term, $event
546		704
547	=item on_property_notify $term, $event	705	=item on_property_notify $term, $event
…		…
558		716
559	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
560		718
561	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
562		720
563	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
564	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.
565		723
566	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
567	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
568	(real, not screen-based) row and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
569		727
…		…
578		736
579	=item on_wm_delete_window $term, $event	737	=item on_wm_delete_window $term, $event
580		738
581	Called when various types of ClientMessage events are received (all with	739	Called when various types of ClientMessage events are received (all with
582	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.
583		745
584	=back	746	=back
585		747
586	=cut	748	=cut
587		749
…		…
630	The current terminal. This variable stores the current C<urxvt::term>	792	The current terminal. This variable stores the current C<urxvt::term>
631	object, whenever a callback/hook is executing.	793	object, whenever a callback/hook is executing.
632		794
633	=item @urxvt::TERM_INIT	795	=item @urxvt::TERM_INIT
634		796
635	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
636	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
637	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,
638	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.
639		801
640	This complements to the perl-eval commandline option, but gets executed	802	This complements to the perl-eval command line option, but gets executed
641	first.	803	first.
642		804
643	=item @urxvt::TERM_EXT	805	=item @urxvt::TERM_EXT
644		806
645	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
…		…
652		814
653	=over 4	815	=over 4
654		816
655	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
656		818
657	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
658	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
659	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
660		823
661	=item urxvt::warn $string	824	=item urxvt::warn $string
662		825
663	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
664	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
665	that calls this function.	828	that calls this function.
666		829
667	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
668	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
669		832
670	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).
671		841
672	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
673		843
674	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
675		845
…		…
718		888
719	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
720		890
721	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
722		892
723	=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
724		895
725	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
726	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
727	the bitset.	898	the bitset.
728		899
…		…
733	Return the foreground/background colour index, respectively.	904	Return the foreground/background colour index, respectively.
734		905
735	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	906	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
736		907
737	=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
738		911
739	Replace the foreground/background colour in the rendition mask with the	912	Replace the foreground/background colour in the rendition mask with the
740	specified one.	913	specified one.
741		914
742	=item $value = urxvt::GET_CUSTOM $rend	915	=item $value = urxvt::GET_CUSTOM $rend
…		…
808	sub invoke {	981	sub invoke {
809	local $TERM = shift;	982	local $TERM = shift;
810	my $htype = shift;	983	my $htype = shift;
811		984
812	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
813	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
814		987
815	my %ext_arg;	988	my %ext_arg;
816		989
817	{	990	{
818	my @init = @TERM_INIT;	991	my @init = @TERM_INIT;
819	@TERM_INIT = ();	992	@TERM_INIT = ();
…		…
833	} else {	1006	} else {
834	$ext_arg{$_} \|\|= [];	1007	$ext_arg{$_} \|\|= [];
835	}	1008	}
836	}	1009	}
837		1010
838	while (my ($ext, $argv) = each %ext_arg) {	1011	for my $ext (sort keys %ext_arg) {
839	my @files = grep -f $_, map "$_/$ext", @dirs;	1012	my @files = grep -f $_, map "$_/$ext", @dirs;
840		1013
841	if (@files) {	1014	if (@files) {
842	$TERM->register_package (extension_package $files[0], $argv);	1015	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
843	} else {	1016	} else {
844	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";
845	}	1018	}
846	}	1019	}
847		1020
…		…
853		1026
854	if (my $cb = $TERM->{_hook}[$htype]) {	1027	if (my $cb = $TERM->{_hook}[$htype]) {
855	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1028	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
856	if $verbosity >= 10;	1029	if $verbosity >= 10;
857		1030
858	keys %$cb;	1031	for my $pkg (keys %$cb) {
859
860	while (my ($pkg, $cb) = each %$cb) {
861	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1032	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
862	$retval \|\|= $retval_;	1033	$retval \|\|= $retval_;
863		1034
864	if ($@) {	1035	if ($@) {
865	$TERM->ungrab; # better to lose the grab than the session	1036	$TERM->ungrab; # better to lose the grab than the session
866	warn $@;	1037	warn $@;
…		…
878	# clear package	1049	# clear package
879	%$TERM = ();	1050	%$TERM = ();
880	}	1051	}
881		1052
882	$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)
883	}	1083	}
884		1084
885	# urxvt::term::extension	1085	# urxvt::term::extension
886		1086
887	package urxvt::term::extension;	1087	package urxvt::term::extension;
…		…
958	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
959	work.	1159	work.
960		1160
961	=cut	1161	=cut
962		1162
963	our $VERSION = 1;	1163	our $VERSION = '5.23';
964		1164
965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
967		1167
968	sub timer {	1168	sub timer {
…		…
970		1170
971	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
972		1172
973	urxvt::timer	1173	urxvt::timer
974	->new	1174	->new
975	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
976	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
977	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
978	$cb->();	1178	$cb->();
979	})	1179	})
980	}	1180	}
981		1181
982	sub io {	1182	sub io {
983	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
984		1184
985	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
986		1188
987	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
988	->new	1190	->new
989	->fd (fileno $arg{fh})	1191	->fd ($fd)
990	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
991	\| ($arg{poll} =~ /w/ ? 2 : 0))	1193	\| ($arg{poll} =~ /w/ ? 2 : 0))
992	->start	1194	->start
993	->cb (sub {	1195	->cb ($cb)
994	$cb->(($_[1] & 1 ? 'r' : '')
995	. ($_[1] & 2 ? 'w' : ''));
996	})],
997	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	})
998	}	1222	}
999		1223
1000	sub DESTROY {	1224	sub DESTROY {
1001	$_[0][1]->stop;	1225	$_[0][1]->stop;
1002	}	1226	}
1003		1227
1004	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
1005	bless \my $flag, urxvt::anyevent::condvar::	1229	sub one_event {
1006	}
1007
1008	sub urxvt::anyevent::condvar::broadcast {
1009	${$_[0]}++;
1010	}
1011
1012	sub urxvt::anyevent::condvar::wait {
1013	unless (${$_[0]}) {
1014	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";
1015	}
1016	}	1231	}
1017		1232
1018	package urxvt::term;	1233	package urxvt::term;
1019		1234
1020	=head2 The C<urxvt::term> Class	1235	=head2 The C<urxvt::term> Class
…		…
1056	hash which defines the environment of the new terminal.	1271	hash which defines the environment of the new terminal.
1057		1272
1058	Croaks (and probably outputs an error message) if the new instance	1273	Croaks (and probably outputs an error message) if the new instance
1059	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
1060	initialise perl, and the terminal object otherwise. The C<init> and	1275	initialise perl, and the terminal object otherwise. The C<init> and
1061	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).
1062		1278
1063	=cut	1279	=cut
1064		1280
1065	sub new {	1281	sub new {
1066	my ($class, $env, @args) = @_;	1282	my ($class, $env, @args) = @_;
1067		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
1068	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1287	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1069	}	1288	}
1070		1289
1071	=item $term->destroy	1290	=item $term->destroy
1072		1291
1073	Destroy the terminal object (close the window, free resources	1292	Destroy the terminal object (close the window, free resources
…		…
1103		1322
1104	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
1105	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
1106	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.
1107		1326
1108	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
1109	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
1110		1329
1111	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
1112	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1113	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1114	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1115	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1116	transparent tripleclickwords utmpInhibit visualBell	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1336	urgentOnBell utmpInhibit visualBell
1117		1337
1118	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
1119		1339
1120	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
1121	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>
…		…
1130	likely change).	1350	likely change).
1131		1351
1132	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
1133	terminal is destroyed, so changing options frequently will eat memory.	1353	terminal is destroyed, so changing options frequently will eat memory.
1134		1354
1135	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
1136	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>
1137	to see the actual list:	1357	to see the actual list:
1138		1358
1139	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1140	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1141	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1142	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
1143	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1144	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1145	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1146	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1147	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1148	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1149	secondaryScreen secondaryScroll selectstyle shade term_name title	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1150	transient_for transparent transparent_all tripleclickwords utmpInhibit	1371	term_name title transient_for transparent tripleclickwords urgentOnBell
1151	visualBell	1372	utmpInhibit visualBell
1152		1373
1153	=cut	1374	=cut
1154		1375
1155	sub resource($$;$) {	1376	sub resource($$;$) {
1156	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
1157	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1158	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
1159	}	1380	}
1160		1381
1161	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
1162		1383
1163	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
…		…
1167		1388
1168	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
1169	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
1170	the wrong resources.	1391	the wrong resources.
1171		1392
1172	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
1173		1394
1174	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
1175	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1176		1397
1177	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
1178		1399
1179	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
…		…
1188		1409
1189	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
1190		1411
1191	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
1192		1413
1193	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.
1194	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.
1195		1423
1196	=item $term->selection_make ($eventtime[, $rectangular])	1424	=item $term->selection_make ($eventtime[, $rectangular])
1197		1425
1198	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
1199	C<selection_end>. If C<$rectangular> is true (default: false), a	1427	C<selection_end>. If C<$rectangular> is true (default: false), a
1200	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
1201	a selection.	1429	a selection.
1202		1430
1203	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1204		1432
1205	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
1206	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
1207	is mostly useful from within C<on_sel_grab> hooks.	1436	is mostly useful from within C<on_sel_grab> hooks.
1208		1437
1209	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
1210		1439
1211	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.
1212		1446
1213	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
1214		1448
1215	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.
1216		1450
…		…
1246		1480
1247	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
1248		1482
1249	=over 4	1483	=over 4
1250		1484
1251	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
1252		1486
1253	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
1254	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
1255	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.
1256		1492
1257	=item $overlay->hide	1493	=item $overlay->hide
1258		1494
1259	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
1260		1496
…		…
1342	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1343	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1344		1580
1345	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1346		1582
1347	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
1348	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1349	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.
1350		1592
1351	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1352		1594
1353	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
1354	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
…		…
1373	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
1374	to receive pointer events all the times:	1616	to receive pointer events all the times:
1375		1617
1376	$term->vt_emask_add (urxvt::PointerMotionMask);	1618	$term->vt_emask_add (urxvt::PointerMotionMask);
1377		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
1378	=item $window_width = $term->width	1630	=item $window_width = $term->width
1379		1631
1380	=item $window_height = $term->height	1632	=item $window_height = $term->height
1381		1633
1382	=item $font_width = $term->fwidth	1634	=item $font_width = $term->fwidth
…		…
1412	=item $env = $term->env	1664	=item $env = $term->env
1413		1665
1414	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
1415	similar to C<\%ENV>.	1667	similar to C<\%ENV>.
1416		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
1417	=cut	1678	=cut
1418		1679
1419	sub env {	1680	sub env {
1420	if (my $env = $_[0]->_env) {
1421	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1681	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1422	} else {
1423	+{ %ENV }
1424	}
1425	}	1682	}
1426		1683
1427	=item $modifiermask = $term->ModLevel3Mask	1684	=item $modifiermask = $term->ModLevel3Mask
1428		1685
1429	=item $modifiermask = $term->ModMetaMask	1686	=item $modifiermask = $term->ModMetaMask
…		…
1437		1694
1438	Returns the currently displayed screen (0 primary, 1 secondary).	1695	Returns the currently displayed screen (0 primary, 1 secondary).
1439		1696
1440	=item $cursor_is_hidden = $term->hidden_cursor	1697	=item $cursor_is_hidden = $term->hidden_cursor
1441		1698
1442	Returns wether the cursor is currently hidden or not.	1699	Returns whether the cursor is currently hidden or not.
1443		1700
1444	=item $view_start = $term->view_start ([$newvalue])	1701	=item $view_start = $term->view_start ([$newvalue])
1445		1702
1446	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
1447	C<0>, which displays the normal terminal contents. Lower values scroll	1704	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1455		1712
1456	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1457		1714
1458	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1459		1716
1460	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 >>
1461	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
1462	terminal line. The scrollback buffer starts at line C<-1> and extends to
1463	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1464	is requested.	1720	is requested.
1465		1721
1466	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
1467	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
1468	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
1469	automatically be updated.	1725	automatically be updated.
1470		1726
1471	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
1472	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)
1473	characters. Characters with combining characters and other characters that	1729	characters. Characters with combining characters and other characters that
1474	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
1475	in the private use area.	1731	in the private use area.
1476		1732
1477	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
1478	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
1479	characters.	1735	characters.
…		…
1624	where one character corresponds to one screen cell. See	1880	where one character corresponds to one screen cell. See
1625	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1626		1882
1627	=item $string = $term->special_decode $text	1883	=item $string = $term->special_decode $text
1628		1884
1629	Converts rxvt-unicodes text reprsentation into a perl string. See	1885	Converts rxvt-unicodes text representation into a perl string. See
1630	C<< $term->ROW_t >> for details.	1886	C<< $term->ROW_t >> for details.
1631		1887
1632	=item $success = $term->grab_button ($button, $modifiermask)	1888	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1633		1889
		1890	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1891
1634	Registers a synchronous button grab. See the XGrabButton manpage.	1892	Register/unregister a synchronous button grab. See the XGrabButton
		1893	manpage.
1635		1894
1636	=item $success = $term->grab ($eventtime[, $sync])	1895	=item $success = $term->grab ($eventtime[, $sync])
1637		1896
1638	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1897	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1639	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1898	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1640		1899
1641	=item $term->allow_events_async	1900	=item $term->allow_events_async
1642		1901
1643	Calls XAllowEvents with AsyncBoth for the most recent grab.	1902	Calls XAllowEvents with AsyncBoth for the most recent grab.
1644		1903
…		…
1651	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1652	recent grab.	1911	recent grab.
1653		1912
1654	=item $term->ungrab	1913	=item $term->ungrab
1655		1914
1656	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
1657	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
1658	the session.	1917	the session.
1659		1918
1660	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1661		1920
…		…
1663		1922
1664	=item @atoms = $term->XListProperties ($window)	1923	=item @atoms = $term->XListProperties ($window)
1665		1924
1666	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1667		1926
1668	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1669		1928
1670	=item $term->XDeleteProperty ($window, $property)	1929	=item $term->XDeleteProperty ($window, $property)
1671		1930
1672	=item $window = $term->DefaultRootWindow	1931	=item $window = $term->DefaultRootWindow
1673		1932
…		…
1680	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1681		1940
1682	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1683		1942
1684	=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)
1685		1948
1686	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
1687	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
1688	directory onto the X functions of the same name.	1951	directly onto the X functions of the same name.
1689		1952
1690	=back	1953	=back
1691		1954
1692	=cut	1955	=cut
1693		1956
…		…
1757	my ($self, $text, $cb) = @_;	2020	my ($self, $text, $cb) = @_;
1758		2021
1759	$self->add_item ({ type => "button", text => $text, activate => $cb});	2022	$self->add_item ({ type => "button", text => $text, activate => $cb});
1760	}	2023	}
1761		2024
1762	=item $popup->add_toggle ($text, $cb, $initial_value)	2025	=item $popup->add_toggle ($text, $initial_value, $cb)
1763		2026
1764	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
1765	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
1766	argument.	2029	first argument.
1767		2030
1768	=cut	2031	=cut
1769		2032
1770	sub add_toggle {	2033	sub add_toggle {
1771	my ($self, $text, $cb, $value) = @_;	2034	my ($self, $text, $value, $cb) = @_;
1772		2035
1773	my $item; $item = {	2036	my $item; $item = {
1774	type => "button",	2037	type => "button",
1775	text => " $text",	2038	text => " $text",
1776	value => $value,	2039	value => $value,
…		…
1795	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1796	# 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.
1797	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1798	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1799		2062
1800	urxvt::term->new ($env, "popup",	2063	my $term = urxvt::term->new (
		2064	$env, "popup",
1801	"--perl-lib" => "", "--perl-ext-common" => "",	2065	"--perl-lib" => "", "--perl-ext-common" => "",
1802	"-pty-fd" => -1, "-sl" => 0,	2066	"-pty-fd" => -1, "-sl" => 0,
1803	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1804	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1805	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1806	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1807	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	}
1808	}	2078	}
1809		2079
1810	sub DESTROY {	2080	sub DESTROY {
1811	my ($self) = @_;	2081	my ($self) = @_;
1812		2082
…		…
1817	=back	2087	=back
1818		2088
1819	=cut	2089	=cut
1820		2090
1821	package urxvt::watcher;	2091	package urxvt::watcher;
1822
1823	@urxvt::timer::ISA = __PACKAGE__;
1824	@urxvt::iow::ISA = __PACKAGE__;
1825	@urxvt::pw::ISA = __PACKAGE__;
1826	@urxvt::iw::ISA = __PACKAGE__;
1827		2092
1828	=head2 The C<urxvt::timer> Class	2093	=head2 The C<urxvt::timer> Class
1829		2094
1830	This class implements timer watchers/events. Time is represented as a	2095	This class implements timer watchers/events. Time is represented as a
1831	fractional number of seconds since the epoch. Example:	2096	fractional number of seconds since the epoch. Example:
…		…
1835	->new	2100	->new
1836	->interval (1)	2101	->interval (1)
1837	->cb (sub {	2102	->cb (sub {
1838	$term->{overlay}->set (0, 0,	2103	$term->{overlay}->set (0, 0,
1839	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2104	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1840	});	2105	});
1841		2106
1842	=over 4	2107	=over 4
1843		2108
1844	=item $timer = new urxvt::timer	2109	=item $timer = new urxvt::timer
1845		2110
…		…
1848		2113
1849	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1850		2115
1851	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
1852		2117
1853	=item $tstamp = $timer->at
1854
1855	Return the time this watcher will fire next.
1856
1857	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
1858		2119
1859	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).
1860		2122
1861	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
1862		2124
1863	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
1864	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
1865	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
1866		2128
1867	=item $timer = $timer->start	2129	=item $timer = $timer->start
1868		2130
1869	Start the timer.	2131	Start the timer.
1870		2132
1871	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
1872		2134
1873	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.
1874		2137
1875	=item $timer = $timer->after ($delay)	2138	=item $timer = $timer->after ($delay[, $interval])
1876		2139
1877	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>.
1878		2141
1879	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
1880		2143
…		…
1888		2151
1889	$term->{socket} = ...	2152	$term->{socket} = ...
1890	$term->{iow} = urxvt::iow	2153	$term->{iow} = urxvt::iow
1891	->new	2154	->new
1892	->fd (fileno $term->{socket})	2155	->fd (fileno $term->{socket})
1893	->events (urxvt::EVENT_READ)	2156	->events (urxvt::EV_READ)
1894	->start	2157	->start
1895	->cb (sub {	2158	->cb (sub {
1896	my ($iow, $revents) = @_;	2159	my ($iow, $revents) = @_;
1897	# $revents must be 1 here, no need to check	2160	# $revents must be 1 here, no need to check
1898	sysread $term->{socket}, my $buf, 8192	2161	sysread $term->{socket}, my $buf, 8192
…		…
1911	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>
1912	is a bitset as described in the C<events> method.	2175	is a bitset as described in the C<events> method.
1913		2176
1914	=item $iow = $iow->fd ($fd)	2177	=item $iow = $iow->fd ($fd)
1915		2178
1916	Set the filedescriptor (not handle) to watch.	2179	Set the file descriptor (not handle) to watch.
1917		2180
1918	=item $iow = $iow->events ($eventmask)	2181	=item $iow = $iow->events ($eventmask)
1919		2182
1920	Set the event mask to watch. The only allowed values are	2183	Set the event mask to watch. The only allowed values are
1921	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
1922	together, or C<urxvt::EVENT_NONE>.	2185	together, or C<urxvt::EV_NONE>.
1923		2186
1924	=item $iow = $iow->start	2187	=item $iow = $iow->start
1925		2188
1926	Start watching for requested events on the given handle.	2189	Start watching for requested events on the given handle.
1927		2190
1928	=item $iow = $iow->stop	2191	=item $iow = $iow->stop
1929		2192
1930	Stop watching for events on the given filehandle.	2193	Stop watching for events on the given file handle.
1931		2194
1932	=back	2195	=back
1933		2196
1934	=head2 The C<urxvt::iw> Class	2197	=head2 The C<urxvt::iw> Class
1935		2198
…		…
1968	->new	2231	->new
1969	->start ($pid)	2232	->start ($pid)
1970	->cb (sub {	2233	->cb (sub {
1971	my ($pw, $exit_status) = @_;	2234	my ($pw, $exit_status) = @_;
1972	...	2235	...
1973	});	2236	});
1974		2237
1975	=over 4	2238	=over 4
1976		2239
1977	=item $pw = new urxvt::pw	2240	=item $pw = new urxvt::pw
1978		2241
…		…
1982		2245
1983	Set the callback to be called when the timer triggers.	2246	Set the callback to be called when the timer triggers.
1984		2247
1985	=item $pw = $timer->start ($pid)	2248	=item $pw = $timer->start ($pid)
1986		2249
1987	Tells the wqtcher to start watching for process C<$pid>.	2250	Tells the watcher to start watching for process C<$pid>.
1988		2251
1989	=item $pw = $pw->stop	2252	=item $pw = $pw->stop
1990		2253
1991	Stop the watcher.	2254	Stop the watcher.
1992		2255
…		…
2005		2268
2006	=item >= 3 - script loading and management	2269	=item >= 3 - script loading and management
2007		2270
2008	=item >=10 - all called hooks	2271	=item >=10 - all called hooks
2009		2272
2010	=item >=11 - hook reutrn values	2273	=item >=11 - hook return values
2011		2274
2012	=back	2275	=back
2013		2276
2014	=head1 AUTHOR	2277	=head1 AUTHOR
2015		2278
2016	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
2017	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
2018		2281
2019	=cut	2282	=cut
2020		2283
2021	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.130 by root, Wed Jan 25 15:32:48 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.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC