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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.150 by root, Thu Dec 7 03:02:44 2006 UTC vs. Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.150 by root, Thu Dec 7 03:02:44 2006 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC