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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC

…		…
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.
		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.
377		393
378	=item example-refresh-hooks	394	=item example-refresh-hooks
379		395
380	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
381	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
382	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"
383		412
384	=back	413	=back
385		414
386	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
387		416
…		…
403		432
404	=over 4	433	=over 4
405		434
406	=item $text	435	=item $text
407		436
408	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
409	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.
410		439
411	=item $string	440	=item $string
412		441
413	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
…		…
417	=item $octets	446	=item $octets
418		447
419	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
420	locale-specific way.	449	locale-specific way.
421		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
422	=back	457	=back
423		458
424	=head2 Extension Objects	459	=head2 Extension Objects
425		460
426	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
427	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,
428	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
429	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
430	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
431	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
432	internal use.	467	internal use.
…		…
596	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
597		632
598	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
599	suppress or filter tty input.	634	suppress or filter tty input.
600		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
601	=item on_line_update $term, $row	643	=item on_line_update $term, $row
602		644
603	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
604	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
605	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,
…		…
630	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
631		673
632	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
633	slightly in the future.	675	slightly in the future.
634		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
635	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
636		685
637	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
638	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
639	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
640		689
…		…
674		723
675	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
676		725
677	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
678		727
679	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
680	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.
681		730
682	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
683	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
684	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
685		734
…		…
694		743
695	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
696		745
697	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
698	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
699		752
700	=back	753	=back
701		754
702	=cut	755	=cut
703		756
…		…
768		821
769	=over 4	822	=over 4
770		823
771	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
772		825
773	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
774	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
775	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
776		830
777	=item urxvt::warn $string	831	=item urxvt::warn $string
778		832
779	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
780	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
781	that calls this function.	835	that calls this function.
782		836
783	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
784	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
788	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
789		843
790	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
791	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
792	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
793	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
794		848
795	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
796		850
797	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
798		852
…		…
841		895
842	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
843		897
844	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
845		899
846	=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
847		902
848	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
849	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
850	the bitset.	905	the bitset.
851		906
…		…
888	};	943	};
889	}	944	}
890		945
891	no warnings 'utf8';	946	no warnings 'utf8';
892		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	my $r = $term->{meta}{resource};
		956	while (my ($pattern, $v) = each %$r) {
		957	$name =~ y/-/./ if $isarg;
		958
		959	if (
		960	$pattern =~ s/\*$//
		961	? $pattern eq substr $name, 0, length $pattern
		962	: $pattern eq $name
		963	) {
		964	$name = "$urxvt::RESCLASS.$name";
		965	warn "set option <$name=$value>\n";#d#
		966	#TODO: queue $v->[0] for loading
		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	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
893	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
894		1008
895	sub verbose {	1009	sub verbose {
896	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
897	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
933	sub invoke {	1047	sub invoke {
934	local $TERM = shift;	1048	local $TERM = shift;
935	my $htype = shift;	1049	my $htype = shift;
936		1050
937	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
938	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
939		1053
940	my %ext_arg;	1054	my %ext_arg;
941		1055
942	{	1056	{
943	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
…		…
1104	=head2 The C<urxvt::anyevent> Class	1218	=head2 The C<urxvt::anyevent> Class
1105		1219
1106	The sole purpose of this class is to deliver an interface to the	1220	The sole purpose of this class is to deliver an interface to the
1107	C<AnyEvent> module - any module using it will work inside urxvt without	1221	C<AnyEvent> module - any module using it will work inside urxvt without
1108	further programming. The only exception is that you cannot wait on	1222	further programming. The only exception is that you cannot wait on
1109	condition variables, but non-blocking condvar use is ok. What this means	1223	condition variables, but non-blocking condvar use is ok.
1110	is that you cannot use blocking APIs, but the non-blocking variant should	1224
1111	work.	1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
1112		1227
1113	=cut	1228	=cut
1114		1229
1115	our $VERSION = '3.4';	1230	our $VERSION = '5.23';
1116		1231
1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1232	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1233	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119		1234
1120	sub timer {	1235	sub timer {
…		…
1122		1237
1123	my $cb = $arg{cb};	1238	my $cb = $arg{cb};
1124		1239
1125	urxvt::timer	1240	urxvt::timer
1126	->new	1241	->new
1127	->start (urxvt::NOW + $arg{after})	1242	->after ($arg{after}, $arg{interval})
1128	->cb (sub {	1243	->cb ($arg{interval} ? $cb : sub {
1129	$_[0]->stop; # need to cancel manually	1244	$_[0]->stop; # need to cancel manually
1130	$cb->();	1245	$cb->();
1131	})	1246	})
1132	}	1247	}
1133		1248
1134	sub io {	1249	sub io {
1135	my ($class, %arg) = @_;	1250	my ($class, %arg) = @_;
1136		1251
1137	my $cb = $arg{cb};	1252	my $cb = $arg{cb};
		1253	my $fd = fileno $arg{fh};
		1254	defined $fd or $fd = $arg{fh};
1138		1255
1139	bless [$arg{fh}, urxvt::iow	1256	bless [$arg{fh}, urxvt::iow
1140	->new	1257	->new
1141	->fd (fileno $arg{fh})	1258	->fd ($fd)
1142	->events (($arg{poll} =~ /r/ ? 1 : 0)	1259	->events (($arg{poll} =~ /r/ ? 1 : 0)
1143	\| ($arg{poll} =~ /w/ ? 2 : 0))	1260	\| ($arg{poll} =~ /w/ ? 2 : 0))
1144	->start	1261	->start
1145	->cb (sub {	1262	->cb ($cb)
1146	$cb->(($_[1] & 1 ? 'r' : '')
1147	. ($_[1] & 2 ? 'w' : ''));
1148	})],
1149	urxvt::anyevent::	1263	], urxvt::anyevent::
		1264	}
		1265
		1266	sub idle {
		1267	my ($class, %arg) = @_;
		1268
		1269	my $cb = $arg{cb};
		1270
		1271	urxvt::iw
		1272	->new
		1273	->start
		1274	->cb ($cb)
		1275	}
		1276
		1277	sub child {
		1278	my ($class, %arg) = @_;
		1279
		1280	my $cb = $arg{cb};
		1281
		1282	urxvt::pw
		1283	->new
		1284	->start ($arg{pid})
		1285	->cb (sub {
		1286	$_[0]->stop; # need to cancel manually
		1287	$cb->($_[0]->rpid, $_[0]->rstatus);
		1288	})
1150	}	1289	}
1151		1290
1152	sub DESTROY {	1291	sub DESTROY {
1153	$_[0][1]->stop;	1292	$_[0][1]->stop;
1154	}	1293	}
1155		1294
		1295	# only needed for AnyEvent < 6 compatibility
1156	sub one_event {	1296	sub one_event {
1157	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1158	}	1298	}
1159		1299
1160	package urxvt::term;	1300	package urxvt::term;
…		…
1189	$proxy->enable ($name => $ref);	1329	$proxy->enable ($name => $ref);
1190	}	1330	}
1191	}	1331	}
1192	}	1332	}
1193		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#\|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195		1382
1196	Creates a new terminal, very similar as if you had started it with system	1383	Creates a new terminal, very similar as if you had started it with system
1197	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1198	hash which defines the environment of the new terminal.	1385	hash which defines the environment of the new terminal.
…		…
1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1253		1440
1254	Here is a likely non-exhaustive list of option names, please see the	1441	Here is a likely non-exhaustive list of option names, please see the
1255	source file F</src/optinc.h> to see the actual list:	1442	source file F</src/optinc.h> to see the actual list:
1256		1443
1257	borderLess console cursorBlink cursorUnderline hold iconic insecure	1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
1258	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1260	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1261	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1262	transparent tripleclickwords utmpInhibit visualBell	1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1450	urgentOnBell utmpInhibit visualBell
1263		1451
1264	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
1265		1453
1266	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
1267	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1280		1468
1281	Here is a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
1282	are supported in every build, please see the source file F</src/rsinc.h>	1470	are supported in every build, please see the source file F</src/rsinc.h>
1283	to see the actual list:	1471	to see the actual list:
1284		1472
1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1287	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295	secondaryScreen secondaryScroll shade term_name title	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1296	transient_for transparent transparent_all tripleclickwords utmpInhibit	1485	term_name title transient_for transparent tripleclickwords urgentOnBell
1297	visualBell	1486	utmpInhibit visualBell
1298		1487
1299	=cut	1488	=cut
1300		1489
1301	sub resource($$;$) {	1490	sub resource($$;$) {
1302	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
…		…
1313		1502
1314	This method should only be called during the C<on_start> hook, as there is	1503	This method should only be called during the C<on_start> hook, as there is
1315	only one resource database per display, and later invocations might return	1504	only one resource database per display, and later invocations might return
1316	the wrong resources.	1505	the wrong resources.
1317		1506
1318	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1507	=item $success = $term->parse_keysym ($key, $octets)
1319		1508
1320	Adds a keymap translation exactly as specified via a resource. See the	1509	Adds a key binding exactly as specified via a resource. See the
1321	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1510	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1511
		1512	=item $term->register_command ($keysym, $modifiermask, $string)
		1513
		1514	Adds a key binding. This is a lower level api compared to
		1515	C<parse_keysym>, as it expects a parsed key description, and can be
		1516	used only inside either the C<on_init> hook, to add a binding, or the
		1517	C<on_register_command> hook, to modify a parsed binding.
1322		1518
1323	=item $rend = $term->rstyle ([$new_rstyle])	1519	=item $rend = $term->rstyle ([$new_rstyle])
1324		1520
1325	Return and optionally change the current rendition. Text that is output by	1521	Return and optionally change the current rendition. Text that is output by
1326	the terminal application will use this style.	1522	the terminal application will use this style.
…		…
1334		1530
1335	=item ($row, $col) = $term->selection_beg ([$row, $col])	1531	=item ($row, $col) = $term->selection_beg ([$row, $col])
1336		1532
1337	=item ($row, $col) = $term->selection_end ([$row, $col])	1533	=item ($row, $col) = $term->selection_end ([$row, $col])
1338		1534
1339	Return the current values of the selection mark, begin or end positions,	1535	Return the current values of the selection mark, begin or end positions.
1340	and optionally set them to new values.	1536
		1537	When arguments are given, then the selection coordinates are set to
		1538	C<$row> and C<$col>, and the selection screen is set to the current
		1539	screen.
		1540
		1541	=item $screen = $term->selection_screen ([$screen])
		1542
		1543	Returns the current selection screen, and then optionally sets it.
1341		1544
1342	=item $term->selection_make ($eventtime[, $rectangular])	1545	=item $term->selection_make ($eventtime[, $rectangular])
1343		1546
1344	Tries to make a selection as set by C<selection_beg> and	1547	Tries to make a selection as set by C<selection_beg> and
1345	C<selection_end>. If C<$rectangular> is true (default: false), a	1548	C<selection_end>. If C<$rectangular> is true (default: false), a
1346	rectangular selection will be made. This is the prefered function to make	1549	rectangular selection will be made. This is the preferred function to make
1347	a selection.	1550	a selection.
1348		1551
1349	=item $success = $term->selection_grab ($eventtime)	1552	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350		1553
1351	Try to request the primary selection text from the server (for example, as	1554	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1555	true) selection from the server. The corresponding text can be set
1352	set by the next method). No visual feedback will be given. This function	1556	with the next method. No visual feedback will be given. This function
1353	is mostly useful from within C<on_sel_grab> hooks.	1557	is mostly useful from within C<on_sel_grab> hooks.
1354		1558
1355	=item $oldtext = $term->selection ([$newtext])	1559	=item $oldtext = $term->selection ([$newtext, $clipboard])
1356		1560
1357	Return the current selection text and optionally replace it by C<$newtext>.	1561	Return the current selection (clipboard if C<$clipboard> is true) text
		1562	and optionally replace it by C<$newtext>.
		1563
		1564	=item $term->selection_clear ([$clipboard])
		1565
		1566	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358		1567
1359	=item $term->overlay_simple ($x, $y, $text)	1568	=item $term->overlay_simple ($x, $y, $text)
1360		1569
1361	Create a simple multi-line overlay box. See the next method for details.	1570	Create a simple multi-line overlay box. See the next method for details.
1362		1571
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1699	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1700	(escape codes) that will be interpreted.
1492		1701
1493	=item $term->tt_write ($octets)	1702	=item $term->tt_write ($octets)
1494		1703
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1704	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1705	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1706	to the locale-specific encoding using C<< $term->locale_encode >>.
		1707
		1708	=item $term->tt_paste ($octets)
		1709
		1710	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1711	CR and bracketing the data with control sequences if bracketed paste mode
		1712	is set.
1498		1713
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1714	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1715
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1716	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1717	be used to suppress input and output handling to the pty/tty. See the
…		…
1520		1735
1521	Adds the specified events to the vt event mask. Useful e.g. when you want	1736	Adds the specified events to the vt event mask. Useful e.g. when you want
1522	to receive pointer events all the times:	1737	to receive pointer events all the times:
1523		1738
1524	$term->vt_emask_add (urxvt::PointerMotionMask);	1739	$term->vt_emask_add (urxvt::PointerMotionMask);
		1740
		1741	=item $term->set_urgency ($set)
		1742
		1743	Enable/disable the urgency hint on the toplevel window.
1525		1744
1526	=item $term->focus_in	1745	=item $term->focus_in
1527		1746
1528	=item $term->focus_out	1747	=item $term->focus_out
1529		1748
…		…
1816	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2035	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817	recent grab.	2036	recent grab.
1818		2037
1819	=item $term->ungrab	2038	=item $term->ungrab
1820		2039
1821	Calls XUngrab for the most recent grab. Is called automatically on	2040	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822	evaluation errors, as it is better to lose the grab in the error case as	2041	evaluation errors, as it is better to lose the grab in the error case as
1823	the session.	2042	the session.
1824		2043
1825	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2044	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826		2045
…		…
1846		2065
1847	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2066	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1848		2067
1849	=item $term->XChangeInput ($window, $add_events[, $del_events])	2068	=item $term->XChangeInput ($window, $add_events[, $del_events])
1850		2069
		2070	=item $keysym = $term->XStringToKeysym ($string)
		2071
		2072	=item $string = $term->XKeysymToString ($keysym)
		2073
1851	Various X or X-related functions. The C<$term> object only serves as	2074	Various X or X-related functions. The C<$term> object only serves as
1852	the source of the display, otherwise those functions map more-or-less	2075	the source of the display, otherwise those functions map more-or-less
1853	directory onto the X functions of the same name.	2076	directly onto the X functions of the same name.
1854		2077
1855	=back	2078	=back
1856		2079
1857	=cut	2080	=cut
1858		2081
…		…
2015		2238
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2239	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2240
2018	Set the callback to be called when the timer triggers.	2241	Set the callback to be called when the timer triggers.
2019		2242
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2243	=item $timer = $timer->set ($tstamp[, $interval])
2025		2244
2026	Set the time the event is generated to $tstamp.	2245	Set the time the event is generated to $tstamp (and optionally specifies a
		2246	new $interval).
2027		2247
2028	=item $timer = $timer->interval ($interval)	2248	=item $timer = $timer->interval ($interval)
2029		2249
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2250	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2251	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2252	is automatically rescheduled at the given intervals.
2033		2253
2034	=item $timer = $timer->start	2254	=item $timer = $timer->start
2035		2255
2036	Start the timer.	2256	Start the timer.
2037		2257
2038	=item $timer = $timer->start ($tstamp)	2258	=item $timer = $timer->start ($tstamp[, $interval])
2039		2259
2040	Set the event trigger time to C<$tstamp> and start the timer.	2260	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2261	also replaces the interval.
2041		2262
2042	=item $timer = $timer->after ($delay)	2263	=item $timer = $timer->after ($delay[, $interval])
2043		2264
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2265	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2266
2046	=item $timer = $timer->stop	2267	=item $timer = $timer->stop
2047		2268
…		…
2178		2399
2179	=back	2400	=back
2180		2401
2181	=head1 AUTHOR	2402	=head1 AUTHOR
2182		2403
2183	Marc Lehmann <pcg@goof.com>	2404	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2405	http://software.schmorp.de/pkg/rxvt-unicode
2185		2406
2186	=cut	2407	=cut
2187		2408
2188	1	2409	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs. Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC