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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 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
…		…
240	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
241		244
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.	246	indices.
244		247
245	=item mark-urls	248	=item matcher
246		249
247	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
248	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
250	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
251		278
252	=item xim-onthespot	279	=item xim-onthespot
253		280
254	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
255	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
256	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
257	kinput2.	284	kinput2.
258		285
259	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
260	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
261		288
…		…
269	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
270	or show it again.	297	or show it again.
271		298
272	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
273		300
274	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
275	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.
276		303
277	The accelerator key is grabbed regardless of any modifiers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
279		306
280	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
281	(fvwm can do it).	308	(fvwm can do it).
282		309
283	=item automove-background	310	=item overlay-osc
284		311
285	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
286	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
287	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291		315
292	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
293		317
294	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
295	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
…		…
300	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
301		325
302	=item remote-clipboard	326	=item remote-clipboard
303		327
304	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
305	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
306	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
307		331
308	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
309	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
310	reads it.	334	reads it.
…		…
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321		345
322	=item selection-pastebin	346	=item selection-pastebin
323		347
324	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
325	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
326	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
327	F</tmp> directly.).	351	F</tmp> directly.).
328		352
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
348		372
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350		374
351	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
352	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,
353	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
354	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.
355		393
356	=item example-refresh-hooks	394	=item example-refresh-hooks
357		395
358	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
359	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
360	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.
361		404
362	=back	405	=back
363		406
364	=head1 API DOCUMENTATION	407	=head1 API DOCUMENTATION
365		408
…		…
381		424
382	=over 4	425	=over 4
383		426
384	=item $text	427	=item $text
385		428
386	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	Rxvt-unicode's special way of encoding text, where one "unicode" character
387	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.
388		431
389	=item $string	432	=item $string
390		433
391	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
…		…
400	=back	443	=back
401		444
402	=head2 Extension Objects	445	=head2 Extension Objects
403		446
404	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
405	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,
406	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
407	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
408	extensions or other terminals, with the exception of methods and members	451	extensions or other terminals, with the exception of methods and members
409	that begin with an underscore character C<_>: these are reserved for	452	that begin with an underscore character C<_>: these are reserved for
410	internal use.	453	internal use.
…		…
525		568
526	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,
527	$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
528	number of lines that will be in the scrollback buffer.	571	number of lines that will be in the scrollback buffer.
529		572
530	=item on_osc_seq $term, $op, $args	573	=item on_osc_seq $term, $op, $args, $resp
531		574
532	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
533	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
534	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
535	confused by recursive invocations when you output an osc sequence within	578	confused by recursive invocations when you output an OSC sequence within
536	this callback.	579	this callback.
537		580
538	C<on_osc_seq_perl> should be used for new behaviour.	581	C<on_osc_seq_perl> should be used for new behaviour.
539		582
540	=item on_osc_seq_perl $term, $string	583	=item on_osc_seq_perl $term, $args, $resp
541		584
542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
544	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
545	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,
546	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
547	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	}
548		601
549	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,
550	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
551	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.
552		608
553	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
554		610
555	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
556	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
…		…
561	=item on_tt_write $term, $octets	617	=item on_tt_write $term, $octets
562		618
563	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
564	suppress or filter tty input.	620	suppress or filter tty input.
565		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
566	=item on_line_update $term, $row	629	=item on_line_update $term, $row
567		630
568	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
569	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
570	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,
…		…
577	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
578	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
579		642
580	=item on_refresh_begin $term	643	=item on_refresh_begin $term
581		644
582	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
583	or similar effects by modify terminal contents in refresh_begin, and	646	similar effects by modifying the terminal contents in refresh_begin, and
584	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
585	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
586		649
587	=item on_refresh_end $term	650	=item on_refresh_end $term
588		651
…		…
595	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
596		659
597	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
598	slightly in the future.	661	slightly in the future.
599		662
600	=item on_resize_all_windows $tern, $new_width, $new_height	663	=item on_resize_all_windows $term, $new_width, $new_height
601		664
602	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
603	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
604	returns TRUE, setting of the window hints is being skipped.	667	returns TRUE, setting of the window hints is being skipped.
605		668
…		…
639		702
640	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
641		704
642	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
643		706
644	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
645	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.
646		709
647	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
648	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
649	(real, not screen-based) row and column under the mouse cursor.	712	(real, not screen-based) row and column under the mouse cursor.
650		713
…		…
659		722
660	=item on_wm_delete_window $term, $event	723	=item on_wm_delete_window $term, $event
661		724
662	Called when various types of ClientMessage events are received (all with	725	Called when various types of ClientMessage events are received (all with
663	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.
664		731
665	=back	732	=back
666		733
667	=cut	734	=cut
668		735
…		…
733		800
734	=over 4	801	=over 4
735		802
736	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
737		804
738	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
739	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
740	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
741		809
742	=item urxvt::warn $string	810	=item urxvt::warn $string
743		811
744	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
745	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
746	that calls this function.	814	that calls this function.
747		815
748	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
749	correct place, e.g. on stderr of the connecting urxvtc client.	817	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
753	=item @terms = urxvt::termlist	821	=item @terms = urxvt::termlist
754		822
755	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
756	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
757	objects that have perl extensions attached will be returned (because there	825	objects that have perl extensions attached will be returned (because there
758	is no urxvt::term objet associated with others).	826	is no urxvt::term object associated with others).
759		827
760	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
761		829
762	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
763		831
…		…
806		874
807	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
808		876
809	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
810		878
811	=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
812		881
813	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
814	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
815	the bitset.	884	the bitset.
816		885
…		…
899	local $TERM = shift;	968	local $TERM = shift;
900	my $htype = shift;	969	my $htype = shift;
901		970
902	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
904		973
905	my %ext_arg;	974	my %ext_arg;
906		975
907	{	976	{
908	my @init = @TERM_INIT;	977	my @init = @TERM_INIT;
909	@TERM_INIT = ();	978	@TERM_INIT = ();
…		…
972		1041
973	sub SET_COLOR($$$) {	1042	sub SET_COLOR($$$) {
974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1043	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975	}	1044	}
976		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
977	# urxvt::term::extension	1071	# urxvt::term::extension
978		1072
979	package urxvt::term::extension;	1073	package urxvt::term::extension;
980		1074
981	sub enable {	1075	sub enable {
…		…
1050	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
1051	work.	1145	work.
1052		1146
1053	=cut	1147	=cut
1054		1148
1055	our $VERSION = 1;	1149	our $VERSION = '5.23';
1056		1150
1057	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059		1153
1060	sub timer {	1154	sub timer {
…		…
1062		1156
1063	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
1064		1158
1065	urxvt::timer	1159	urxvt::timer
1066	->new	1160	->new
1067	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
1068	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
1069	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
1070	$cb->();	1164	$cb->();
1071	})	1165	})
1072	}	1166	}
1073		1167
1074	sub io {	1168	sub io {
1075	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
1076		1170
1077	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
1078		1174
1079	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
1080	->new	1176	->new
1081	->fd (fileno $arg{fh})	1177	->fd ($fd)
1082	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
1083	\| ($arg{poll} =~ /w/ ? 2 : 0))	1179	\| ($arg{poll} =~ /w/ ? 2 : 0))
1084	->start	1180	->start
1085	->cb (sub {	1181	->cb ($cb)
1086	$cb->(($_[1] & 1 ? 'r' : '')
1087	. ($_[1] & 2 ? 'w' : ''));
1088	})],
1089	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	})
1090	}	1208	}
1091		1209
1092	sub DESTROY {	1210	sub DESTROY {
1093	$_[0][1]->stop;	1211	$_[0][1]->stop;
1094	}	1212	}
1095		1213
1096	sub condvar {	1214	# only needed for AnyEvent < 6 compatibility
1097	bless \my $flag, urxvt::anyevent::condvar::	1215	sub one_event {
1098	}
1099
1100	sub urxvt::anyevent::condvar::broadcast {
1101	${$_[0]}++;
1102	}
1103
1104	sub urxvt::anyevent::condvar::wait {
1105	unless (${$_[0]}) {
1106	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1216	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107	}
1108	}	1217	}
1109		1218
1110	package urxvt::term;	1219	package urxvt::term;
1111		1220
1112	=head2 The C<urxvt::term> Class	1221	=head2 The C<urxvt::term> Class
…		…
1202	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1311	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1203		1312
1204	Here is a likely non-exhaustive list of option names, please see the	1313	Here is a likely non-exhaustive list of option names, please see the
1205	source file F</src/optinc.h> to see the actual list:	1314	source file F</src/optinc.h> to see the actual list:
1206		1315
1207	borderLess console cursorBlink cursorUnderline hold iconic insecure	1316	borderLess buffered console cursorBlink cursorUnderline hold iconic
1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1317	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1318	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1319	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1320	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1212	transparent tripleclickwords utmpInhibit visualBell	1321	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1322	urgentOnBell utmpInhibit visualBell
1213		1323
1214	=item $value = $term->resource ($name[, $newval])	1324	=item $value = $term->resource ($name[, $newval])
1215		1325
1216	Returns the current resource value associated with a given name and	1326	Returns the current resource value associated with a given name and
1217	optionally sets a new value. Setting values is most useful in the C<init>	1327	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1230		1340
1231	Here is a likely non-exhaustive list of resource names, not all of which	1341	Here is a likely non-exhaustive list of resource names, not all of which
1232	are supported in every build, please see the source file F</src/rsinc.h>	1342	are supported in every build, please see the source file F</src/rsinc.h>
1233	to see the actual list:	1343	to see the actual list:
1234		1344
1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1345	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1236	borderLess color cursorBlink cursorUnderline cutchars delete_key	1346	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1237	display_name embed ext_bwidth fade font geometry hold iconName	1347	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1348	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1349	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1350	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1351	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1352	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1353	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1354	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1355	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245	secondaryScreen secondaryScroll selectstyle shade term_name title	1356	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1246	transient_for transparent transparent_all tripleclickwords utmpInhibit	1357	term_name title transient_for transparent tripleclickwords urgentOnBell
1247	visualBell	1358	utmpInhibit visualBell
1248		1359
1249	=cut	1360	=cut
1250		1361
1251	sub resource($$;$) {	1362	sub resource($$;$) {
1252	my ($self, $name) = (shift, shift);	1363	my ($self, $name) = (shift, shift);
1253	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1364	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1254	&urxvt::term::_resource	1365	goto &urxvt::term::_resource
1255	}	1366	}
1256		1367
1257	=item $value = $term->x_resource ($pattern)	1368	=item $value = $term->x_resource ($pattern)
1258		1369
1259	Returns the X-Resource for the given pattern, excluding the program or	1370	Returns the X-Resource for the given pattern, excluding the program or
…		…
1284		1395
1285	=item ($row, $col) = $term->selection_beg ([$row, $col])	1396	=item ($row, $col) = $term->selection_beg ([$row, $col])
1286		1397
1287	=item ($row, $col) = $term->selection_end ([$row, $col])	1398	=item ($row, $col) = $term->selection_end ([$row, $col])
1288		1399
1289	Return the current values of the selection mark, begin or end positions,	1400	Return the current values of the selection mark, begin or end positions.
1290	and optionally set them to new values.	1401
		1402	When arguments are given, then the selection coordinates are set to
		1403	C<$row> and C<$col>, and the selection screen is set to the current
		1404	screen.
		1405
		1406	=item $screen = $term->selection_screen ([$screen])
		1407
		1408	Returns the current selection screen, and then optionally sets it.
1291		1409
1292	=item $term->selection_make ($eventtime[, $rectangular])	1410	=item $term->selection_make ($eventtime[, $rectangular])
1293		1411
1294	Tries to make a selection as set by C<selection_beg> and	1412	Tries to make a selection as set by C<selection_beg> and
1295	C<selection_end>. If C<$rectangular> is true (default: false), a	1413	C<selection_end>. If C<$rectangular> is true (default: false), a
1296	rectangular selection will be made. This is the prefered function to make	1414	rectangular selection will be made. This is the preferred function to make
1297	a selection.	1415	a selection.
1298		1416
1299	=item $success = $term->selection_grab ($eventtime)	1417	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300		1418
1301	Try to request the primary selection text from the server (for example, as	1419	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1420	true) selection from the server. The corresponding text can be set
1302	set by the next method). No visual feedback will be given. This function	1421	with the next method. No visual feedback will be given. This function
1303	is mostly useful from within C<on_sel_grab> hooks.	1422	is mostly useful from within C<on_sel_grab> hooks.
1304		1423
1305	=item $oldtext = $term->selection ([$newtext])	1424	=item $oldtext = $term->selection ([$newtext, $clipboard])
1306		1425
1307	Return the current selection text and optionally replace it by C<$newtext>.	1426	Return the current selection (clipboard if C<$clipboard> is true) text
		1427	and optionally replace it by C<$newtext>.
		1428
		1429	=item $term->selection_clear ([$clipboard])
		1430
		1431	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1308		1432
1309	=item $term->overlay_simple ($x, $y, $text)	1433	=item $term->overlay_simple ($x, $y, $text)
1310		1434
1311	Create a simple multi-line overlay box. See the next method for details.	1435	Create a simple multi-line overlay box. See the next method for details.
1312		1436
…		…
1342		1466
1343	The methods currently supported on C<urxvt::overlay> objects are:	1467	The methods currently supported on C<urxvt::overlay> objects are:
1344		1468
1345	=over 4	1469	=over 4
1346		1470
1347	=item $overlay->set ($x, $y, $text, $rend)	1471	=item $overlay->set ($x, $y, $text[, $rend])
1348		1472
1349	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1473	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1350	text in rxvt-unicode's special encoding and an array of rendition values	1474	text in rxvt-unicode's special encoding and an array of rendition values
1351	at a specific position inside the overlay.	1475	at a specific position inside the overlay.
		1476
		1477	If C<$rend> is missing, then the rendition will not be changed.
1352		1478
1353	=item $overlay->hide	1479	=item $overlay->hide
1354		1480
1355	If visible, hide the overlay, but do not destroy it.	1481	If visible, hide the overlay, but do not destroy it.
1356		1482
…		…
1438	locale-specific encoding of the terminal and can contain command sequences	1564	locale-specific encoding of the terminal and can contain command sequences
1439	(escape codes) that will be interpreted.	1565	(escape codes) that will be interpreted.
1440		1566
1441	=item $term->tt_write ($octets)	1567	=item $term->tt_write ($octets)
1442		1568
1443	Write the octets given in C<$data> to the tty (i.e. as program input). To	1569	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1444	pass characters instead of octets, you should convert your strings first	1570	pass characters instead of octets, you should convert your strings first
1445	to the locale-specific encoding using C<< $term->locale_encode >>.	1571	to the locale-specific encoding using C<< $term->locale_encode >>.
		1572
		1573	=item $term->tt_paste ($octets)
		1574
		1575	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1576	CR and bracketing the data with control sequences if bracketed paste mode
		1577	is set.
1446		1578
1447	=item $old_events = $term->pty_ev_events ([$new_events])	1579	=item $old_events = $term->pty_ev_events ([$new_events])
1448		1580
1449	Replaces the event mask of the pty watcher by the given event mask. Can	1581	Replaces the event mask of the pty watcher by the given event mask. Can
1450	be used to suppress input and output handling to the pty/tty. See the	1582	be used to suppress input and output handling to the pty/tty. See the
…		…
1566		1698
1567	Used after changing terminal contents to display them.	1699	Used after changing terminal contents to display them.
1568		1700
1569	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1701	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570		1702
1571	Returns the text of the entire row with number C<$row_number>. Row C<0>	1703	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1572	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1704	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1573	terminal line. The scrollback buffer starts at line C<-1> and extends to
1574	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1705	terminal line. Nothing will be returned if a nonexistent line
1575	is requested.	1706	is requested.
1576		1707
1577	If C<$new_text> is specified, it will replace characters in the current	1708	If C<$new_text> is specified, it will replace characters in the current
1578	line, starting at column C<$start_col> (default C<0>), which is useful	1709	line, starting at column C<$start_col> (default C<0>), which is useful
1579	to replace only parts of a line. The font index in the rendition will	1710	to replace only parts of a line. The font index in the rendition will
1580	automatically be updated.	1711	automatically be updated.
1581		1712
1582	C<$text> is in a special encoding: tabs and wide characters that use more	1713	C<$text> is in a special encoding: tabs and wide characters that use more
1583	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1714	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1584	characters. Characters with combining characters and other characters that	1715	characters. Characters with combining characters and other characters that
1585	do not fit into the normal tetx encoding will be replaced with characters	1716	do not fit into the normal text encoding will be replaced with characters
1586	in the private use area.	1717	in the private use area.
1587		1718
1588	You have to obey this encoding when changing text. The advantage is	1719	You have to obey this encoding when changing text. The advantage is
1589	that C<substr> and similar functions work on screen cells and not on	1720	that C<substr> and similar functions work on screen cells and not on
1590	characters.	1721	characters.
…		…
1765	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1896	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766	recent grab.	1897	recent grab.
1767		1898
1768	=item $term->ungrab	1899	=item $term->ungrab
1769		1900
1770	Calls XUngrab for the most recent grab. Is called automatically on	1901	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1771	evaluation errors, as it is better to lose the grab in the error case as	1902	evaluation errors, as it is better to lose the grab in the error case as
1772	the session.	1903	the session.
1773		1904
1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1905	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775		1906
…		…
1777		1908
1778	=item @atoms = $term->XListProperties ($window)	1909	=item @atoms = $term->XListProperties ($window)
1779		1910
1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1911	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781		1912
1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1913	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783		1914
1784	=item $term->XDeleteProperty ($window, $property)	1915	=item $term->XDeleteProperty ($window, $property)
1785		1916
1786	=item $window = $term->DefaultRootWindow	1917	=item $window = $term->DefaultRootWindow
1787		1918
…		…
1797		1928
1798	=item $term->XChangeInput ($window, $add_events[, $del_events])	1929	=item $term->XChangeInput ($window, $add_events[, $del_events])
1799		1930
1800	Various X or X-related functions. The C<$term> object only serves as	1931	Various X or X-related functions. The C<$term> object only serves as
1801	the source of the display, otherwise those functions map more-or-less	1932	the source of the display, otherwise those functions map more-or-less
1802	directory onto the X functions of the same name.	1933	directly onto the X functions of the same name.
1803		1934
1804	=back	1935	=back
1805		1936
1806	=cut	1937	=cut
1807		1938
…		…
1909	my $env = $self->{term}->env;	2040	my $env = $self->{term}->env;
1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2041	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1911	delete $env->{LC_ALL};	2042	delete $env->{LC_ALL};
1912	$env->{LC_CTYPE} = $self->{term}->locale;	2043	$env->{LC_CTYPE} = $self->{term}->locale;
1913		2044
1914	urxvt::term->new ($env, "popup",	2045	my $term = urxvt::term->new (
		2046	$env, "popup",
1915	"--perl-lib" => "", "--perl-ext-common" => "",	2047	"--perl-lib" => "", "--perl-ext-common" => "",
1916	"-pty-fd" => -1, "-sl" => 0,	2048	"-pty-fd" => -1, "-sl" => 0,
1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2049	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918	"--transient-for" => $self->{term}->parent,	2050	"--transient-for" => $self->{term}->parent,
1919	"-display" => $self->{term}->display_id,	2051	"-display" => $self->{term}->display_id,
1920	"-pe" => "urxvt-popup")	2052	"-pe" => "urxvt-popup",
1921	or die "unable to create popup window\n";	2053	) or die "unable to create popup window\n";
		2054
		2055	unless (delete $term->{urxvt_popup_init_done}) {
		2056	$term->ungrab;
		2057	$term->destroy;
		2058	die "unable to initialise popup window\n";
		2059	}
1922	}	2060	}
1923		2061
1924	sub DESTROY {	2062	sub DESTROY {
1925	my ($self) = @_;	2063	my ($self) = @_;
1926		2064
…		…
1931	=back	2069	=back
1932		2070
1933	=cut	2071	=cut
1934		2072
1935	package urxvt::watcher;	2073	package urxvt::watcher;
1936
1937	@urxvt::timer::ISA = __PACKAGE__;
1938	@urxvt::iow::ISA = __PACKAGE__;
1939	@urxvt::pw::ISA = __PACKAGE__;
1940	@urxvt::iw::ISA = __PACKAGE__;
1941		2074
1942	=head2 The C<urxvt::timer> Class	2075	=head2 The C<urxvt::timer> Class
1943		2076
1944	This class implements timer watchers/events. Time is represented as a	2077	This class implements timer watchers/events. Time is represented as a
1945	fractional number of seconds since the epoch. Example:	2078	fractional number of seconds since the epoch. Example:
…		…
1949	->new	2082	->new
1950	->interval (1)	2083	->interval (1)
1951	->cb (sub {	2084	->cb (sub {
1952	$term->{overlay}->set (0, 0,	2085	$term->{overlay}->set (0, 0,
1953	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2086	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954	});	2087	});
1955		2088
1956	=over 4	2089	=over 4
1957		2090
1958	=item $timer = new urxvt::timer	2091	=item $timer = new urxvt::timer
1959		2092
…		…
1962		2095
1963	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2096	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964		2097
1965	Set the callback to be called when the timer triggers.	2098	Set the callback to be called when the timer triggers.
1966		2099
1967	=item $tstamp = $timer->at
1968
1969	Return the time this watcher will fire next.
1970
1971	=item $timer = $timer->set ($tstamp)	2100	=item $timer = $timer->set ($tstamp[, $interval])
1972		2101
1973	Set the time the event is generated to $tstamp.	2102	Set the time the event is generated to $tstamp (and optionally specifies a
		2103	new $interval).
1974		2104
1975	=item $timer = $timer->interval ($interval)	2105	=item $timer = $timer->interval ($interval)
1976		2106
1977	Normally (and when C<$interval> is C<0>), the timer will automatically	2107	By default (and when C<$interval> is C<0>), the timer will automatically
1978	stop after it has fired once. If C<$interval> is non-zero, then the timer	2108	stop after it has fired once. If C<$interval> is non-zero, then the timer
1979	is automatically rescheduled at the given intervals.	2109	is automatically rescheduled at the given intervals.
1980		2110
1981	=item $timer = $timer->start	2111	=item $timer = $timer->start
1982		2112
1983	Start the timer.	2113	Start the timer.
1984		2114
1985	=item $timer = $timer->start ($tstamp)	2115	=item $timer = $timer->start ($tstamp[, $interval])
1986		2116
1987	Set the event trigger time to C<$tstamp> and start the timer.	2117	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2118	also replaces the interval.
1988		2119
1989	=item $timer = $timer->after ($delay)	2120	=item $timer = $timer->after ($delay[, $interval])
1990		2121
1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2122	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1992		2123
1993	=item $timer = $timer->stop	2124	=item $timer = $timer->stop
1994		2125
…		…
2002		2133
2003	$term->{socket} = ...	2134	$term->{socket} = ...
2004	$term->{iow} = urxvt::iow	2135	$term->{iow} = urxvt::iow
2005	->new	2136	->new
2006	->fd (fileno $term->{socket})	2137	->fd (fileno $term->{socket})
2007	->events (urxvt::EVENT_READ)	2138	->events (urxvt::EV_READ)
2008	->start	2139	->start
2009	->cb (sub {	2140	->cb (sub {
2010	my ($iow, $revents) = @_;	2141	my ($iow, $revents) = @_;
2011	# $revents must be 1 here, no need to check	2142	# $revents must be 1 here, no need to check
2012	sysread $term->{socket}, my $buf, 8192	2143	sysread $term->{socket}, my $buf, 8192
…		…
2030	Set the file descriptor (not handle) to watch.	2161	Set the file descriptor (not handle) to watch.
2031		2162
2032	=item $iow = $iow->events ($eventmask)	2163	=item $iow = $iow->events ($eventmask)
2033		2164
2034	Set the event mask to watch. The only allowed values are	2165	Set the event mask to watch. The only allowed values are
2035	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2166	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2036	together, or C<urxvt::EVENT_NONE>.	2167	together, or C<urxvt::EV_NONE>.
2037		2168
2038	=item $iow = $iow->start	2169	=item $iow = $iow->start
2039		2170
2040	Start watching for requested events on the given handle.	2171	Start watching for requested events on the given handle.
2041		2172
…		…
2082	->new	2213	->new
2083	->start ($pid)	2214	->start ($pid)
2084	->cb (sub {	2215	->cb (sub {
2085	my ($pw, $exit_status) = @_;	2216	my ($pw, $exit_status) = @_;
2086	...	2217	...
2087	});	2218	});
2088		2219
2089	=over 4	2220	=over 4
2090		2221
2091	=item $pw = new urxvt::pw	2222	=item $pw = new urxvt::pw
2092		2223
…		…
2125		2256
2126	=back	2257	=back
2127		2258
2128	=head1 AUTHOR	2259	=head1 AUTHOR
2129		2260
2130	Marc Lehmann <pcg@goof.com>	2261	Marc Lehmann <schmorp@schmorp.de>
2131	http://software.schmorp.de/pkg/rxvt-unicode	2262	http://software.schmorp.de/pkg/rxvt-unicode
2132		2263
2133	=cut	2264	=cut
2134		2265
2135	1	2266	1
		2267
		2268	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs. Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC