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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

…		…
108	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
109	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
110	first argument.	110	first argument.
111		111
112	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
114		114
115	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};	117	};
118		118
…		…
165	=item readline (enabled by default)	165	=item readline (enabled by default)
166		166
167	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
168	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
169	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
170	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
172		172
173	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
174		174
175	=over 4	175	=over 4
…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		263
264	It is possible to activate the most recently seen match from the keyboard.	264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265	Simply bind a keysym to "perl:matcher" as seen in the example below.	266	"perl:matcher:list" as seen in the example below.
266		267
267	Example configuration:	268	Example configuration:
268		269
269	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
272	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
276		278
…		…
303	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
304		306
305	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).	308	(fvwm can do it).
307		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
		315
308	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
309		317
310	A not very useful example of filtering all text output to the terminal	318	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.	320	similar-looking ascii character.
…		…
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337		345
338	=item selection-pastebin	346	=item selection-pastebin
339		347
340	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).	351	F</tmp> directly.).
344		352
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
364		372
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366		374
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
370	or not.	378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
371		393
372	=item example-refresh-hooks	394	=item example-refresh-hooks
373		395
374	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
377		412
378	=back	413	=back
379		414
380	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
381		416
…		…
397		432
398	=over 4	433	=over 4
399		434
400	=item $text	435	=item $text
401		436
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		439
405	=item $string	440	=item $string
406		441
407	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
411	=item $octets	446	=item $octets
412		447
413	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
414	locale-specific way.	449	locale-specific way.
415		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
416	=back	457	=back
417		458
418	=head2 Extension Objects	459	=head2 Extension Objects
419		460
420	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
421	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
422	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
423	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
426	internal use.	467	internal use.
…		…
541		582
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
545		586
546	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
547		588
548	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
549	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
550	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
552	this callback.	593	this callback.
553		594
554	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
555		596
556	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
557		598
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
562	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
563	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
564		615
565	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
566	as its source can not easily be controlled (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
568		622
569	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
570		624
571	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
572	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
578		632
579	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	634	suppress or filter tty input.
581		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
582	=item on_line_update $term, $row	643	=item on_line_update $term, $row
583		644
584	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
585	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
586	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
593	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
595		656
596	=item on_refresh_begin $term	657	=item on_refresh_begin $term
597		658
598	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
599	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
602		663
603	=item on_refresh_end $term	664	=item on_refresh_end $term
604		665
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
612		673
613	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	675	slightly in the future.
615		676
616	=item on_resize_all_windows $tern, $new_width, $new_height	677	=item on_resize_all_windows $term, $new_width, $new_height
617		678
618	Called just after the new window size has been calculated, but before	679	Called just after the new window size has been calculated, but before
619	windows are actually being resized or hints are being set. If this hook	680	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	681	returns TRUE, setting of the window hints is being skipped.
621		682
…		…
655		716
656	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
657		718
658	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
659		720
660	Called whenever the corresponding X event is received for the terminal If	721	Called whenever the corresponding X event is received for the terminal. If
661	the hook returns true, then the even will be ignored by rxvt-unicode.	722	the hook returns true, then the event will be ignored by rxvt-unicode.
662		723
663	The event is a hash with most values as named by Xlib (see the XEvent	724	The event is a hash with most values as named by Xlib (see the XEvent
664	manpage), with the additional members C<row> and C<col>, which are the	725	manpage), with the additional members C<row> and C<col>, which are the
665	(real, not screen-based) row and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
666		727
…		…
675		736
676	=item on_wm_delete_window $term, $event	737	=item on_wm_delete_window $term, $event
677		738
678	Called when various types of ClientMessage events are received (all with	739	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	740	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		741
		742	=item on_bell $term
		743
		744	Called on receipt of a bell character.
680		745
681	=back	746	=back
682		747
683	=cut	748	=cut
684		749
…		…
749		814
750	=over 4	815	=over 4
751		816
752	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
753		818
754	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
755	costs! The only time this is acceptable is when the terminal process	820	include a trailing newline). Avoid at all costs! The only time this
756	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
757		823
758	=item urxvt::warn $string	824	=item urxvt::warn $string
759		825
760	Calls C<rxvt_warn> with the given string which should not include a	826	Calls C<rxvt_warn> with the given string which should include a trailing
761	newline. The module also overwrites the C<warn> builtin with a function	827	newline. The module also overwrites the C<warn> builtin with a function
762	that calls this function.	828	that calls this function.
763		829
764	Using this function has the advantage that its output ends up in the	830	Using this function has the advantage that its output ends up in the
765	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	835	=item @terms = urxvt::termlist
770		836
771	Returns all urxvt::term objects that exist in this process, regardless of	837	Returns all urxvt::term objects that exist in this process, regardless of
772	whether they are started, being destroyed etc., so be careful. Only term	838	whether they are started, being destroyed etc., so be careful. Only term
773	objects that have perl extensions attached will be returned (because there	839	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	840	is no urxvt::term object associated with others).
775		841
776	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
777		843
778	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
779		845
…		…
822		888
823	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
824		890
825	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
826		892
827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	893	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		894	urxvt::RS_RVid, urxvt::RS_Uline
828		895
829	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
830	underline, respectively. To enable such a style, just logically OR it into	897	underline, respectively. To enable such a style, just logically OR it into
831	the bitset.	898	the bitset.
832		899
…		…
914	sub invoke {	981	sub invoke {
915	local $TERM = shift;	982	local $TERM = shift;
916	my $htype = shift;	983	my $htype = shift;
917		984
918	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
920		987
921	my %ext_arg;	988	my %ext_arg;
922		989
923	{	990	{
924	my @init = @TERM_INIT;	991	my @init = @TERM_INIT;
…		…
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1158	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.	1159	work.
1093		1160
1094	=cut	1161	=cut
1095		1162
1096	our $VERSION = 1;	1163	our $VERSION = '5.23';
1097		1164
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1167
1101	sub timer {	1168	sub timer {
…		…
1103		1170
1104	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
1105		1172
1106	urxvt::timer	1173	urxvt::timer
1107	->new	1174	->new
1108	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
1111	$cb->();	1178	$cb->();
1112	})	1179	})
1113	}	1180	}
1114		1181
1115	sub io {	1182	sub io {
1116	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
1117		1184
1118	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
1119		1188
1120	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
1121	->new	1190	->new
1122	->fd (fileno $arg{fh})	1191	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1193	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1194	->start
1126	->cb (sub {	1195	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1196	], urxvt::anyevent::
		1197	}
		1198
		1199	sub idle {
		1200	my ($class, %arg) = @_;
		1201
		1202	my $cb = $arg{cb};
		1203
		1204	urxvt::iw
		1205	->new
		1206	->start
		1207	->cb ($cb)
		1208	}
		1209
		1210	sub child {
		1211	my ($class, %arg) = @_;
		1212
		1213	my $cb = $arg{cb};
		1214
		1215	urxvt::pw
		1216	->new
		1217	->start ($arg{pid})
		1218	->cb (sub {
		1219	$_[0]->stop; # need to cancel manually
		1220	$cb->($_[0]->rpid, $_[0]->rstatus);
		1221	})
1131	}	1222	}
1132		1223
1133	sub DESTROY {	1224	sub DESTROY {
1134	$_[0][1]->stop;	1225	$_[0][1]->stop;
1135	}	1226	}
1136		1227
1137	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
1138	bless \my $flag, urxvt::anyevent::
1139	}
1140
1141	sub broadcast {
1142	${$_[0]}++;
1143	}
1144
1145	sub wait {
1146	unless (${$_[0]}) {
1147	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148	}
1149	}
1150
1151	sub one_event {	1229	sub one_event {
1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1230	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153	}	1231	}
1154		1232
1155	package urxvt::term;	1233	package urxvt::term;
…		…
1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1325	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1248		1326
1249	Here is a likely non-exhaustive list of option names, please see the	1327	Here is a likely non-exhaustive list of option names, please see the
1250	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
1251		1329
1252	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1257	transparent tripleclickwords utmpInhibit visualBell	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1336	urgentOnBell utmpInhibit visualBell
1258		1337
1259	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
1260		1339
1261	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
1262	optionally sets a new value. Setting values is most useful in the C<init>	1341	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1275		1354
1276	Here is a likely non-exhaustive list of resource names, not all of which	1355	Here is a likely non-exhaustive list of resource names, not all of which
1277	are supported in every build, please see the source file F</src/rsinc.h>	1356	are supported in every build, please see the source file F</src/rsinc.h>
1278	to see the actual list:	1357	to see the actual list:
1279		1358
1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1281	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1282	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1362	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1363	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290	secondaryScreen secondaryScroll selectstyle shade term_name title	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1291	transient_for transparent transparent_all tripleclickwords utmpInhibit	1371	term_name title transient_for transparent tripleclickwords urgentOnBell
1292	visualBell	1372	utmpInhibit visualBell
1293		1373
1294	=cut	1374	=cut
1295		1375
1296	sub resource($$;$) {	1376	sub resource($$;$) {
1297	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
1298	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1299	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
1300	}	1380	}
1301		1381
1302	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
1303		1383
1304	Returns the X-Resource for the given pattern, excluding the program or	1384	Returns the X-Resource for the given pattern, excluding the program or
…		…
1308		1388
1309	This method should only be called during the C<on_start> hook, as there is	1389	This method should only be called during the C<on_start> hook, as there is
1310	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
1311	the wrong resources.	1391	the wrong resources.
1312		1392
1313	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
1314		1394
1315	Adds a keymap translation exactly as specified via a resource. See the	1395	Adds a key binding exactly as specified via a resource. See the
1316	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1317		1397
1318	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
1319		1399
1320	Return and optionally change the current rendition. Text that is output by	1400	Return and optionally change the current rendition. Text that is output by
…		…
1329		1409
1330	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
1331		1411
1332	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
1333		1413
1334	Return the current values of the selection mark, begin or end positions,	1414	Return the current values of the selection mark, begin or end positions.
1335	and optionally set them to new values.	1415
		1416	When arguments are given, then the selection coordinates are set to
		1417	C<$row> and C<$col>, and the selection screen is set to the current
		1418	screen.
		1419
		1420	=item $screen = $term->selection_screen ([$screen])
		1421
		1422	Returns the current selection screen, and then optionally sets it.
1336		1423
1337	=item $term->selection_make ($eventtime[, $rectangular])	1424	=item $term->selection_make ($eventtime[, $rectangular])
1338		1425
1339	Tries to make a selection as set by C<selection_beg> and	1426	Tries to make a selection as set by C<selection_beg> and
1340	C<selection_end>. If C<$rectangular> is true (default: false), a	1427	C<selection_end>. If C<$rectangular> is true (default: false), a
1341	rectangular selection will be made. This is the prefered function to make	1428	rectangular selection will be made. This is the preferred function to make
1342	a selection.	1429	a selection.
1343		1430
1344	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345		1432
1346	Try to request the primary selection text from the server (for example, as	1433	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1434	true) selection from the server. The corresponding text can be set
1347	set by the next method). No visual feedback will be given. This function	1435	with the next method. No visual feedback will be given. This function
1348	is mostly useful from within C<on_sel_grab> hooks.	1436	is mostly useful from within C<on_sel_grab> hooks.
1349		1437
1350	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
1351		1439
1352	Return the current selection text and optionally replace it by C<$newtext>.	1440	Return the current selection (clipboard if C<$clipboard> is true) text
		1441	and optionally replace it by C<$newtext>.
		1442
		1443	=item $term->selection_clear ([$clipboard])
		1444
		1445	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353		1446
1354	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
1355		1448
1356	Create a simple multi-line overlay box. See the next method for details.	1449	Create a simple multi-line overlay box. See the next method for details.
1357		1450
…		…
1387		1480
1388	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
1389		1482
1390	=over 4	1483	=over 4
1391		1484
1392	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
1393		1486
1394	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1487	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1395	text in rxvt-unicode's special encoding and an array of rendition values	1488	text in rxvt-unicode's special encoding and an array of rendition values
1396	at a specific position inside the overlay.	1489	at a specific position inside the overlay.
		1490
		1491	If C<$rend> is missing, then the rendition will not be changed.
1397		1492
1398	=item $overlay->hide	1493	=item $overlay->hide
1399		1494
1400	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
1401		1496
…		…
1483	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1484	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1485		1580
1486	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1487		1582
1488	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1489	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1490	to the locale-specific encoding using C<< $term->locale_encode >>.	1585	to the locale-specific encoding using C<< $term->locale_encode >>.
		1586
		1587	=item $term->tt_paste ($octets)
		1588
		1589	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1590	CR and bracketing the data with control sequences if bracketed paste mode
		1591	is set.
1491		1592
1492	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1493		1594
1494	Replaces the event mask of the pty watcher by the given event mask. Can	1595	Replaces the event mask of the pty watcher by the given event mask. Can
1495	be used to suppress input and output handling to the pty/tty. See the	1596	be used to suppress input and output handling to the pty/tty. See the
…		…
1611		1712
1612	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1613		1714
1614	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615		1716
1616	Returns the text of the entire row with number C<$row_number>. Row C<0>	1717	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1718	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618	terminal line. The scrollback buffer starts at line C<-1> and extends to
1619	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1620	is requested.	1720	is requested.
1621		1721
1622	If C<$new_text> is specified, it will replace characters in the current	1722	If C<$new_text> is specified, it will replace characters in the current
1623	line, starting at column C<$start_col> (default C<0>), which is useful	1723	line, starting at column C<$start_col> (default C<0>), which is useful
1624	to replace only parts of a line. The font index in the rendition will	1724	to replace only parts of a line. The font index in the rendition will
1625	automatically be updated.	1725	automatically be updated.
1626		1726
1627	C<$text> is in a special encoding: tabs and wide characters that use more	1727	C<$text> is in a special encoding: tabs and wide characters that use more
1628	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1728	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1629	characters. Characters with combining characters and other characters that	1729	characters. Characters with combining characters and other characters that
1630	do not fit into the normal tetx encoding will be replaced with characters	1730	do not fit into the normal text encoding will be replaced with characters
1631	in the private use area.	1731	in the private use area.
1632		1732
1633	You have to obey this encoding when changing text. The advantage is	1733	You have to obey this encoding when changing text. The advantage is
1634	that C<substr> and similar functions work on screen cells and not on	1734	that C<substr> and similar functions work on screen cells and not on
1635	characters.	1735	characters.
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1911	recent grab.
1812		1912
1813	=item $term->ungrab	1913	=item $term->ungrab
1814		1914
1815	Calls XUngrab for the most recent grab. Is called automatically on	1915	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816	evaluation errors, as it is better to lose the grab in the error case as	1916	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1917	the session.
1818		1918
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1920
…		…
1822		1922
1823	=item @atoms = $term->XListProperties ($window)	1923	=item @atoms = $term->XListProperties ($window)
1824		1924
1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826		1926
1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828		1928
1829	=item $term->XDeleteProperty ($window, $property)	1929	=item $term->XDeleteProperty ($window, $property)
1830		1930
1831	=item $window = $term->DefaultRootWindow	1931	=item $window = $term->DefaultRootWindow
1832		1932
…		…
1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1840		1940
1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842		1942
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1943	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1944
		1945	=item $keysym = $term->XStringToKeysym ($string)
		1946
		1947	=item $string = $term->XKeysymToString ($keysym)
