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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC

…		…
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
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
256	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
260		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
261	Example configuration:	268	Example configuration:
262		269
263	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
265	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
266	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
269	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
270		278
271	=item xim-onthespot	279	=item xim-onthespot
272		280
273	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
274	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
275	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
276	kinput2.	284	kinput2.
277		285
278	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
279	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
280		288
…		…
288	will show or hide itself. Another press of the accelerator key will hide	296	will show or hide itself. Another press of the accelerator key will hide
289	or show it again.	297	or show it again.
290		298
291	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
292		300
293	This is useful if you need a single terminal thats not using any desktop	301	This is useful if you need a single terminal that is not using any desktop
294	space most of the time but is quickly available at the press of a key.	302	space most of the time but is quickly available at the press of a key.
295		303
296	The accelerator key is grabbed regardless of any modifiers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
298		306
299	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
300	(fvwm can do it).	308	(fvwm can do it).
301		309
302	=item automove-background	310	=item overlay-osc
303		311
304	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
305	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
306	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312	shows how this extension can be used to implement an automatically blurred
313	transparent background.
314		315
315	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
316		317
317	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
318	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
…		…
323	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
324		325
325	=item remote-clipboard	326	=item remote-clipboard
326		327
327	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
328	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
329	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
330		331
331	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
332	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
333	reads it.	334	reads it.
…		…
342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
344		345
345	=item selection-pastebin	346	=item selection-pastebin
346		347
347	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
348	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
349	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
350	F</tmp> directly.).	351	F</tmp> directly.).
351		352
352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
371		372
372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373		374
374	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
375	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
376	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
377	or not.	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.
378		393
379	=item example-refresh-hooks	394	=item example-refresh-hooks
380		395
381	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
382	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
383	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"
384		412
385	=back	413	=back
386		414
387	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
388		416
…		…
404		432
405	=over 4	433	=over 4
406		434
407	=item $text	435	=item $text
408		436
409	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
410	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.
411		439
412	=item $string	440	=item $string
413		441
414	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
…		…
423	=back	451	=back
424		452
425	=head2 Extension Objects	453	=head2 Extension Objects
426		454
427	Every perl extension is a perl class. A separate perl object is created	455	Every perl extension is a perl class. A separate perl object is created
428	for each terminal, and each terminal has its own set of extenion objects,	456	for each terminal, and each terminal has its own set of extension objects,
429	which are passed as the first parameter to hooks. So extensions can use	457	which are passed as the first parameter to hooks. So extensions can use
430	their C<$self> object without having to think about clashes with other	458	their C<$self> object without having to think about clashes with other
431	extensions or other terminals, with the exception of methods and members	459	extensions or other terminals, with the exception of methods and members
432	that begin with an underscore character C<_>: these are reserved for	460	that begin with an underscore character C<_>: these are reserved for
433	internal use.	461	internal use.
…		…
548		576
549	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
550	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	578	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
551	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
552		580
553	=item on_osc_seq $term, $op, $args	581	=item on_osc_seq $term, $op, $args, $resp
554		582
555	Called on every OSC sequence and can be used to suppress it or modify its	583	Called on every OSC sequence and can be used to suppress it or modify its
556	behaviour. The default should be to return an empty list. A true value	584	behaviour. The default should be to return an empty list. A true value
557	suppresses execution of the request completely. Make sure you don't get	585	suppresses execution of the request completely. Make sure you don't get
558	confused by recursive invocations when you output an osc sequence within	586	confused by recursive invocations when you output an OSC sequence within
559	this callback.	587	this callback.
560		588
561	C<on_osc_seq_perl> should be used for new behaviour.	589	C<on_osc_seq_perl> should be used for new behaviour.
562		590
563	=item on_osc_seq_perl $term, $string	591	=item on_osc_seq_perl $term, $args, $resp
564		592
565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
567	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
568	string should start with the extension name and a colon, to distinguish	596	string should start with the extension name (sans -osc) and a semicolon,
569	it from commands for other extensions, and this might be enforced in the	597	to distinguish it from commands for other extensions, and this might be
570	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
571		609
572	Be careful not ever to trust (in a security sense) the data you receive,	610	Be careful not ever to trust (in a security sense) the data you receive,
573	as its source can not easily be controlled (e-mail content, messages from	611	as its source can not easily be controlled (e-mail content, messages from
574	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
575		616
576	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
577		618
578	Called whenever text is about to be output, with the text as argument. You	619	Called whenever text is about to be output, with the text as argument. You
579	can filter/change and output the text yourself by returning a true value	620	can filter/change and output the text yourself by returning a true value
…		…
584	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
585		626
586	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
587	suppress or filter tty input.	628	suppress or filter tty input.
588		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
589	=item on_line_update $term, $row	637	=item on_line_update $term, $row
590		638
591	Called whenever a line was updated or changed. Can be used to filter	639	Called whenever a line was updated or changed. Can be used to filter
592	screen output (e.g. underline urls or other useless stuff). Only lines	640	screen output (e.g. underline urls or other useless stuff). Only lines
593	that are being shown will be filtered, and, due to performance reasons,	641	that are being shown will be filtered, and, due to performance reasons,
…		…
600	later with the already-modified line (e.g. if unrelated parts change), so	648	later with the already-modified line (e.g. if unrelated parts change), so
601	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
602		650
603	=item on_refresh_begin $term	651	=item on_refresh_begin $term
604		652
605	Called just before the screen gets redrawn. Can be used for overlay	653	Called just before the screen gets redrawn. Can be used for overlay or
606	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
607	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
608	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
609		657
610	=item on_refresh_end $term	658	=item on_refresh_end $term
611		659
…		…
618	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
619		667
620	The event is simply the action string. This interface is assumed to change	668	The event is simply the action string. This interface is assumed to change
621	slightly in the future.	669	slightly in the future.
622		670
623	=item on_resize_all_windows $tern, $new_width, $new_height	671	=item on_resize_all_windows $term, $new_width, $new_height
624		672
625	Called just after the new window size has been calculated, but before	673	Called just after the new window size has been calculated, but before
626	windows are actually being resized or hints are being set. If this hook	674	windows are actually being resized or hints are being set. If this hook
627	returns TRUE, setting of the window hints is being skipped.	675	returns TRUE, setting of the window hints is being skipped.
628		676
…		…
662		710
663	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
664		712
665	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
666		714
667	Called whenever the corresponding X event is received for the terminal If	715	Called whenever the corresponding X event is received for the terminal. If
668	the hook returns true, then the even will be ignored by rxvt-unicode.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
669		717
670	The event is a hash with most values as named by Xlib (see the XEvent	718	The event is a hash with most values as named by Xlib (see the XEvent
671	manpage), with the additional members C<row> and C<col>, which are the	719	manpage), with the additional members C<row> and C<col>, which are the
672	(real, not screen-based) row and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
673		721
…		…
682		730
683	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
684		732
685	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
686	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
687		739
688	=back	740	=back
689		741
690	=cut	742	=cut
691		743
…		…
756		808
757	=over 4	809	=over 4
758		810
759	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
760		812
761	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
762	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
763	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
764		817
765	=item urxvt::warn $string	818	=item urxvt::warn $string
766		819
767	Calls C<rxvt_warn> with the given string which should not include a	820	Calls C<rxvt_warn> with the given string which should include a trailing
768	newline. The module also overwrites the C<warn> builtin with a function	821	newline. The module also overwrites the C<warn> builtin with a function
769	that calls this function.	822	that calls this function.
770		823
771	Using this function has the advantage that its output ends up in the	824	Using this function has the advantage that its output ends up in the
772	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
776	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
777		830
778	Returns all urxvt::term objects that exist in this process, regardless of	831	Returns all urxvt::term objects that exist in this process, regardless of
779	whether they are started, being destroyed etc., so be careful. Only term	832	whether they are started, being destroyed etc., so be careful. Only term
780	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
781	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
782		835
783	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
784		837
785	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
786		839
…		…
829		882
830	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
831		884
832	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
833		886
834	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
835		889
836	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
837	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
838	the bitset.	892	the bitset.
839		893
…		…
922	local $TERM = shift;	976	local $TERM = shift;
923	my $htype = shift;	977	my $htype = shift;
924		978
925	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
927		981
928	my %ext_arg;	982	my %ext_arg;
929		983
930	{	984	{
931	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
932	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
1098	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
1099	work.	1153	work.
1100		1154
1101	=cut	1155	=cut
1102		1156
1103	our $VERSION = 1;	1157	our $VERSION = '5.23';
1104		1158
1105	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107		1161
1108	sub timer {	1162	sub timer {
…		…
1110		1164
1111	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
1112		1166
1113	urxvt::timer	1167	urxvt::timer
1114	->new	1168	->new
1115	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1116	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1117	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1118	$cb->();	1172	$cb->();
1119	})	1173	})
1120	}	1174	}
1121		1175
1122	sub io {	1176	sub io {
1123	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1124		1178
1125	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1126		1182
1127	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1128	->new	1184	->new
1129	->fd (fileno $arg{fh})	1185	->fd ($fd)
1130	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1131	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1132	->start	1188	->start
1133	->cb (sub {	1189	->cb ($cb)
1134	$cb->(($_[1] & 1 ? 'r' : '')
1135	. ($_[1] & 2 ? 'w' : ''));
1136	})],
1137	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
1138	}	1216	}
1139		1217
1140	sub DESTROY {	1218	sub DESTROY {
1141	$_[0][1]->stop;	1219	$_[0][1]->stop;
1142	}	1220	}
1143		1221
1144	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
1145	bless \my $flag, urxvt::anyevent::
1146	}
1147
1148	sub broadcast {
1149	${$_[0]}++;
1150	}
1151
1152	sub wait {
1153	unless (${$_[0]}) {
1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155	}
1156	}
1157
1158	sub one_event {	1223	sub one_event {
1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160	}	1225	}
1161		1226
1162	package urxvt::term;	1227	package urxvt::term;
…		…
1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1255		1320
1256	Here is a likely non-exhaustive list of option names, please see the	1321	Here is a likely non-exhaustive list of option names, please see the
1257	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1258		1323
1259	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1260	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1261	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1262	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1263	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1264	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1265		1331
1266	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1267		1333
1268	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1269	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1282		1348
1283	Here is a likely non-exhaustive list of resource names, not all of which	1349	Here is a likely non-exhaustive list of resource names, not all of which
1284	are supported in every build, please see the source file F</src/rsinc.h>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1285	to see the actual list:	1351	to see the actual list:
1286		1352
1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1288	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1289	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1299	visualBell	1366	utmpInhibit visualBell
1300		1367
1301	=cut	1368	=cut
1302		1369
1303	sub resource($$;$) {	1370	sub resource($$;$) {
1304	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1305	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1306	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1307	}	1374	}
1308		1375
1309	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1310		1377
1311	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
1336		1403
1337	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1338		1405
1339	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1340		1407
1341	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1342	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1343		1417
1344	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1345		1419
1346	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1347	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1348	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1349	a selection.	1423	a selection.
1350		1424
1351	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352		1426
1353	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	true) selection from the server. The corresponding text can be set
1354	set by the next method). No visual feedback will be given. This function	1429	with the next method. No visual feedback will be given. This function
1355	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1356		1431
1357	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1358		1433
1359	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1360		1440
1361	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1362		1442
1363	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1364		1444
…		…
1394		1474
1395	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1396		1476
1397	=over 4	1477	=over 4
1398		1478
1399	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1400		1480
1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1402	text in rxvt-unicode's special encoding and an array of rendition values	1482	text in rxvt-unicode's special encoding and an array of rendition values
1403	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1404		1486
1405	=item $overlay->hide	1487	=item $overlay->hide
1406		1488
1407	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1408		1490
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1492		1574
1493	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1494		1576
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1498		1586
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1588
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1589	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1590	be used to suppress input and output handling to the pty/tty. See the
…		…
1618		1706
1619	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1620		1708
1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622		1710
1623	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1712	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1625	terminal line. The scrollback buffer starts at line C<-1> and extends to
1626	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1627	is requested.	1714	is requested.
1628		1715
1629	If C<$new_text> is specified, it will replace characters in the current	1716	If C<$new_text> is specified, it will replace characters in the current
1630	line, starting at column C<$start_col> (default C<0>), which is useful	1717	line, starting at column C<$start_col> (default C<0>), which is useful
1631	to replace only parts of a line. The font index in the rendition will	1718	to replace only parts of a line. The font index in the rendition will
1632	automatically be updated.	1719	automatically be updated.
1633		1720
1634	C<$text> is in a special encoding: tabs and wide characters that use more	1721	C<$text> is in a special encoding: tabs and wide characters that use more
1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1637	do not fit into the normal tetx encoding will be replaced with characters	1724	do not fit into the normal text encoding will be replaced with characters
1638	in the private use area.	1725	in the private use area.
1639		1726
1640	You have to obey this encoding when changing text. The advantage is	1727	You have to obey this encoding when changing text. The advantage is
1641	that C<substr> and similar functions work on screen cells and not on	1728	that C<substr> and similar functions work on screen cells and not on
1642	characters.	1729	characters.
…		…
1817	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818	recent grab.	1905	recent grab.
1819		1906
1820	=item $term->ungrab	1907	=item $term->ungrab
1821		1908
1822	Calls XUngrab for the most recent grab. Is called automatically on	1909	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1823	evaluation errors, as it is better to lose the grab in the error case as	1910	evaluation errors, as it is better to lose the grab in the error case as
1824	the session.	1911	the session.
1825		1912
1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827		1914
…		…
1829		1916
1830	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1831		1918
1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833		1920
1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835		1922
1836	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1837		1924
1838	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1839		1926
…		…
1849		1936
1850	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1851		1938
1852	Various X or X-related functions. The C<$term> object only serves as	1939	Various X or X-related functions. The C<$term> object only serves as
1853	the source of the display, otherwise those functions map more-or-less	1940	the source of the display, otherwise those functions map more-or-less
1854	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1855		1942
1856	=back	1943	=back
1857		1944
1858	=cut	1945	=cut
1859		1946
…		…
1961	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1964	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1965		2052
1966	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1967	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1968	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1971	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1972	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1973	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1974	}	2068	}
1975		2069
1976	sub DESTROY {	2070	sub DESTROY {
1977	my ($self) = @_;	2071	my ($self) = @_;
1978		2072
…		…
1996	->new	2090	->new
1997	->interval (1)	2091	->interval (1)
1998	->cb (sub {	2092	->cb (sub {
1999	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001	});	2095	});
2002		2096
2003	=over 4	2097	=over 4
2004		2098
2005	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
2006		2100
…		…
2009		2103
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2105
2012	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
2013		2107
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
2019		2109
2020	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
2021		2112
2022	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
2023		2114
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
2027		2118
2028	=item $timer = $timer->start	2119	=item $timer = $timer->start
2029		2120
2030	Start the timer.	2121	Start the timer.
2031		2122
2032	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
2033		2124
2034	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
2035		2127
2036	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
2037		2129
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2131
2040	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
2041		2133
…		…
2049		2141
2050	$term->{socket} = ...	2142	$term->{socket} = ...
2051	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
2052	->new	2144	->new
2053	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
2054	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
2055	->start	2147	->start
2056	->cb (sub {	2148	->cb (sub {
2057	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
2058	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
2059	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
2077	Set the file descriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
2078		2170
2079	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
2080		2172
2081	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2174	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
2084		2176
2085	=item $iow = $iow->start	2177	=item $iow = $iow->start
2086		2178
2087	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
2088		2180
…		…
2129	->new	2221	->new
2130	->start ($pid)	2222	->start ($pid)
2131	->cb (sub {	2223	->cb (sub {
2132	my ($pw, $exit_status) = @_;	2224	my ($pw, $exit_status) = @_;
2133	...	2225	...
2134	});	2226	});
2135		2227
2136	=over 4	2228	=over 4
2137		2229
2138	=item $pw = new urxvt::pw	2230	=item $pw = new urxvt::pw
2139		2231
…		…
2172		2264
2173	=back	2265	=back
2174		2266
2175	=head1 AUTHOR	2267	=head1 AUTHOR
2176		2268
2177	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2179		2271
2180	=cut	2272	=cut
2181		2273
2182	1	2274	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs. Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC