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

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