1844		1948
1845	Various X or X-related functions. The C<$term> object only serves as	1949	Various X or X-related functions. The C<$term> object only serves as
1846	the source of the display, otherwise those functions map more-or-less	1950	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1951	directly onto the X functions of the same name.
1848		1952
1849	=back	1953	=back
1850		1954
1851	=cut	1955	=cut
1852		1956
…		…
1954	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2059	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1957	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1958		2062
1959	urxvt::term->new ($env, "popup",	2063	my $term = urxvt::term->new (
		2064	$env, "popup",
1960	"--perl-lib" => "", "--perl-ext-common" => "",	2065	"--perl-lib" => "", "--perl-ext-common" => "",
1961	"-pty-fd" => -1, "-sl" => 0,	2066	"-pty-fd" => -1, "-sl" => 0,
1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1964	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1965	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1966	or die "unable to create popup window\n";	2071	) or die "unable to create popup window\n";
		2072
		2073	unless (delete $term->{urxvt_popup_init_done}) {
		2074	$term->ungrab;
		2075	$term->destroy;
		2076	die "unable to initialise popup window\n";
		2077	}
1967	}	2078	}
1968		2079
1969	sub DESTROY {	2080	sub DESTROY {
1970	my ($self) = @_;	2081	my ($self) = @_;
1971		2082
…		…
2002		2113
2003	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004		2115
2005	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
2006		2117
2007	=item $tstamp = $timer->at
2008
2009	Return the time this watcher will fire next.
2010
2011	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
2012		2119
2013	Set the time the event is generated to $tstamp.	2120	Set the time the event is generated to $tstamp (and optionally specifies a
		2121	new $interval).
2014		2122
2015	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
2016		2124
2017	Normally (and when C<$interval> is C<0>), the timer will automatically	2125	By default (and when C<$interval> is C<0>), the timer will automatically
2018	stop after it has fired once. If C<$interval> is non-zero, then the timer	2126	stop after it has fired once. If C<$interval> is non-zero, then the timer
2019	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
2020		2128
2021	=item $timer = $timer->start	2129	=item $timer = $timer->start
2022		2130
2023	Start the timer.	2131	Start the timer.
2024		2132
2025	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
2026		2134
2027	Set the event trigger time to C<$tstamp> and start the timer.	2135	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2136	also replaces the interval.
2028		2137
2029	=item $timer = $timer->after ($delay)	2138	=item $timer = $timer->after ($delay[, $interval])
2030		2139
2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2140	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032		2141
2033	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
2034		2143
…		…
2165		2274
2166	=back	2275	=back
2167		2276
2168	=head1 AUTHOR	2277	=head1 AUTHOR
2169		2278
2170	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
2171	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
2172		2281
2173	=cut	2282	=cut
2174		2283
2175	1	2284	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC vs. Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC