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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.149 by root, Sun Dec 3 23:03:52 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 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 from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
261	Example configuration:	267	Example configuration:
262		268
263	URxvt.perl-ext: default,matcher	269	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser	270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
265	URxvt.matcher.button: 1	272	URxvt.matcher.button: 1
266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
268	URxvt.matcher.launcher.2: gvim +$2 $1	275	URxvt.matcher.launcher.2: gvim +$2 $1
269		276
270	=item xim-onthespot	277	=item xim-onthespot
271		278
272	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
273	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
274	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
275	kinput2.	282	kinput2.
276		283
277	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
278	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
279		286
…		…
287	will show or hide itself. Another press of the accelerator key will hide	294	will show or hide itself. Another press of the accelerator key will hide
288	or show it again.	295	or show it again.
289		296
290	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
291		298
292	This is useful if you need a single terminal thats not using any desktop	299	This is useful if you need a single terminal that is not using any desktop
293	space most of the time but is quickly available at the press of a key.	300	space most of the time but is quickly available at the press of a key.
294		301
295	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
296	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
297		304
298	If you want a quake-like animation, tell your window manager to do so	305	If you want a quake-like animation, tell your window manager to do so
299	(fvwm can do it).	306	(fvwm can do it).
300		307
301	=item automove-background	308	=item overlay-osc
302		309
303	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
304	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
305	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
306	supported in this mode. Example:
307
308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309		313
310	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
311		315
312	A not very useful example of filtering all text output to the terminal	316	A not very useful example of filtering all text output to the terminal
313	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
318	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
319		323
320	=item remote-clipboard	324	=item remote-clipboard
321		325
322	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
323	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
324	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
325		329
326	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
327	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
328	reads it.	332	reads it.
…		…
337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339		343
340	=item selection-pastebin	344	=item selection-pastebin
341		345
342	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
343	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
344	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
345	F</tmp> directly.).	349	F</tmp> directly.).
346		350
347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
366		370
367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368		372
369	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370	the double C</> characters as comment start. Use C<\057\057> instead,	374	the double C</> characters as comment start. Use C<\057\057> instead,
371	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of whether xrdb is used to parse the resource file
372	or not.	376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
373		391
374	=item example-refresh-hooks	392	=item example-refresh-hooks
375		393
376	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
377	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
378	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
379		402
380	=back	403	=back
381		404
382	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
383		406
…		…
399		422
400	=over 4	423	=over 4
401		424
402	=item $text	425	=item $text
403		426
404	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
405	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
406		429
407	=item $string	430	=item $string
408		431
409	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
418	=back	441	=back
419		442
420	=head2 Extension Objects	443	=head2 Extension Objects
421		444
422	Every perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
423	for each terminal, and each terminal has its own set of extenion objects,	446	for each terminal, and each terminal has its own set of extension objects,
424	which are passed as the first parameter to hooks. So extensions can use	447	which are passed as the first parameter to hooks. So extensions can use
425	their C<$self> object without having to think about clashes with other	448	their C<$self> object without having to think about clashes with other
426	extensions or other terminals, with the exception of methods and members	449	extensions or other terminals, with the exception of methods and members
427	that begin with an underscore character C<_>: these are reserved for	450	that begin with an underscore character C<_>: these are reserved for
428	internal use.	451	internal use.
…		…
543		566
544	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
545	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
546	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
547		570
548	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
549		572
550	Called on every OSC sequence and can be used to suppress it or modify its	573	Called on every OSC sequence and can be used to suppress it or modify its
551	behaviour. The default should be to return an empty list. A true value	574	behaviour. The default should be to return an empty list. A true value
552	suppresses execution of the request completely. Make sure you don't get	575	suppresses execution of the request completely. Make sure you don't get
553	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
554	this callback.	577	this callback.
555		578
556	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
557		580
558	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
559		582
560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
562	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
563	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
564	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
565	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
566		599
567	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
568	as its source can not easily be controlled (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
569	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
570		606
571	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
572		608
573	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
574	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
579	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
580		616
581	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
582	suppress or filter tty input.	618	suppress or filter tty input.
583		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
584	=item on_line_update $term, $row	627	=item on_line_update $term, $row
585		628
586	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
587	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
588	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
595	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
596	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
597		640
598	=item on_refresh_begin $term	641	=item on_refresh_begin $term
599		642
600	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
601	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
602	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
603	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
604		647
605	=item on_refresh_end $term	648	=item on_refresh_end $term
606		649
…		…
613	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
614		657
615	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
616	slightly in the future.	659	slightly in the future.
617		660
618	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
619		662
620	Called just after the new window size has been calculated, but before	663	Called just after the new window size has been calculated, but before
621	windows are actually being resized or hints are being set. If this hook	664	windows are actually being resized or hints are being set. If this hook
622	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
623		666
…		…
657		700
658	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
659		702
660	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
661		704
662	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
663	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
664		707
665	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
666	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
667	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
668		711
…		…
677		720
678	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
679		722
680	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
681	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
682		729
683	=back	730	=back
684		731
685	=cut	732	=cut
686		733
…		…
751		798
752	=over 4	799	=over 4
753		800
754	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
755		802
756	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
757	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
758	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
759		807
760	=item urxvt::warn $string	808	=item urxvt::warn $string
761		809
762	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
763	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
764	that calls this function.	812	that calls this function.
765		813
766	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
767	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
771	=item @terms = urxvt::termlist	819	=item @terms = urxvt::termlist
772		820
773	Returns all urxvt::term objects that exist in this process, regardless of	821	Returns all urxvt::term objects that exist in this process, regardless of
774	whether they are started, being destroyed etc., so be careful. Only term	822	whether they are started, being destroyed etc., so be careful. Only term
775	objects that have perl extensions attached will be returned (because there	823	objects that have perl extensions attached will be returned (because there
776	is no urxvt::term objet associated with others).	824	is no urxvt::term object associated with others).
777		825
778	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
779		827
780	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
781		829
…		…
824		872
825	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
826		874
827	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
828		876
829	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
830		879
831	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
832	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
833	the bitset.	882	the bitset.
834		883
…		…
917	local $TERM = shift;	966	local $TERM = shift;
918	my $htype = shift;	967	my $htype = shift;
919		968
920	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
922		971
923	my %ext_arg;	972	my %ext_arg;
924		973
925	{	974	{
926	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
927	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
990		1039
991	sub SET_COLOR($$$) {	1040	sub SET_COLOR($$$) {
992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993	}	1042	}
994		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask \|= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
		1067	}
		1068
995	# urxvt::term::extension	1069	# urxvt::term::extension
996		1070
997	package urxvt::term::extension;	1071	package urxvt::term::extension;
998		1072
999	sub enable {	1073	sub enable {
…		…
1068	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
1069	work.	1143	work.
1070		1144
1071	=cut	1145	=cut
1072		1146
1073	our $VERSION = 1;	1147	our $VERSION = '5.23';
1074		1148
1075	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077		1151
1078	sub timer {	1152	sub timer {
…		…
1080		1154
1081	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1082		1156
1083	urxvt::timer	1157	urxvt::timer
1084	->new	1158	->new
1085	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1086	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1087	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1088	$cb->();	1162	$cb->();
1089	})	1163	})
1090	}	1164	}
1091		1165
1092	sub io {	1166	sub io {
1093	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1094		1168
1095	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1096		1172
1097	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1098	->new	1174	->new
1099	->fd (fileno $arg{fh})	1175	->fd ($fd)
1100	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1101	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1102	->start	1178	->start
1103	->cb (sub {	1179	->cb ($cb)
1104	$cb->(($_[1] & 1 ? 'r' : '')
1105	. ($_[1] & 2 ? 'w' : ''));
1106	})],
1107	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
1108	}	1206	}
1109		1207
1110	sub DESTROY {	1208	sub DESTROY {
1111	$_[0][1]->stop;	1209	$_[0][1]->stop;
1112	}	1210	}
1113		1211
1114	sub condvar {	1212	sub one_event {
1115	bless \my $flag, urxvt::anyevent::condvar::
1116	}
1117
1118	sub urxvt::anyevent::condvar::broadcast {
1119	${$_[0]}++;
1120	}
1121
1122	sub urxvt::anyevent::condvar::wait {
1123	unless (${$_[0]}) {
1124	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1125	}
1126	}
1127
1128	sub urxvt::anyevent::one_event {
1129	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1130	}	1214	}
1131		1215
1132	package urxvt::term;	1216	package urxvt::term;
1133		1217
…		…
1252		1336
1253	Here is a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
1254	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
1255	to see the actual list:	1339	to see the actual list:
1256		1340
1257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1258	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1259	display_name embed ext_bwidth fade font geometry hold iconName	1343	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1260	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1345	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1261	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1346	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1262	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1347	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1263	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1348	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1264	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1349	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1265	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1350	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1351	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1267	secondaryScreen secondaryScroll selectstyle shade term_name title	1352	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1268	transient_for transparent transparent_all tripleclickwords utmpInhibit	1353	term_name title transient_for transparent tripleclickwords urgentOnBell
1269	visualBell	1354	utmpInhibit visualBell
1270		1355
1271	=cut	1356	=cut
1272		1357
1273	sub resource($$;$) {	1358	sub resource($$;$) {
1274	my ($self, $name) = (shift, shift);	1359	my ($self, $name) = (shift, shift);
1275	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1360	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1276	&urxvt::term::_resource	1361	goto &urxvt::term::_resource
1277	}	1362	}
1278		1363
1279	=item $value = $term->x_resource ($pattern)	1364	=item $value = $term->x_resource ($pattern)
1280		1365
1281	Returns the X-Resource for the given pattern, excluding the program or	1366	Returns the X-Resource for the given pattern, excluding the program or
…		…
1306		1391
1307	=item ($row, $col) = $term->selection_beg ([$row, $col])	1392	=item ($row, $col) = $term->selection_beg ([$row, $col])
1308		1393
1309	=item ($row, $col) = $term->selection_end ([$row, $col])	1394	=item ($row, $col) = $term->selection_end ([$row, $col])
1310		1395
1311	Return the current values of the selection mark, begin or end positions,	1396	Return the current values of the selection mark, begin or end positions.
1312	and optionally set them to new values.	1397
		1398	When arguments are given, then the selection coordinates are set to
		1399	C<$row> and C<$col>, and the selection screen is set to the current
		1400	screen.
		1401
		1402	=item $screen = $term->selection_screen ([$screen])
		1403
		1404	Returns the current selection screen, and then optionally sets it.
1313		1405
1314	=item $term->selection_make ($eventtime[, $rectangular])	1406	=item $term->selection_make ($eventtime[, $rectangular])
1315		1407
1316	Tries to make a selection as set by C<selection_beg> and	1408	Tries to make a selection as set by C<selection_beg> and
1317	C<selection_end>. If C<$rectangular> is true (default: false), a	1409	C<selection_end>. If C<$rectangular> is true (default: false), a
1318	rectangular selection will be made. This is the prefered function to make	1410	rectangular selection will be made. This is the preferred function to make
1319	a selection.	1411	a selection.
1320		1412
1321	=item $success = $term->selection_grab ($eventtime)	1413	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1322		1414
1323	Try to request the primary selection text from the server (for example, as	1415	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1416	true) selection from the server. The corresponding text can be set
1324	set by the next method). No visual feedback will be given. This function	1417	with the next method. No visual feedback will be given. This function
1325	is mostly useful from within C<on_sel_grab> hooks.	1418	is mostly useful from within C<on_sel_grab> hooks.
1326		1419
1327	=item $oldtext = $term->selection ([$newtext])	1420	=item $oldtext = $term->selection ([$newtext, $clipboard])
1328		1421
1329	Return the current selection text and optionally replace it by C<$newtext>.	1422	Return the current selection (clipboard if C<$clipboard> is true) text
		1423	and optionally replace it by C<$newtext>.
		1424
		1425	=item $term->selection_clear ([$clipboard])
		1426
		1427	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1330		1428
1331	=item $term->overlay_simple ($x, $y, $text)	1429	=item $term->overlay_simple ($x, $y, $text)
1332		1430
1333	Create a simple multi-line overlay box. See the next method for details.	1431	Create a simple multi-line overlay box. See the next method for details.
1334		1432
…		…
1364		1462
1365	The methods currently supported on C<urxvt::overlay> objects are:	1463	The methods currently supported on C<urxvt::overlay> objects are:
1366		1464
1367	=over 4	1465	=over 4
1368		1466
1369	=item $overlay->set ($x, $y, $text, $rend)	1467	=item $overlay->set ($x, $y, $text[, $rend])
1370		1468
1371	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1469	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1372	text in rxvt-unicode's special encoding and an array of rendition values	1470	text in rxvt-unicode's special encoding and an array of rendition values
1373	at a specific position inside the overlay.	1471	at a specific position inside the overlay.
		1472
		1473	If C<$rend> is missing, then the rendition will not be changed.
1374		1474
1375	=item $overlay->hide	1475	=item $overlay->hide
1376		1476
1377	If visible, hide the overlay, but do not destroy it.	1477	If visible, hide the overlay, but do not destroy it.
1378		1478
…		…
1460	locale-specific encoding of the terminal and can contain command sequences	1560	locale-specific encoding of the terminal and can contain command sequences
1461	(escape codes) that will be interpreted.	1561	(escape codes) that will be interpreted.
1462		1562
1463	=item $term->tt_write ($octets)	1563	=item $term->tt_write ($octets)
1464		1564
1465	Write the octets given in C<$data> to the tty (i.e. as program input). To	1565	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1466	pass characters instead of octets, you should convert your strings first	1566	pass characters instead of octets, you should convert your strings first
1467	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	to the locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_paste ($octets)
		1570
		1571	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1572	CR and bracketing the data with control sequences if bracketed paste mode
		1573	is set.
1468		1574
1469	=item $old_events = $term->pty_ev_events ([$new_events])	1575	=item $old_events = $term->pty_ev_events ([$new_events])
1470		1576
1471	Replaces the event mask of the pty watcher by the given event mask. Can	1577	Replaces the event mask of the pty watcher by the given event mask. Can
1472	be used to suppress input and output handling to the pty/tty. See the	1578	be used to suppress input and output handling to the pty/tty. See the
…		…
1588		1694
1589	Used after changing terminal contents to display them.	1695	Used after changing terminal contents to display them.
1590		1696
1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1697	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592		1698
1593	Returns the text of the entire row with number C<$row_number>. Row C<0>	1699	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1594	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1700	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1595	terminal line. The scrollback buffer starts at line C<-1> and extends to
1596	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1701	terminal line. Nothing will be returned if a nonexistent line
1597	is requested.	1702	is requested.
1598		1703
1599	If C<$new_text> is specified, it will replace characters in the current	1704	If C<$new_text> is specified, it will replace characters in the current
1600	line, starting at column C<$start_col> (default C<0>), which is useful	1705	line, starting at column C<$start_col> (default C<0>), which is useful
1601	to replace only parts of a line. The font index in the rendition will	1706	to replace only parts of a line. The font index in the rendition will
1602	automatically be updated.	1707	automatically be updated.
1603		1708
1604	C<$text> is in a special encoding: tabs and wide characters that use more	1709	C<$text> is in a special encoding: tabs and wide characters that use more
1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1710	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1606	characters. Characters with combining characters and other characters that	1711	characters. Characters with combining characters and other characters that
1607	do not fit into the normal tetx encoding will be replaced with characters	1712	do not fit into the normal text encoding will be replaced with characters
1608	in the private use area.	1713	in the private use area.
1609		1714
1610	You have to obey this encoding when changing text. The advantage is	1715	You have to obey this encoding when changing text. The advantage is
1611	that C<substr> and similar functions work on screen cells and not on	1716	that C<substr> and similar functions work on screen cells and not on
1612	characters.	1717	characters.
…		…
1787	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1892	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1788	recent grab.	1893	recent grab.
1789		1894
1790	=item $term->ungrab	1895	=item $term->ungrab
1791		1896
1792	Calls XUngrab for the most recent grab. Is called automatically on	1897	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1793	evaluation errors, as it is better to lose the grab in the error case as	1898	evaluation errors, as it is better to lose the grab in the error case as
1794	the session.	1899	the session.
1795		1900
1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1901	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1797		1902
…		…
1799		1904
1800	=item @atoms = $term->XListProperties ($window)	1905	=item @atoms = $term->XListProperties ($window)
1801		1906
1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1907	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1803		1908
1804	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1909	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1805		1910
1806	=item $term->XDeleteProperty ($window, $property)	1911	=item $term->XDeleteProperty ($window, $property)
1807		1912
1808	=item $window = $term->DefaultRootWindow	1913	=item $window = $term->DefaultRootWindow
1809		1914
…		…
1819		1924
1820	=item $term->XChangeInput ($window, $add_events[, $del_events])	1925	=item $term->XChangeInput ($window, $add_events[, $del_events])
1821		1926
1822	Various X or X-related functions. The C<$term> object only serves as	1927	Various X or X-related functions. The C<$term> object only serves as
1823	the source of the display, otherwise those functions map more-or-less	1928	the source of the display, otherwise those functions map more-or-less
1824	directory onto the X functions of the same name.	1929	directly onto the X functions of the same name.
1825		1930
1826	=back	1931	=back
1827		1932
1828	=cut	1933	=cut
1829		1934
…		…
1931	my $env = $self->{term}->env;	2036	my $env = $self->{term}->env;
1932	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2037	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1933	delete $env->{LC_ALL};	2038	delete $env->{LC_ALL};
1934	$env->{LC_CTYPE} = $self->{term}->locale;	2039	$env->{LC_CTYPE} = $self->{term}->locale;
1935		2040
1936	urxvt::term->new ($env, "popup",	2041	my $term = urxvt::term->new (
		2042	$env, "popup",
1937	"--perl-lib" => "", "--perl-ext-common" => "",	2043	"--perl-lib" => "", "--perl-ext-common" => "",
1938	"-pty-fd" => -1, "-sl" => 0,	2044	"-pty-fd" => -1, "-sl" => 0,
1939	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2045	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1940	"--transient-for" => $self->{term}->parent,	2046	"--transient-for" => $self->{term}->parent,
1941	"-display" => $self->{term}->display_id,	2047	"-display" => $self->{term}->display_id,
1942	"-pe" => "urxvt-popup")	2048	"-pe" => "urxvt-popup",
1943	or die "unable to create popup window\n";	2049	) or die "unable to create popup window\n";
		2050
		2051	unless (delete $term->{urxvt_popup_init_done}) {
		2052	$term->ungrab;
		2053	$term->destroy;
		2054	die "unable to initialise popup window\n";
		2055	}
1944	}	2056	}
1945		2057
1946	sub DESTROY {	2058	sub DESTROY {
1947	my ($self) = @_;	2059	my ($self) = @_;
1948		2060
…		…
1953	=back	2065	=back
1954		2066
1955	=cut	2067	=cut
1956		2068
1957	package urxvt::watcher;	2069	package urxvt::watcher;
1958
1959	@urxvt::timer::ISA = __PACKAGE__;
1960	@urxvt::iow::ISA = __PACKAGE__;
1961	@urxvt::pw::ISA = __PACKAGE__;
1962	@urxvt::iw::ISA = __PACKAGE__;
1963		2070
1964	=head2 The C<urxvt::timer> Class	2071	=head2 The C<urxvt::timer> Class
1965		2072
1966	This class implements timer watchers/events. Time is represented as a	2073	This class implements timer watchers/events. Time is represented as a
1967	fractional number of seconds since the epoch. Example:	2074	fractional number of seconds since the epoch. Example:
…		…
1971	->new	2078	->new
1972	->interval (1)	2079	->interval (1)
1973	->cb (sub {	2080	->cb (sub {
1974	$term->{overlay}->set (0, 0,	2081	$term->{overlay}->set (0, 0,
1975	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2082	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1976	});	2083	});
1977		2084
1978	=over 4	2085	=over 4
1979		2086
1980	=item $timer = new urxvt::timer	2087	=item $timer = new urxvt::timer
1981		2088
…		…
1984		2091
1985	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2092	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1986		2093
1987	Set the callback to be called when the timer triggers.	2094	Set the callback to be called when the timer triggers.
1988		2095
1989	=item $tstamp = $timer->at
1990
1991	Return the time this watcher will fire next.
1992
1993	=item $timer = $timer->set ($tstamp)	2096	=item $timer = $timer->set ($tstamp[, $interval])
1994		2097
1995	Set the time the event is generated to $tstamp.	2098	Set the time the event is generated to $tstamp (and optionally specifies a
		2099	new $interval).
1996		2100
1997	=item $timer = $timer->interval ($interval)	2101	=item $timer = $timer->interval ($interval)
1998		2102
1999	Normally (and when C<$interval> is C<0>), the timer will automatically	2103	By default (and when C<$interval> is C<0>), the timer will automatically
2000	stop after it has fired once. If C<$interval> is non-zero, then the timer	2104	stop after it has fired once. If C<$interval> is non-zero, then the timer
2001	is automatically rescheduled at the given intervals.	2105	is automatically rescheduled at the given intervals.
2002		2106
2003	=item $timer = $timer->start	2107	=item $timer = $timer->start
2004		2108
2005	Start the timer.	2109	Start the timer.
2006		2110
2007	=item $timer = $timer->start ($tstamp)	2111	=item $timer = $timer->start ($tstamp[, $interval])
2008		2112
2009	Set the event trigger time to C<$tstamp> and start the timer.	2113	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2114	also replaces the interval.
2010		2115
2011	=item $timer = $timer->after ($delay)	2116	=item $timer = $timer->after ($delay[, $interval])
2012		2117
2013	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2118	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2014		2119
2015	=item $timer = $timer->stop	2120	=item $timer = $timer->stop
2016		2121
…		…
2024		2129
2025	$term->{socket} = ...	2130	$term->{socket} = ...
2026	$term->{iow} = urxvt::iow	2131	$term->{iow} = urxvt::iow
2027	->new	2132	->new
2028	->fd (fileno $term->{socket})	2133	->fd (fileno $term->{socket})
2029	->events (urxvt::EVENT_READ)	2134	->events (urxvt::EV_READ)
2030	->start	2135	->start
2031	->cb (sub {	2136	->cb (sub {
2032	my ($iow, $revents) = @_;	2137	my ($iow, $revents) = @_;
2033	# $revents must be 1 here, no need to check	2138	# $revents must be 1 here, no need to check
2034	sysread $term->{socket}, my $buf, 8192	2139	sysread $term->{socket}, my $buf, 8192
…		…
2052	Set the file descriptor (not handle) to watch.	2157	Set the file descriptor (not handle) to watch.
2053		2158
2054	=item $iow = $iow->events ($eventmask)	2159	=item $iow = $iow->events ($eventmask)
2055		2160
2056	Set the event mask to watch. The only allowed values are	2161	Set the event mask to watch. The only allowed values are
2057	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2162	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2058	together, or C<urxvt::EVENT_NONE>.	2163	together, or C<urxvt::EV_NONE>.
2059		2164
2060	=item $iow = $iow->start	2165	=item $iow = $iow->start
2061		2166
2062	Start watching for requested events on the given handle.	2167	Start watching for requested events on the given handle.
2063		2168
…		…
2104	->new	2209	->new
2105	->start ($pid)	2210	->start ($pid)
2106	->cb (sub {	2211	->cb (sub {
2107	my ($pw, $exit_status) = @_;	2212	my ($pw, $exit_status) = @_;
2108	...	2213	...
2109	});	2214	});
2110		2215
2111	=over 4	2216	=over 4
2112		2217
2113	=item $pw = new urxvt::pw	2218	=item $pw = new urxvt::pw
2114		2219
…		…
2147		2252
2148	=back	2253	=back
2149		2254
2150	=head1 AUTHOR	2255	=head1 AUTHOR
2151		2256
2152	Marc Lehmann <pcg@goof.com>	2257	Marc Lehmann <schmorp@schmorp.de>
2153	http://software.schmorp.de/pkg/rxvt-unicode	2258	http://software.schmorp.de/pkg/rxvt-unicode
2154		2259
2155	=cut	2260	=cut
2156		2261
2157	1	2262	1
		2263
		2264	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.149 by root, Sun Dec 3 23:03:52 2006 UTC vs. Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.149 by root, Sun Dec 3 23:03:52 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC