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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

…		…
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
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
…		…
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
…		…
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343		345
344	=item selection-pastebin	346	=item selection-pastebin
345		347
346	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
347	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
348	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
349	F</tmp> directly.).	351	F</tmp> directly.).
350		352
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
370		372
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372		374
373	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
374	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,
375	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
376	or not.	378	or not.
377		379
378	=item macosx-pastebin and macosx-pastebin-native	380	=item macosx-clipboard and macosx-clipboard-native
379		381
380	These two modules implement an extended clipboard for Mac OS X. They are	382	These two modules implement an extended clipboard for Mac OS X. They are
381	used like this:	383	used like this:
382		384
383	URxvt.perl-ext-common: default,macosx-clipboard	385	URxvt.perl-ext-common: default,macosx-clipboard
384	URxvt.keysym.M-c: perl:macosx-clipboard:copy	386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
385	URxvt.keysym.M-v: perl:macosx-clipboard:paste	387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
386		388
387	The difference between them is that the native variant requires a	389	The difference between them is that the native variant requires a
388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the	390	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	391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390	simpler etc. etc.	392	simpler etc. etc.
391		393
392	=item example-refresh-hooks	394	=item example-refresh-hooks
393		395
394	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
395	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
396	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"
397		412
398	=back	413	=back
399		414
400	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
401		416
…		…
417		432
418	=over 4	433	=over 4
419		434
420	=item $text	435	=item $text
421		436
422	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
423	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.
424		439
425	=item $string	440	=item $string
426		441
427	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
…		…
431	=item $octets	446	=item $octets
432		447
433	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
434	locale-specific way.	449	locale-specific way.
435		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
436	=back	457	=back
437		458
438	=head2 Extension Objects	459	=head2 Extension Objects
439		460
440	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
441	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,
442	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
443	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
444	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
445	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
446	internal use.	467	internal use.
…		…
610	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
611		632
612	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
613	suppress or filter tty input.	634	suppress or filter tty input.
614		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
615	=item on_line_update $term, $row	643	=item on_line_update $term, $row
616		644
617	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
618	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
619	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,
…		…
644	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
645		673
646	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
647	slightly in the future.	675	slightly in the future.
648		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
649	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
650		685
651	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
652	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
653	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
654		689
…		…
688		723
689	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
690		725
691	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
692		727
693	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
694	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
695		730
696	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
697	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
698	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
699		734
…		…
709	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
710		745
711	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
714	=back	753	=back
715		754
716	=cut	755	=cut
717		756
718	package urxvt;	757	package urxvt;
719		758
720	use utf8;	759	use utf8;
721	use strict;	760	use strict 'vars';
722	use Carp ();	761	use Carp ();
723	use Scalar::Util ();	762	use Scalar::Util ();
724	use List::Util ();	763	use List::Util ();
725		764
726	our $VERSION = 1;	765	our $VERSION = 1;
727	our $TERM;	766	our $TERM;
728	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
729	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
730	our @HOOKNAME;	769	our @HOOKNAME;
731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
732	our %OPTION;	771	our %OPTION;
733		772
734	our $LIBDIR;	773	our $LIBDIR;
…		…
782		821
783	=over 4	822	=over 4
784		823
785	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
786		825
787	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
788	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
789	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
790		830
791	=item urxvt::warn $string	831	=item urxvt::warn $string
792		832
793	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
794	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
795	that calls this function.	835	that calls this function.
796		836
797	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
798	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
802	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
803		843
804	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
805	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
806	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
807	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
808		848
809	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
810		850
811	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
812		852
…		…
855		895
856	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
857		897
858	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
859		899
860	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
861		902
862	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
863	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
864	the bitset.	905	the bitset.
865		906
…		…
902	};	943	};
903	}	944	}
904		945
905	no warnings 'utf8';	946	no warnings 'utf8';
906		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
908		1009
909	sub verbose {	1010	sub verbose {
910	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
911	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
927		1028
928	open my $fh, "<:raw", $path	1029	open my $fh, "<:raw", $path
929	or die "$path: $!";	1030	or die "$path: $!";
930		1031
931	my $source =	1032	my $source =
932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
933	. "#line 1 \"$path\"\n{\n"	1034	. "#line 1 \"$path\"\n{\n"
934	. (do { local $/; <$fh> })	1035	. (do { local $/; <$fh> })
935	. "\n};\n1";	1036	. "\n};\n1";
936		1037
937	eval $source	1038	eval $source
…		…
947	sub invoke {	1048	sub invoke {
948	local $TERM = shift;	1049	local $TERM = shift;
949	my $htype = shift;	1050	my $htype = shift;
950		1051
951	if ($htype == 0) { # INIT	1052	if ($htype == 0) { # INIT
952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1053	my @dirs = $TERM->perl_libdirs;
953		1054
954	my %ext_arg;	1055	my %ext_arg;
955		1056
956	{	1057	{
957	my @init = @TERM_INIT;	1058	my @init = @TERM_INIT;
…		…
960	my @pkg = @TERM_EXT;	1061	my @pkg = @TERM_EXT;
961	@TERM_EXT = ();	1062	@TERM_EXT = ();
962	$TERM->register_package ($_) for @pkg;	1063	$TERM->register_package ($_) for @pkg;
963	}	1064	}
964		1065
		1066	for (
		1067	@{ delete $TERM->{perl_ext_3} },
965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1068	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1069	) {
966	if ($_ eq "default") {	1070	if ($_ eq "default") {
967	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1071	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
968	} elsif (/^-(.*)$/) {	1072	} elsif (/^-(.*)$/) {
969	delete $ext_arg{$1};	1073	delete $ext_arg{$1};
970	} elsif (/^([^<]+)<(.*)>$/) {	1074	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1118	=head2 The C<urxvt::anyevent> Class	1222	=head2 The C<urxvt::anyevent> Class
1119		1223
1120	The sole purpose of this class is to deliver an interface to the	1224	The sole purpose of this class is to deliver an interface to the
1121	C<AnyEvent> module - any module using it will work inside urxvt without	1225	C<AnyEvent> module - any module using it will work inside urxvt without
1122	further programming. The only exception is that you cannot wait on	1226	further programming. The only exception is that you cannot wait on
1123	condition variables, but non-blocking condvar use is ok. What this means	1227	condition variables, but non-blocking condvar use is ok.
1124	is that you cannot use blocking APIs, but the non-blocking variant should	1228
1125	work.	1229	In practical terms this means is that you cannot use blocking APIs, but
		1230	the non-blocking variant should work.
1126		1231
1127	=cut	1232	=cut
1128		1233
1129	our $VERSION = '5.23';	1234	our $VERSION = '5.23';
1130		1235
…		…
1189		1294
1190	sub DESTROY {	1295	sub DESTROY {
1191	$_[0][1]->stop;	1296	$_[0][1]->stop;
1192	}	1297	}
1193		1298
		1299	# only needed for AnyEvent < 6 compatibility
1194	sub one_event {	1300	sub one_event {
1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1301	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1196	}	1302	}
1197		1303
1198	package urxvt::term;	1304	package urxvt::term;
…		…
1227	$proxy->enable ($name => $ref);	1333	$proxy->enable ($name => $ref);
1228	}	1334	}
1229	}	1335	}
1230	}	1336	}
1231		1337
		1338	sub perl_libdirs {
		1339	map { split /:/ }
		1340	$_[0]->resource ("perl_lib"),
		1341	$ENV{URXVT_PERL_LIB},
		1342	"$ENV{HOME}/.urxvt/ext",
		1343	"$LIBDIR/perl"
		1344	}
		1345
		1346	sub scan_meta {
		1347	my ($self) = @_;
		1348	my @libdirs = perl_libdirs $self;
		1349
		1350	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1351
		1352	my %meta;
		1353
		1354	$self->{meta_libdirs} = join "\x00", @libdirs;
		1355	$self->{meta} = \%meta;
		1356
		1357	for my $dir (reverse @libdirs) {
		1358	opendir my $fh, $dir
		1359	or next;
		1360	for my $ext (readdir $fh) {
		1361	$ext ne "."
		1362	and $ext ne ".."
		1363	and open my $fh, "<", "$dir/$ext"
		1364	or next;
		1365
		1366	while (<$fh>) {
		1367	if (/^#:META:X_RESOURCE:(.*)/) {
		1368	my ($pattern, $type, $desc) = split /:/, $1;
		1369	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1370	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1371	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1372	} else {
		1373	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1374	}
		1375	} elsif (/^\s*(?:#\|$)/) {
		1376	# skip other comments and empty lines
		1377	} else {
		1378	last; # stop parsing on first non-empty non-comment line
		1379	}
		1380	}
		1381	}
		1382	}
		1383	}
		1384
1232	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1385	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1233		1386
1234	Creates a new terminal, very similar as if you had started it with system	1387	Creates a new terminal, very similar as if you had started it with system
1235	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1388	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1236	hash which defines the environment of the new terminal.	1389	hash which defines the environment of the new terminal.
…		…
1290	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1443	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1291		1444
1292	Here is a likely non-exhaustive list of option names, please see the	1445	Here is a likely non-exhaustive list of option names, please see the
1293	source file F</src/optinc.h> to see the actual list:	1446	source file F</src/optinc.h> to see the actual list:
1294		1447
1295	borderLess console cursorBlink cursorUnderline hold iconic insecure	1448	borderLess buffered console cursorBlink cursorUnderline hold iconic
1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1449	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1450	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1298	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1451	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1299	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1452	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1300	transparent tripleclickwords utmpInhibit visualBell	1453	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1454	urgentOnBell utmpInhibit visualBell
1301		1455
1302	=item $value = $term->resource ($name[, $newval])	1456	=item $value = $term->resource ($name[, $newval])
1303		1457
1304	Returns the current resource value associated with a given name and	1458	Returns the current resource value associated with a given name and
1305	optionally sets a new value. Setting values is most useful in the C<init>	1459	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1318		1472
1319	Here is a likely non-exhaustive list of resource names, not all of which	1473	Here is a likely non-exhaustive list of resource names, not all of which
1320	are supported in every build, please see the source file F</src/rsinc.h>	1474	are supported in every build, please see the source file F</src/rsinc.h>
1321	to see the actual list:	1475	to see the actual list:
1322		1476
1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1325	display_name embed ext_bwidth fade font geometry hold iconName	1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1483	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1484	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1485	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1486	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1487	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1333	secondaryScreen secondaryScroll shade term_name title	1488	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1334	transient_for transparent transparent_all tripleclickwords utmpInhibit	1489	term_name title transient_for transparent tripleclickwords urgentOnBell
1335	visualBell	1490	utmpInhibit visualBell
1336		1491
1337	=cut	1492	=cut
1338		1493
1339	sub resource($$;$) {	1494	sub resource($$;$) {
1340	my ($self, $name) = (shift, shift);	1495	my ($self, $name) = (shift, shift);
…		…
1351		1506
1352	This method should only be called during the C<on_start> hook, as there is	1507	This method should only be called during the C<on_start> hook, as there is
1353	only one resource database per display, and later invocations might return	1508	only one resource database per display, and later invocations might return
1354	the wrong resources.	1509	the wrong resources.
1355		1510
1356	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1511	=item $value = $term->x_resource_boolean ($pattern)
1357		1512
		1513	Like C<x_resource>, above, but interprets the string value as a boolean
		1514	and returns C<1> for true values, C<0> for false values and C<undef> if
		1515	the resource or option isn't specified.
		1516
		1517	You should always use this method to parse boolean resources.
		1518
		1519	=cut
		1520
		1521	sub x_resource_boolean {
		1522	my $res = &x_resource;
		1523
		1524	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1525	}
		1526
		1527	=item $success = $term->parse_keysym ($key, $octets)
		1528
1358	Adds a keymap translation exactly as specified via a resource. See the	1529	Adds a key binding exactly as specified via a resource. See the
1359	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1531
		1532	=item $term->register_command ($keysym, $modifiermask, $string)
		1533
		1534	Adds a key binding. This is a lower level api compared to
		1535	C<parse_keysym>, as it expects a parsed key description, and can be
		1536	used only inside either the C<on_init> hook, to add a binding, or the
		1537	C<on_register_command> hook, to modify a parsed binding.
1360		1538
1361	=item $rend = $term->rstyle ([$new_rstyle])	1539	=item $rend = $term->rstyle ([$new_rstyle])
1362		1540
1363	Return and optionally change the current rendition. Text that is output by	1541	Return and optionally change the current rendition. Text that is output by
1364	the terminal application will use this style.	1542	the terminal application will use this style.
…		…
1386		1564
1387	=item $term->selection_make ($eventtime[, $rectangular])	1565	=item $term->selection_make ($eventtime[, $rectangular])
1388		1566
1389	Tries to make a selection as set by C<selection_beg> and	1567	Tries to make a selection as set by C<selection_beg> and
1390	C<selection_end>. If C<$rectangular> is true (default: false), a	1568	C<selection_end>. If C<$rectangular> is true (default: false), a
1391	rectangular selection will be made. This is the prefered function to make	1569	rectangular selection will be made. This is the preferred function to make
1392	a selection.	1570	a selection.
1393		1571
1394	=item $success = $term->selection_grab ($eventtime)	1572	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1395		1573
1396	Try to request the primary selection text from the server (for example, as	1574	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1575	true) selection from the server. The corresponding text can be set
1397	set by the next method). No visual feedback will be given. This function	1576	with the next method. No visual feedback will be given. This function
1398	is mostly useful from within C<on_sel_grab> hooks.	1577	is mostly useful from within C<on_sel_grab> hooks.
1399		1578
1400	=item $oldtext = $term->selection ([$newtext])	1579	=item $oldtext = $term->selection ([$newtext, $clipboard])
1401		1580
1402	Return the current selection text and optionally replace it by C<$newtext>.	1581	Return the current selection (clipboard if C<$clipboard> is true) text
		1582	and optionally replace it by C<$newtext>.
		1583
		1584	=item $term->selection_clear ([$clipboard])
		1585
		1586	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1403		1587
1404	=item $term->overlay_simple ($x, $y, $text)	1588	=item $term->overlay_simple ($x, $y, $text)
1405		1589
1406	Create a simple multi-line overlay box. See the next method for details.	1590	Create a simple multi-line overlay box. See the next method for details.
1407		1591
…		…
1535	locale-specific encoding of the terminal and can contain command sequences	1719	locale-specific encoding of the terminal and can contain command sequences
1536	(escape codes) that will be interpreted.	1720	(escape codes) that will be interpreted.
1537		1721
1538	=item $term->tt_write ($octets)	1722	=item $term->tt_write ($octets)
1539		1723
1540	Write the octets given in C<$data> to the tty (i.e. as program input). To	1724	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1541	pass characters instead of octets, you should convert your strings first	1725	pass characters instead of octets, you should convert your strings first
1542	to the locale-specific encoding using C<< $term->locale_encode >>.	1726	to the locale-specific encoding using C<< $term->locale_encode >>.
		1727
		1728	=item $term->tt_paste ($octets)
		1729
		1730	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1731	CR and bracketing the data with control sequences if bracketed paste mode
		1732	is set.
1543		1733
1544	=item $old_events = $term->pty_ev_events ([$new_events])	1734	=item $old_events = $term->pty_ev_events ([$new_events])
1545		1735
1546	Replaces the event mask of the pty watcher by the given event mask. Can	1736	Replaces the event mask of the pty watcher by the given event mask. Can
1547	be used to suppress input and output handling to the pty/tty. See the	1737	be used to suppress input and output handling to the pty/tty. See the
…		…
1565		1755
1566	Adds the specified events to the vt event mask. Useful e.g. when you want	1756	Adds the specified events to the vt event mask. Useful e.g. when you want
1567	to receive pointer events all the times:	1757	to receive pointer events all the times:
1568		1758
1569	$term->vt_emask_add (urxvt::PointerMotionMask);	1759	$term->vt_emask_add (urxvt::PointerMotionMask);
		1760
		1761	=item $term->set_urgency ($set)
		1762
		1763	Enable/disable the urgency hint on the toplevel window.
1570		1764
1571	=item $term->focus_in	1765	=item $term->focus_in
1572		1766
1573	=item $term->focus_out	1767	=item $term->focus_out
1574		1768
…		…
1861	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2055	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1862	recent grab.	2056	recent grab.
1863		2057
1864	=item $term->ungrab	2058	=item $term->ungrab
1865		2059
1866	Calls XUngrab for the most recent grab. Is called automatically on	2060	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1867	evaluation errors, as it is better to lose the grab in the error case as	2061	evaluation errors, as it is better to lose the grab in the error case as
1868	the session.	2062	the session.
1869		2063
1870	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2064	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1871		2065
…		…
1891		2085
1892	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2086	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1893		2087
1894	=item $term->XChangeInput ($window, $add_events[, $del_events])	2088	=item $term->XChangeInput ($window, $add_events[, $del_events])
1895		2089
		2090	=item $keysym = $term->XStringToKeysym ($string)
		2091
		2092	=item $string = $term->XKeysymToString ($keysym)
		2093
1896	Various X or X-related functions. The C<$term> object only serves as	2094	Various X or X-related functions. The C<$term> object only serves as
1897	the source of the display, otherwise those functions map more-or-less	2095	the source of the display, otherwise those functions map more-or-less
1898	directory onto the X functions of the same name.	2096	directly onto the X functions of the same name.
1899		2097
1900	=back	2098	=back
1901		2099
1902	=cut	2100	=cut
1903		2101
…		…
2221		2419
2222	=back	2420	=back
2223		2421
2224	=head1 AUTHOR	2422	=head1 AUTHOR
2225		2423
2226	Marc Lehmann <pcg@goof.com>	2424	Marc Lehmann <schmorp@schmorp.de>
2227	http://software.schmorp.de/pkg/rxvt-unicode	2425	http://software.schmorp.de/pkg/rxvt-unicode
2228		2426
2229	=cut	2427	=cut
2230		2428
2231	1	2429	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC vs. Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC