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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 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
…		…
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.
…		…
590	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
591		632
592	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
593	suppress or filter tty input.	634	suppress or filter tty input.
594		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
595	=item on_line_update $term, $row	643	=item on_line_update $term, $row
596		644
597	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
598	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
599	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,
…		…
624	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
625		673
626	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
627	slightly in the future.	675	slightly in the future.
628		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
629	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
630		685
631	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
632	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
633	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
634		689
…		…
668		723
669	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
670		725
671	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
672		727
673	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
674	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.
675		730
676	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
677	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
678	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
679		734
…		…
688		743
689	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
690		745
691	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
692	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.
693		752
694	=back	753	=back
695		754
696	=cut	755	=cut
697		756
…		…
762		821
763	=over 4	822	=over 4
764		823
765	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
766		825
767	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
768	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
769	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
770		830
771	=item urxvt::warn $string	831	=item urxvt::warn $string
772		832
773	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
774	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
775	that calls this function.	835	that calls this function.
776		836
777	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
778	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
783		843
784	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
785	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
786	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
788		848
789	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
790		850
791	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
792		852
…		…
835		895
836	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
837		897
838	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
839		899
840	=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
841		902
842	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
843	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
844	the bitset.	905	the bitset.
845		906
…		…
882	};	943	};
883	}	944	}
884		945
885	no warnings 'utf8';	946	no warnings 'utf8';
886		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	0
		956	}
		957
		958	sub usage {
		959	my ($term, $usage_type) = @_;
		960
		961	$term->scan_meta;
		962
		963	my $r = $term->{meta}{resource};
		964
		965	for my $regex (sort keys %$r) {
		966	my ($ext, $type, $desc) = @{ $r->{$regex} };
		967
		968	$desc .= " (-pe $ext)";
		969
		970	if ($usage_type == 1) {
		971	if ($type eq "boolean") {
		972	urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
		973	} else {
		974	urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
		975	}
		976	} else {
		977	urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
		978	}
		979	}
		980	}
		981
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		983
889	sub verbose {	984	sub verbose {
890	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
…		…
927	sub invoke {	1022	sub invoke {
928	local $TERM = shift;	1023	local $TERM = shift;
929	my $htype = shift;	1024	my $htype = shift;
930		1025
931	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
933		1028
934	my %ext_arg;	1029	my %ext_arg;
935		1030
936	{	1031	{
937	my @init = @TERM_INIT;	1032	my @init = @TERM_INIT;
…		…
1098	=head2 The C<urxvt::anyevent> Class	1193	=head2 The C<urxvt::anyevent> Class
1099		1194
1100	The sole purpose of this class is to deliver an interface to the	1195	The sole purpose of this class is to deliver an interface to the
1101	C<AnyEvent> module - any module using it will work inside urxvt without	1196	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	1197	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	1198	condition variables, but non-blocking condvar use is ok.
1104	is that you cannot use blocking APIs, but the non-blocking variant should	1199
1105	work.	1200	In practical terms this means is that you cannot use blocking APIs, but
		1201	the non-blocking variant should work.
1106		1202
1107	=cut	1203	=cut
1108		1204
1109	our $VERSION = '3.4';	1205	our $VERSION = '5.23';
1110		1206
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1207	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1208	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1209
1114	sub timer {	1210	sub timer {
…		…
1116		1212
1117	my $cb = $arg{cb};	1213	my $cb = $arg{cb};
1118		1214
1119	urxvt::timer	1215	urxvt::timer
1120	->new	1216	->new
1121	->start (urxvt::NOW + $arg{after})	1217	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1218	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1219	$_[0]->stop; # need to cancel manually
1124	$cb->();	1220	$cb->();
1125	})	1221	})
1126	}	1222	}
1127		1223
1128	sub io {	1224	sub io {
1129	my ($class, %arg) = @_;	1225	my ($class, %arg) = @_;
1130		1226
1131	my $cb = $arg{cb};	1227	my $cb = $arg{cb};
		1228	my $fd = fileno $arg{fh};
		1229	defined $fd or $fd = $arg{fh};
1132		1230
1133	bless [$arg{fh}, urxvt::iow	1231	bless [$arg{fh}, urxvt::iow
1134	->new	1232	->new
1135	->fd (fileno $arg{fh})	1233	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1234	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1235	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1236	->start
1139	->cb (sub {	1237	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1238	], urxvt::anyevent::
		1239	}
		1240
		1241	sub idle {
		1242	my ($class, %arg) = @_;
		1243
		1244	my $cb = $arg{cb};
		1245
		1246	urxvt::iw
		1247	->new
		1248	->start
		1249	->cb ($cb)
		1250	}
		1251
		1252	sub child {
		1253	my ($class, %arg) = @_;
		1254
		1255	my $cb = $arg{cb};
		1256
		1257	urxvt::pw
		1258	->new
		1259	->start ($arg{pid})
		1260	->cb (sub {
		1261	$_[0]->stop; # need to cancel manually
		1262	$cb->($_[0]->rpid, $_[0]->rstatus);
		1263	})
1144	}	1264	}
1145		1265
1146	sub DESTROY {	1266	sub DESTROY {
1147	$_[0][1]->stop;	1267	$_[0][1]->stop;
1148	}	1268	}
1149		1269
		1270	# only needed for AnyEvent < 6 compatibility
1150	sub one_event {	1271	sub one_event {
1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1272	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1152	}	1273	}
1153		1274
1154	package urxvt::term;	1275	package urxvt::term;
…		…
1183	$proxy->enable ($name => $ref);	1304	$proxy->enable ($name => $ref);
1184	}	1305	}
1185	}	1306	}
1186	}	1307	}
1187		1308
		1309	sub perl_libdirs {
		1310	map { split /:/ }
		1311	$_[0]->resource ("perl_lib"),
		1312	$ENV{URXVT_PERL_LIB},
		1313	"$ENV{HOME}/.urxvt/ext",
		1314	"$LIBDIR/perl"
		1315	}
		1316
		1317	sub scan_meta {
		1318	my ($self) = @_;
		1319	my @libdirs = perl_libdirs $self;
		1320
		1321	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1322
		1323	my %meta;
		1324
		1325	$self->{meta_libdirs} = join "\x00", @libdirs;
		1326	$self->{meta} = \%meta;
		1327
		1328	for my $dir (reverse @libdirs) {
		1329	opendir my $fh, $dir
		1330	or next;
		1331	for my $ext (readdir $fh) {
		1332	$ext ne "."
		1333	and $ext ne ".."
		1334	and open my $fh, "<", "$dir/$ext"
		1335	or next;
		1336
		1337	while (<$fh>) {
		1338	if (/^#:META:RESOURCE:(.*)/) {
		1339	my ($regex, $type, $desc) = split /:/, $1;
		1340	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1341	$meta{resource}{$regex} = [$ext, $type, $desc];
		1342	} elsif (/^\s*(?:#\|$)/) {
		1343	# skip other comments and empty lines
		1344	} else {
		1345	last; # stop parsing on first non-empty non-comment line
		1346	}
		1347	}
		1348	}
		1349	}
		1350	}
		1351
1188	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1352	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1189		1353
1190	Creates a new terminal, very similar as if you had started it with system	1354	Creates a new terminal, very similar as if you had started it with system
1191	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1355	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1192	hash which defines the environment of the new terminal.	1356	hash which defines the environment of the new terminal.
…		…
1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1410	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1247		1411
1248	Here is a likely non-exhaustive list of option names, please see the	1412	Here is a likely non-exhaustive list of option names, please see the
1249	source file F</src/optinc.h> to see the actual list:	1413	source file F</src/optinc.h> to see the actual list:
1250		1414
1251	borderLess console cursorBlink cursorUnderline hold iconic insecure	1415	borderLess buffered console cursorBlink cursorUnderline hold iconic
1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1416	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1417	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1418	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1419	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1256	transparent tripleclickwords utmpInhibit visualBell	1420	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1421	urgentOnBell utmpInhibit visualBell
1257		1422
1258	=item $value = $term->resource ($name[, $newval])	1423	=item $value = $term->resource ($name[, $newval])
1259		1424
1260	Returns the current resource value associated with a given name and	1425	Returns the current resource value associated with a given name and
1261	optionally sets a new value. Setting values is most useful in the C<init>	1426	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1274		1439
1275	Here is a likely non-exhaustive list of resource names, not all of which	1440	Here is a likely non-exhaustive list of resource names, not all of which
1276	are supported in every build, please see the source file F</src/rsinc.h>	1441	are supported in every build, please see the source file F</src/rsinc.h>
1277	to see the actual list:	1442	to see the actual list:
1278		1443
1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1444	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1445	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1281	display_name embed ext_bwidth fade font geometry hold iconName	1446	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1447	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1448	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1449	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1450	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1451	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1452	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1453	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1454	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289	secondaryScreen secondaryScroll shade term_name title	1455	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1290	transient_for transparent transparent_all tripleclickwords utmpInhibit	1456	term_name title transient_for transparent tripleclickwords urgentOnBell
1291	visualBell	1457	utmpInhibit visualBell
1292		1458
1293	=cut	1459	=cut
1294		1460
1295	sub resource($$;$) {	1461	sub resource($$;$) {
1296	my ($self, $name) = (shift, shift);	1462	my ($self, $name) = (shift, shift);
…		…
1307		1473
1308	This method should only be called during the C<on_start> hook, as there is	1474	This method should only be called during the C<on_start> hook, as there is
1309	only one resource database per display, and later invocations might return	1475	only one resource database per display, and later invocations might return
1310	the wrong resources.	1476	the wrong resources.
1311		1477
1312	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1478	=item $success = $term->parse_keysym ($key, $octets)
1313		1479
1314	Adds a keymap translation exactly as specified via a resource. See the	1480	Adds a key binding exactly as specified via a resource. See the
1315	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1481	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1482
		1483	=item $term->register_command ($keysym, $modifiermask, $string)
		1484
		1485	Adds a key binding. This is a lower level api compared to
		1486	C<parse_keysym>, as it expects a parsed key description, and can be
		1487	used only inside either the C<on_init> hook, to add a binding, or the
		1488	C<on_register_command> hook, to modify a parsed binding.
1316		1489
1317	=item $rend = $term->rstyle ([$new_rstyle])	1490	=item $rend = $term->rstyle ([$new_rstyle])
1318		1491
1319	Return and optionally change the current rendition. Text that is output by	1492	Return and optionally change the current rendition. Text that is output by
1320	the terminal application will use this style.	1493	the terminal application will use this style.
…		…
1328		1501
1329	=item ($row, $col) = $term->selection_beg ([$row, $col])	1502	=item ($row, $col) = $term->selection_beg ([$row, $col])
1330		1503
1331	=item ($row, $col) = $term->selection_end ([$row, $col])	1504	=item ($row, $col) = $term->selection_end ([$row, $col])
1332		1505
1333	Return the current values of the selection mark, begin or end positions,	1506	Return the current values of the selection mark, begin or end positions.
1334	and optionally set them to new values.	1507
		1508	When arguments are given, then the selection coordinates are set to
		1509	C<$row> and C<$col>, and the selection screen is set to the current
		1510	screen.
		1511
		1512	=item $screen = $term->selection_screen ([$screen])
		1513
		1514	Returns the current selection screen, and then optionally sets it.
1335		1515
1336	=item $term->selection_make ($eventtime[, $rectangular])	1516	=item $term->selection_make ($eventtime[, $rectangular])
1337		1517
1338	Tries to make a selection as set by C<selection_beg> and	1518	Tries to make a selection as set by C<selection_beg> and
1339	C<selection_end>. If C<$rectangular> is true (default: false), a	1519	C<selection_end>. If C<$rectangular> is true (default: false), a
1340	rectangular selection will be made. This is the prefered function to make	1520	rectangular selection will be made. This is the preferred function to make
1341	a selection.	1521	a selection.
1342		1522
1343	=item $success = $term->selection_grab ($eventtime)	1523	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344		1524
1345	Try to request the primary selection text from the server (for example, as	1525	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1526	true) selection from the server. The corresponding text can be set
1346	set by the next method). No visual feedback will be given. This function	1527	with the next method. No visual feedback will be given. This function
1347	is mostly useful from within C<on_sel_grab> hooks.	1528	is mostly useful from within C<on_sel_grab> hooks.
1348		1529
1349	=item $oldtext = $term->selection ([$newtext])	1530	=item $oldtext = $term->selection ([$newtext, $clipboard])
1350		1531
1351	Return the current selection text and optionally replace it by C<$newtext>.	1532	Return the current selection (clipboard if C<$clipboard> is true) text
		1533	and optionally replace it by C<$newtext>.
		1534
		1535	=item $term->selection_clear ([$clipboard])
		1536
		1537	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352		1538
1353	=item $term->overlay_simple ($x, $y, $text)	1539	=item $term->overlay_simple ($x, $y, $text)
1354		1540
1355	Create a simple multi-line overlay box. See the next method for details.	1541	Create a simple multi-line overlay box. See the next method for details.
1356		1542
…		…
1484	locale-specific encoding of the terminal and can contain command sequences	1670	locale-specific encoding of the terminal and can contain command sequences
1485	(escape codes) that will be interpreted.	1671	(escape codes) that will be interpreted.
1486		1672
1487	=item $term->tt_write ($octets)	1673	=item $term->tt_write ($octets)
1488		1674
1489	Write the octets given in C<$data> to the tty (i.e. as program input). To	1675	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1490	pass characters instead of octets, you should convert your strings first	1676	pass characters instead of octets, you should convert your strings first
1491	to the locale-specific encoding using C<< $term->locale_encode >>.	1677	to the locale-specific encoding using C<< $term->locale_encode >>.
		1678
		1679	=item $term->tt_paste ($octets)
		1680
		1681	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1682	CR and bracketing the data with control sequences if bracketed paste mode
		1683	is set.
1492		1684
1493	=item $old_events = $term->pty_ev_events ([$new_events])	1685	=item $old_events = $term->pty_ev_events ([$new_events])
1494		1686
1495	Replaces the event mask of the pty watcher by the given event mask. Can	1687	Replaces the event mask of the pty watcher by the given event mask. Can
1496	be used to suppress input and output handling to the pty/tty. See the	1688	be used to suppress input and output handling to the pty/tty. See the
…		…
1514		1706
1515	Adds the specified events to the vt event mask. Useful e.g. when you want	1707	Adds the specified events to the vt event mask. Useful e.g. when you want
1516	to receive pointer events all the times:	1708	to receive pointer events all the times:
1517		1709
1518	$term->vt_emask_add (urxvt::PointerMotionMask);	1710	$term->vt_emask_add (urxvt::PointerMotionMask);
		1711
		1712	=item $term->set_urgency ($set)
		1713
		1714	Enable/disable the urgency hint on the toplevel window.
1519		1715
1520	=item $term->focus_in	1716	=item $term->focus_in
1521		1717
1522	=item $term->focus_out	1718	=item $term->focus_out
1523		1719
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2006	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	2007	recent grab.
1812		2008
1813	=item $term->ungrab	2009	=item $term->ungrab
1814		2010
1815	Calls XUngrab for the most recent grab. Is called automatically on	2011	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	2012	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	2013	the session.
1818		2014
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2015	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		2016
…		…
1840		2036
1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2037	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842		2038
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	2039	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		2040
		2041	=item $keysym = $term->XStringToKeysym ($string)
		2042
		2043	=item $string = $term->XKeysymToString ($keysym)
		2044
1845	Various X or X-related functions. The C<$term> object only serves as	2045	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	2046	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	2047	directly onto the X functions of the same name.
1848		2048
1849	=back	2049	=back
1850		2050
1851	=cut	2051	=cut
1852		2052
…		…
2009		2209
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2210	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2211
2012	Set the callback to be called when the timer triggers.	2212	Set the callback to be called when the timer triggers.
2013		2213
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2214	=item $timer = $timer->set ($tstamp[, $interval])
2019		2215
2020	Set the time the event is generated to $tstamp.	2216	Set the time the event is generated to $tstamp (and optionally specifies a
		2217	new $interval).
2021		2218
2022	=item $timer = $timer->interval ($interval)	2219	=item $timer = $timer->interval ($interval)
2023		2220
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2221	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2222	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2223	is automatically rescheduled at the given intervals.
2027		2224
2028	=item $timer = $timer->start	2225	=item $timer = $timer->start
2029		2226
2030	Start the timer.	2227	Start the timer.
2031		2228
2032	=item $timer = $timer->start ($tstamp)	2229	=item $timer = $timer->start ($tstamp[, $interval])
2033		2230
2034	Set the event trigger time to C<$tstamp> and start the timer.	2231	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2232	also replaces the interval.
2035		2233
2036	=item $timer = $timer->after ($delay)	2234	=item $timer = $timer->after ($delay[, $interval])
2037		2235
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2236	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2237
2040	=item $timer = $timer->stop	2238	=item $timer = $timer->stop
2041		2239
…		…
2172		2370
2173	=back	2371	=back
2174		2372
2175	=head1 AUTHOR	2373	=head1 AUTHOR
2176		2374
2177	Marc Lehmann <pcg@goof.com>	2375	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2376	http://software.schmorp.de/pkg/rxvt-unicode
2179		2377
2180	=cut	2378	=cut
2181		2379
2182	1	2380	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC vs. Revision 1.209 by root, Tue Jun 5 22:38:17 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 2012 UTC