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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.195 by sf-exg, Wed Jun 29 22:18:11 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 from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
251		276
252	=item xim-onthespot	277	=item xim-onthespot
253		278
254	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
257	kinput2.	282	kinput2.
258		283
259	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
261		286
…		…
269	will show or hide itself. Another press of the accelerator key will hide	294	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.	295	or show it again.
271		296
272	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
273		298
274	This is useful if you need a single terminal thats not using any desktop	299	This is useful if you need a single terminal that is not using any desktop
275	space most of the time but is quickly available at the press of a key.	300	space most of the time but is quickly available at the press of a key.
276		301
277	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
279		304
280	If you want a quake-like animation, tell your window manager to do so	305	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).	306	(fvwm can do it).
282		307
283	=item automove-background	308	=item overlay-osc
284		309
285	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
286	background pixmap offset to the window position, in effect creating the	311	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	312	the sources for more info.
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291		313
292	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
293		315
294	A not very useful example of filtering all text output to the terminal	316	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
300	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
301		323
302	=item remote-clipboard	324	=item remote-clipboard
303		325
304	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
306	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
307		329
308	We use it to implement a "distributed selection mechanism", which just	330	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	331	means that one command uploads the file to a remote server, and another
310	reads it.	332	reads it.
…		…
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321		343
322	=item selection-pastebin	344	=item selection-pastebin
323		345
324	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).	349	F</tmp> directly.).
328		350
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder	368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):	369	for the filename):
348		370
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
		391
351	=item example-refresh-hooks	392	=item example-refresh-hooks
352		393
353	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
354	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
355	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
356		402
357	=back	403	=back
358		404
359	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
360		406
…		…
376		422
377	=over 4	423	=over 4
378		424
379	=item $text	425	=item $text
380		426
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
383		429
384	=item $string	430	=item $string
385		431
386	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
395	=back	441	=back
396		442
397	=head2 Extension Objects	443	=head2 Extension Objects
398		444
399	Every perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
400	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extension objects,
401	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
402	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
403	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
404	use.	451	internal use.
405		452
406	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
407	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
408		455
409	It has the following methods and data members:	456	It has the following methods and data members:
…		…
519		566
520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
522	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
523		570
524	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
525		572
526	Called on every OSC sequence and can be used to suppress it or modify its	573	Called on every OSC sequence and can be used to suppress it or modify its
527	behaviour. The default should be to return an empty list. A true value	574	behaviour. The default should be to return an empty list. A true value
528	suppresses execution of the request completely. Make sure you don't get	575	suppresses execution of the request completely. Make sure you don't get
529	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
530	this callback.	577	this callback.
531		578
532	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
533		580
534	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
535		582
536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
538	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
539	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
540	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
541	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
542		599
543	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
544	as its source can not easily be controlled (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
545	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
546		606
547	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
548		608
549	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
550	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
555	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
556		616
557	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
558	suppress or filter tty input.	618	suppress or filter tty input.
559		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
560	=item on_line_update $term, $row	627	=item on_line_update $term, $row
561		628
562	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
563	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
564	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
571	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
572	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
573		640
574	=item on_refresh_begin $term	641	=item on_refresh_begin $term
575		642
576	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
577	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
578	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
579	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
580		647
581	=item on_refresh_end $term	648	=item on_refresh_end $term
582		649
…		…
589	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
590		657
591	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
592	slightly in the future.	659	slightly in the future.
593		660
594	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
595		662
596	Called just after the new window size has been calculated, but before	663	Called just after the new window size has been calculated, but before
597	windows are actually being resized or hints are being set. If this hook	664	windows are actually being resized or hints are being set. If this hook
598	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
599		666
…		…
633		700
634	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
635		702
636	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
637		704
638	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
639	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
640		707
641	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
642	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
643	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
644		711
…		…
653		720
654	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
655		722
656	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
658		729
659	=back	730	=back
660		731
661	=cut	732	=cut
662		733
…		…
727		798
728	=over 4	799	=over 4
729		800
730	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
731		802
732	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
733	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
734	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
735		807
736	=item urxvt::warn $string	808	=item urxvt::warn $string
737		809
738	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
739	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
740	that calls this function.	812	that calls this function.
741		813
742	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
743	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
747	=item @terms = urxvt::termlist	819	=item @terms = urxvt::termlist
748		820
749	Returns all urxvt::term objects that exist in this process, regardless of	821	Returns all urxvt::term objects that exist in this process, regardless of
750	whether they are started, being destroyed etc., so be careful. Only term	822	whether they are started, being destroyed etc., so be careful. Only term
751	objects that have perl extensions attached will be returned (because there	823	objects that have perl extensions attached will be returned (because there
752	is no urxvt::term objet associated with others).	824	is no urxvt::term object associated with others).
753		825
754	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
755		827
756	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
757		829
…		…
800		872
801	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
802		874
803	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
804		876
805	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
806		879
807	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
808	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
809	the bitset.	882	the bitset.
810		883
…		…
893	local $TERM = shift;	966	local $TERM = shift;
894	my $htype = shift;	967	my $htype = shift;
895		968
896	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
898		971
899	my %ext_arg;	972	my %ext_arg;
900		973
901	{	974	{
902	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
903	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
966		1039
967	sub SET_COLOR($$$) {	1040	sub SET_COLOR($$$) {
968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969	}	1042	}
970		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask \|= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
		1067	}
		1068
971	# urxvt::term::extension	1069	# urxvt::term::extension
972		1070
973	package urxvt::term::extension;	1071	package urxvt::term::extension;
974		1072
975	sub enable {	1073	sub enable {
…		…
1044	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
1045	work.	1143	work.
1046		1144
1047	=cut	1145	=cut
1048		1146
1049	our $VERSION = 1;	1147	our $VERSION = '5.23';
1050		1148
1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053		1151
1054	sub timer {	1152	sub timer {
…		…
1056		1154
1057	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1058		1156
1059	urxvt::timer	1157	urxvt::timer
1060	->new	1158	->new
1061	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1062	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1063	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1064	$cb->();	1162	$cb->();
1065	})	1163	})
1066	}	1164	}
1067		1165
1068	sub io {	1166	sub io {
1069	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1070		1168
1071	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1072		1172
1073	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1074	->new	1174	->new
1075	->fd (fileno $arg{fh})	1175	->fd ($fd)
1076	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1077	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1078	->start	1178	->start
1079	->cb (sub {	1179	->cb ($cb)
1080	$cb->(($_[1] & 1 ? 'r' : '')
1081	. ($_[1] & 2 ? 'w' : ''));
1082	})],
1083	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
1084	}	1206	}
1085		1207
1086	sub DESTROY {	1208	sub DESTROY {
1087	$_[0][1]->stop;	1209	$_[0][1]->stop;
1088	}	1210	}
1089		1211
1090	sub condvar {	1212	sub one_event {
1091	bless \my $flag, urxvt::anyevent::condvar::
1092	}
1093
1094	sub urxvt::anyevent::condvar::broadcast {
1095	${$_[0]}++;
1096	}
1097
1098	sub urxvt::anyevent::condvar::wait {
1099	unless (${$_[0]}) {
1100	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1101	}
1102	}	1214	}
1103		1215
1104	package urxvt::term;	1216	package urxvt::term;
1105		1217
1106	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1197		1309
1198	Here is a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
1199	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
1200		1312
1201	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess buffered console cursorBlink cursorUnderline hold iconic
1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	mapAlert meta8 mouseWheelScrollPage override-redirect pastableTabs
1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1316	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1317	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206	transparent tripleclickwords utmpInhibit visualBell	1318	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1319	urgentOnBell utmpInhibit visualBell
1207		1320
1208	=item $value = $term->resource ($name[, $newval])	1321	=item $value = $term->resource ($name[, $newval])
1209		1322
1210	Returns the current resource value associated with a given name and	1323	Returns the current resource value associated with a given name and
1211	optionally sets a new value. Setting values is most useful in the C<init>	1324	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1224		1337
1225	Here is a likely non-exhaustive list of resource names, not all of which	1338	Here is a likely non-exhaustive list of resource names, not all of which
1226	are supported in every build, please see the source file F</src/rsinc.h>	1339	are supported in every build, please see the source file F</src/rsinc.h>
1227	to see the actual list:	1340	to see the actual list:
1228		1341
1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1342	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1230	borderLess color cursorBlink cursorUnderline cutchars delete_key	1343	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231	display_name embed ext_bwidth fade font geometry hold iconName	1344	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1345	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1346	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1347	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1348	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1349	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1350	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1351	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1352	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239	secondaryScreen secondaryScroll selectstyle shade term_name title	1353	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240	transient_for transparent transparent_all tripleclickwords utmpInhibit	1354	term_name title transient_for transparent tripleclickwords urgentOnBell
1241	visualBell	1355	utmpInhibit visualBell
1242		1356
1243	=cut	1357	=cut
1244		1358
1245	sub resource($$;$) {	1359	sub resource($$;$) {
1246	my ($self, $name) = (shift, shift);	1360	my ($self, $name) = (shift, shift);
1247	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1361	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1248	&urxvt::term::_resource	1362	goto &urxvt::term::_resource
1249	}	1363	}
1250		1364
1251	=item $value = $term->x_resource ($pattern)	1365	=item $value = $term->x_resource ($pattern)
1252		1366
1253	Returns the X-Resource for the given pattern, excluding the program or	1367	Returns the X-Resource for the given pattern, excluding the program or
…		…
1278		1392
1279	=item ($row, $col) = $term->selection_beg ([$row, $col])	1393	=item ($row, $col) = $term->selection_beg ([$row, $col])
1280		1394
1281	=item ($row, $col) = $term->selection_end ([$row, $col])	1395	=item ($row, $col) = $term->selection_end ([$row, $col])
1282		1396
1283	Return the current values of the selection mark, begin or end positions,	1397	Return the current values of the selection mark, begin or end positions.
1284	and optionally set them to new values.	1398
		1399	When arguments are given, then the selection coordinates are set to
		1400	C<$row> and C<$col>, and the selection screen is set to the current
		1401	screen.
		1402
		1403	=item $screen = $term->selection_screen ([$screen])
		1404
		1405	Returns the current selection screen, and then optionally sets it.
1285		1406
1286	=item $term->selection_make ($eventtime[, $rectangular])	1407	=item $term->selection_make ($eventtime[, $rectangular])
1287		1408
1288	Tries to make a selection as set by C<selection_beg> and	1409	Tries to make a selection as set by C<selection_beg> and
1289	C<selection_end>. If C<$rectangular> is true (default: false), a	1410	C<selection_end>. If C<$rectangular> is true (default: false), a
1290	rectangular selection will be made. This is the prefered function to make	1411	rectangular selection will be made. This is the preferred function to make
1291	a selection.	1412	a selection.
1292		1413
1293	=item $success = $term->selection_grab ($eventtime)	1414	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294		1415
1295	Try to request the primary selection text from the server (for example, as	1416	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1417	true) selection from the server. The corresponding text can be set
1296	set by the next method). No visual feedback will be given. This function	1418	with the next method. No visual feedback will be given. This function
1297	is mostly useful from within C<on_sel_grab> hooks.	1419	is mostly useful from within C<on_sel_grab> hooks.
1298		1420
1299	=item $oldtext = $term->selection ([$newtext])	1421	=item $oldtext = $term->selection ([$newtext, $clipboard])
1300		1422
1301	Return the current selection text and optionally replace it by C<$newtext>.	1423	Return the current selection (clipboard if C<$clipboard> is true) text
		1424	and optionally replace it by C<$newtext>.
		1425
		1426	=item $term->selection_clear ([$clipboard])
		1427
		1428	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1302		1429
1303	=item $term->overlay_simple ($x, $y, $text)	1430	=item $term->overlay_simple ($x, $y, $text)
1304		1431
1305	Create a simple multi-line overlay box. See the next method for details.	1432	Create a simple multi-line overlay box. See the next method for details.
1306		1433
…		…
1336		1463
1337	The methods currently supported on C<urxvt::overlay> objects are:	1464	The methods currently supported on C<urxvt::overlay> objects are:
1338		1465
1339	=over 4	1466	=over 4
1340		1467
1341	=item $overlay->set ($x, $y, $text, $rend)	1468	=item $overlay->set ($x, $y, $text[, $rend])
1342		1469
1343	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1344	text in rxvt-unicode's special encoding and an array of rendition values	1471	text in rxvt-unicode's special encoding and an array of rendition values
1345	at a specific position inside the overlay.	1472	at a specific position inside the overlay.
		1473
		1474	If C<$rend> is missing, then the rendition will not be changed.
1346		1475
1347	=item $overlay->hide	1476	=item $overlay->hide
1348		1477
1349	If visible, hide the overlay, but do not destroy it.	1478	If visible, hide the overlay, but do not destroy it.
1350		1479
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1561	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1562	(escape codes) that will be interpreted.
1434		1563
1435	=item $term->tt_write ($octets)	1564	=item $term->tt_write ($octets)
1436		1565
1437	Write the octets given in C<$data> to the tty (i.e. as program input). To	1566	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438	pass characters instead of octets, you should convert your strings first	1567	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1568	to the locale-specific encoding using C<< $term->locale_encode >>.
		1569
		1570	=item $term->tt_paste ($octets)
		1571
		1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1573	CR and bracketing the data with control sequences if bracketed paste mode
		1574	is set.
1440		1575
1441	=item $old_events = $term->pty_ev_events ([$new_events])	1576	=item $old_events = $term->pty_ev_events ([$new_events])
1442		1577
1443	Replaces the event mask of the pty watcher by the given event mask. Can	1578	Replaces the event mask of the pty watcher by the given event mask. Can
1444	be used to suppress input and output handling to the pty/tty. See the	1579	be used to suppress input and output handling to the pty/tty. See the
…		…
1560		1695
1561	Used after changing terminal contents to display them.	1696	Used after changing terminal contents to display them.
1562		1697
1563	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1698	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564		1699
1565	Returns the text of the entire row with number C<$row_number>. Row C<0>	1700	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1701	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567	terminal line. The scrollback buffer starts at line C<-1> and extends to
1568	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1702	terminal line. Nothing will be returned if a nonexistent line
1569	is requested.	1703	is requested.
1570		1704
1571	If C<$new_text> is specified, it will replace characters in the current	1705	If C<$new_text> is specified, it will replace characters in the current
1572	line, starting at column C<$start_col> (default C<0>), which is useful	1706	line, starting at column C<$start_col> (default C<0>), which is useful
1573	to replace only parts of a line. The font index in the rendition will	1707	to replace only parts of a line. The font index in the rendition will
1574	automatically be updated.	1708	automatically be updated.
1575		1709
1576	C<$text> is in a special encoding: tabs and wide characters that use more	1710	C<$text> is in a special encoding: tabs and wide characters that use more
1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1711	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578	characters. Characters with combining characters and other characters that	1712	characters. Characters with combining characters and other characters that
1579	do not fit into the normal tetx encoding will be replaced with characters	1713	do not fit into the normal text encoding will be replaced with characters
1580	in the private use area.	1714	in the private use area.
1581		1715
1582	You have to obey this encoding when changing text. The advantage is	1716	You have to obey this encoding when changing text. The advantage is
1583	that C<substr> and similar functions work on screen cells and not on	1717	that C<substr> and similar functions work on screen cells and not on
1584	characters.	1718	characters.
…		…
1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760	recent grab.	1894	recent grab.
1761		1895
1762	=item $term->ungrab	1896	=item $term->ungrab
1763		1897
1764	Calls XUngrab for the most recent grab. Is called automatically on	1898	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765	evaluation errors, as it is better to lose the grab in the error case as	1899	evaluation errors, as it is better to lose the grab in the error case as
1766	the session.	1900	the session.
1767		1901
1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769		1903
…		…
1771		1905
1772	=item @atoms = $term->XListProperties ($window)	1906	=item @atoms = $term->XListProperties ($window)
1773		1907
1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1908	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775		1909
1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1910	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777		1911
1778	=item $term->XDeleteProperty ($window, $property)	1912	=item $term->XDeleteProperty ($window, $property)
1779		1913
1780	=item $window = $term->DefaultRootWindow	1914	=item $window = $term->DefaultRootWindow
1781		1915
…		…
1791		1925
1792	=item $term->XChangeInput ($window, $add_events[, $del_events])	1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
1793		1927
1794	Various X or X-related functions. The C<$term> object only serves as	1928	Various X or X-related functions. The C<$term> object only serves as
1795	the source of the display, otherwise those functions map more-or-less	1929	the source of the display, otherwise those functions map more-or-less
1796	directory onto the X functions of the same name.	1930	directly onto the X functions of the same name.
1797		1931
1798	=back	1932	=back
1799		1933
1800	=cut	1934	=cut
1801		1935
…		…
1903	my $env = $self->{term}->env;	2037	my $env = $self->{term}->env;
1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2038	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905	delete $env->{LC_ALL};	2039	delete $env->{LC_ALL};
1906	$env->{LC_CTYPE} = $self->{term}->locale;	2040	$env->{LC_CTYPE} = $self->{term}->locale;
1907		2041
1908	urxvt::term->new ($env, "popup",	2042	my $term = urxvt::term->new (
		2043	$env, "popup",
1909	"--perl-lib" => "", "--perl-ext-common" => "",	2044	"--perl-lib" => "", "--perl-ext-common" => "",
1910	"-pty-fd" => -1, "-sl" => 0,	2045	"-pty-fd" => -1, "-sl" => 0,
1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2046	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912	"--transient-for" => $self->{term}->parent,	2047	"--transient-for" => $self->{term}->parent,
1913	"-display" => $self->{term}->display_id,	2048	"-display" => $self->{term}->display_id,
1914	"-pe" => "urxvt-popup")	2049	"-pe" => "urxvt-popup",
1915	or die "unable to create popup window\n";	2050	) or die "unable to create popup window\n";
		2051
		2052	unless (delete $term->{urxvt_popup_init_done}) {
		2053	$term->ungrab;
		2054	$term->destroy;
		2055	die "unable to initialise popup window\n";
		2056	}
1916	}	2057	}
1917		2058
1918	sub DESTROY {	2059	sub DESTROY {
1919	my ($self) = @_;	2060	my ($self) = @_;
1920		2061
…		…
1925	=back	2066	=back
1926		2067
1927	=cut	2068	=cut
1928		2069
1929	package urxvt::watcher;	2070	package urxvt::watcher;
1930
1931	@urxvt::timer::ISA = __PACKAGE__;
1932	@urxvt::iow::ISA = __PACKAGE__;
1933	@urxvt::pw::ISA = __PACKAGE__;
1934	@urxvt::iw::ISA = __PACKAGE__;
1935		2071
1936	=head2 The C<urxvt::timer> Class	2072	=head2 The C<urxvt::timer> Class
1937		2073
1938	This class implements timer watchers/events. Time is represented as a	2074	This class implements timer watchers/events. Time is represented as a
1939	fractional number of seconds since the epoch. Example:	2075	fractional number of seconds since the epoch. Example:
…		…
1943	->new	2079	->new
1944	->interval (1)	2080	->interval (1)
1945	->cb (sub {	2081	->cb (sub {
1946	$term->{overlay}->set (0, 0,	2082	$term->{overlay}->set (0, 0,
1947	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2083	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948	});	2084	});
1949		2085
1950	=over 4	2086	=over 4
1951		2087
1952	=item $timer = new urxvt::timer	2088	=item $timer = new urxvt::timer
1953		2089
…		…
1956		2092
1957	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2093	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958		2094
1959	Set the callback to be called when the timer triggers.	2095	Set the callback to be called when the timer triggers.
1960		2096
1961	=item $tstamp = $timer->at
1962
1963	Return the time this watcher will fire next.
1964
1965	=item $timer = $timer->set ($tstamp)	2097	=item $timer = $timer->set ($tstamp[, $interval])
1966		2098
1967	Set the time the event is generated to $tstamp.	2099	Set the time the event is generated to $tstamp (and optionally specifies a
		2100	new $interval).
1968		2101
1969	=item $timer = $timer->interval ($interval)	2102	=item $timer = $timer->interval ($interval)
1970		2103
1971	Normally (and when C<$interval> is C<0>), the timer will automatically	2104	By default (and when C<$interval> is C<0>), the timer will automatically
1972	stop after it has fired once. If C<$interval> is non-zero, then the timer	2105	stop after it has fired once. If C<$interval> is non-zero, then the timer
1973	is automatically rescheduled at the given intervals.	2106	is automatically rescheduled at the given intervals.
1974		2107
1975	=item $timer = $timer->start	2108	=item $timer = $timer->start
1976		2109
1977	Start the timer.	2110	Start the timer.
1978		2111
1979	=item $timer = $timer->start ($tstamp)	2112	=item $timer = $timer->start ($tstamp[, $interval])
1980		2113
1981	Set the event trigger time to C<$tstamp> and start the timer.	2114	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2115	also replaces the interval.
1982		2116
1983	=item $timer = $timer->after ($delay)	2117	=item $timer = $timer->after ($delay[, $interval])
1984		2118
1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2119	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1986		2120
1987	=item $timer = $timer->stop	2121	=item $timer = $timer->stop
1988		2122
…		…
1996		2130
1997	$term->{socket} = ...	2131	$term->{socket} = ...
1998	$term->{iow} = urxvt::iow	2132	$term->{iow} = urxvt::iow
1999	->new	2133	->new
2000	->fd (fileno $term->{socket})	2134	->fd (fileno $term->{socket})
2001	->events (urxvt::EVENT_READ)	2135	->events (urxvt::EV_READ)
2002	->start	2136	->start
2003	->cb (sub {	2137	->cb (sub {
2004	my ($iow, $revents) = @_;	2138	my ($iow, $revents) = @_;
2005	# $revents must be 1 here, no need to check	2139	# $revents must be 1 here, no need to check
2006	sysread $term->{socket}, my $buf, 8192	2140	sysread $term->{socket}, my $buf, 8192
…		…
2024	Set the file descriptor (not handle) to watch.	2158	Set the file descriptor (not handle) to watch.
2025		2159
2026	=item $iow = $iow->events ($eventmask)	2160	=item $iow = $iow->events ($eventmask)
2027		2161
2028	Set the event mask to watch. The only allowed values are	2162	Set the event mask to watch. The only allowed values are
2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2163	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030	together, or C<urxvt::EVENT_NONE>.	2164	together, or C<urxvt::EV_NONE>.
2031		2165
2032	=item $iow = $iow->start	2166	=item $iow = $iow->start
2033		2167
2034	Start watching for requested events on the given handle.	2168	Start watching for requested events on the given handle.
2035		2169
…		…
2076	->new	2210	->new
2077	->start ($pid)	2211	->start ($pid)
2078	->cb (sub {	2212	->cb (sub {
2079	my ($pw, $exit_status) = @_;	2213	my ($pw, $exit_status) = @_;
2080	...	2214	...
2081	});	2215	});
2082		2216
2083	=over 4	2217	=over 4
2084		2218
2085	=item $pw = new urxvt::pw	2219	=item $pw = new urxvt::pw
2086		2220
…		…
2119		2253
2120	=back	2254	=back
2121		2255
2122	=head1 AUTHOR	2256	=head1 AUTHOR
2123		2257
2124	Marc Lehmann <pcg@goof.com>	2258	Marc Lehmann <schmorp@schmorp.de>
2125	http://software.schmorp.de/pkg/rxvt-unicode	2259	http://software.schmorp.de/pkg/rxvt-unicode
2126		2260
2127	=cut	2261	=cut
2128		2262
2129	1	2263	1
		2264
		2265	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs. Revision 1.195 by sf-exg, Wed Jun 29 22:18:11 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.195 by sf-exg, Wed Jun 29 22:18:11 2011 UTC