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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 2012 UTC

…		…
108	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
110	first argument.	110	first argument.
111		111
112	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
114		114
115	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};	117	};
118		118
…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		263
264	It is possible to activate the most recently seen match from the keyboard.	264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265	Simply bind a keysym to "perl:matcher" as seen in the example below.	266	"perl:matcher:list" as seen in the example below.
266		267
267	Example configuration:	268	Example configuration:
268		269
269	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
272	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
276		278
…		…
303	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
304		306
305	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).	308	(fvwm can do it).
307		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
		315
308	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
309		317
310	A not very useful example of filtering all text output to the terminal	318	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.	320	similar-looking ascii character.
…		…
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337		345
338	=item selection-pastebin	346	=item selection-pastebin
339		347
340	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).	351	F</tmp> directly.).
344		352
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
364		372
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366		374
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
370	or not.	378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
371		393
372	=item example-refresh-hooks	394	=item example-refresh-hooks
373		395
374	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
377		412
378	=back	413	=back
379		414
380	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
381		416
…		…
397		432
398	=over 4	433	=over 4
399		434
400	=item $text	435	=item $text
401		436
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		439
405	=item $string	440	=item $string
406		441
407	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
411	=item $octets	446	=item $octets
412		447
413	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
414	locale-specific way.	449	locale-specific way.
415		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
416	=back	457	=back
417		458
418	=head2 Extension Objects	459	=head2 Extension Objects
419		460
420	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
421	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
422	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
423	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
426	internal use.	467	internal use.
…		…
541		582
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
545		586
546	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
547		588
548	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
549	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
550	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
552	this callback.	593	this callback.
553		594
554	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
555		596
556	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
557		598
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
562	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
563	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
564		615
565	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
566	as its source can not easily be controlled (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
568		622
569	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
570		624
571	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
572	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
578		632
579	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	634	suppress or filter tty input.
581		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
582	=item on_line_update $term, $row	643	=item on_line_update $term, $row
583		644
584	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
585	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
586	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
593	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
595		656
596	=item on_refresh_begin $term	657	=item on_refresh_begin $term
597		658
598	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
599	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
602		663
603	=item on_refresh_end $term	664	=item on_refresh_end $term
604		665
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
612		673
613	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	675	slightly in the future.
615		676
		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
616	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
617		685
618	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
619	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
620	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
621		689
…		…
655		723
656	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
657		725
658	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
659		727
660	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
661	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.
662		730
663	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
664	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
665	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
666		734
…		…
675		743
676	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
677		745
678	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
679	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.
680		752
681	=back	753	=back
682		754
683	=cut	755	=cut
684		756
…		…
749		821
750	=over 4	822	=over 4
751		823
752	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
753		825
754	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
755	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
756	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
757		830
758	=item urxvt::warn $string	831	=item urxvt::warn $string
759		832
760	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
761	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
762	that calls this function.	835	that calls this function.
763		836
764	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
765	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
770		843
771	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
772	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
773	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
775		848
776	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
777		850
778	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
779		852
…		…
822		895
823	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
824		897
825	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
826		899
827	=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
828		902
829	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
830	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
831	the bitset.	905	the bitset.
832		906
…		…
869	};	943	};
870	}	944	}
871		945
872	no warnings 'utf8';	946	no warnings 'utf8';
873		947
		948	sub perl_libdirs {
		949	map { split /:/ }
		950	$_[0]->resource ("perl_lib"),
		951	$ENV{URXVT_PERL_LIB},
		952	"$ENV{HOME}/.urxvt/ext",
		953	"$LIBDIR/perl"
		954	}
		955
		956	our %META; # meta header information from scripts
		957	our %SCAN; # which dirs already scanned
		958
		959	sub resource {
		960	my ($term, $name, $isarg, $flag, $value) = @_;
		961
		962	for my $dir (perl_libdirs $term) {
		963	}
		964
		965	warn "resourece<@_>\n";#d#
		966
		967	0
		968	}
		969
874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	970	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875		971
876	sub verbose {	972	sub verbose {
877	my ($level, $msg) = @_;	973	my ($level, $msg) = @_;
878	warn "$msg\n" if $level <= $verbosity;	974	warn "$msg\n" if $level <= $verbosity;
…		…
914	sub invoke {	1010	sub invoke {
915	local $TERM = shift;	1011	local $TERM = shift;
916	my $htype = shift;	1012	my $htype = shift;
917		1013
918	if ($htype == 0) { # INIT	1014	if ($htype == 0) { # INIT
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1015	my @dirs = perl_libdirs $TERM;
920		1016
921	my %ext_arg;	1017	my %ext_arg;
922		1018
923	{	1019	{
924	my @init = @TERM_INIT;	1020	my @init = @TERM_INIT;
…		…
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1187	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.	1188	work.
1093		1189
1094	=cut	1190	=cut
1095		1191
1096	our $VERSION = 1;	1192	our $VERSION = '5.23';
1097		1193
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1194	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1195	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1196
1101	sub timer {	1197	sub timer {
…		…
1103		1199
1104	my $cb = $arg{cb};	1200	my $cb = $arg{cb};
1105		1201
1106	urxvt::timer	1202	urxvt::timer
1107	->new	1203	->new
1108	->start (urxvt::NOW + $arg{after})	1204	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1205	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1206	$_[0]->stop; # need to cancel manually
1111	$cb->();	1207	$cb->();
1112	})	1208	})
1113	}	1209	}
1114		1210
1115	sub io {	1211	sub io {
1116	my ($class, %arg) = @_;	1212	my ($class, %arg) = @_;
1117		1213
1118	my $cb = $arg{cb};	1214	my $cb = $arg{cb};
		1215	my $fd = fileno $arg{fh};
		1216	defined $fd or $fd = $arg{fh};
1119		1217
1120	bless [$arg{fh}, urxvt::iow	1218	bless [$arg{fh}, urxvt::iow
1121	->new	1219	->new
1122	->fd (fileno $arg{fh})	1220	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1221	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1222	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1223	->start
1126	->cb (sub {	1224	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1225	], urxvt::anyevent::
		1226	}
		1227
		1228	sub idle {
		1229	my ($class, %arg) = @_;
		1230
		1231	my $cb = $arg{cb};
		1232
		1233	urxvt::iw
		1234	->new
		1235	->start
		1236	->cb ($cb)
		1237	}
		1238
		1239	sub child {
		1240	my ($class, %arg) = @_;
		1241
		1242	my $cb = $arg{cb};
		1243
		1244	urxvt::pw
		1245	->new
		1246	->start ($arg{pid})
		1247	->cb (sub {
		1248	$_[0]->stop; # need to cancel manually
		1249	$cb->($_[0]->rpid, $_[0]->rstatus);
		1250	})
1131	}	1251	}
1132		1252
1133	sub DESTROY {	1253	sub DESTROY {
1134	$_[0][1]->stop;	1254	$_[0][1]->stop;
1135	}	1255	}
1136		1256
1137	sub condvar {	1257	# only needed for AnyEvent < 6 compatibility
1138	bless \my $flag, urxvt::anyevent::
1139	}
1140
1141	sub broadcast {
1142	${$_[0]}++;
1143	}
1144
1145	sub wait {
1146	unless (${$_[0]}) {
1147	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148	}
1149	}
1150
1151	sub one_event {	1258	sub one_event {
1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1259	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153	}	1260	}
1154		1261
1155	package urxvt::term;	1262	package urxvt::term;
…		…
1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1354	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1248		1355
1249	Here is a likely non-exhaustive list of option names, please see the	1356	Here is a likely non-exhaustive list of option names, please see the
1250	source file F</src/optinc.h> to see the actual list:	1357	source file F</src/optinc.h> to see the actual list:
1251		1358
1252	borderLess console cursorBlink cursorUnderline hold iconic insecure	1359	borderLess buffered console cursorBlink cursorUnderline hold iconic
1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1360	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1361	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1362	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1257	transparent tripleclickwords utmpInhibit visualBell	1364	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1365	urgentOnBell utmpInhibit visualBell
1258		1366
1259	=item $value = $term->resource ($name[, $newval])	1367	=item $value = $term->resource ($name[, $newval])
1260		1368
1261	Returns the current resource value associated with a given name and	1369	Returns the current resource value associated with a given name and
1262	optionally sets a new value. Setting values is most useful in the C<init>	1370	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1275		1383
1276	Here is a likely non-exhaustive list of resource names, not all of which	1384	Here is a likely non-exhaustive list of resource names, not all of which
1277	are supported in every build, please see the source file F</src/rsinc.h>	1385	are supported in every build, please see the source file F</src/rsinc.h>
1278	to see the actual list:	1386	to see the actual list:
1279		1387
1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1388	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1281	borderLess color cursorBlink cursorUnderline cutchars delete_key	1389	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1282	display_name embed ext_bwidth fade font geometry hold iconName	1390	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1391	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1392	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1393	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1394	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1395	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1396	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1397	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1398	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290	secondaryScreen secondaryScroll selectstyle shade term_name title	1399	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1291	transient_for transparent transparent_all tripleclickwords utmpInhibit	1400	term_name title transient_for transparent tripleclickwords urgentOnBell
1292	visualBell	1401	utmpInhibit visualBell
1293		1402
1294	=cut	1403	=cut
1295		1404
1296	sub resource($$;$) {	1405	sub resource($$;$) {
1297	my ($self, $name) = (shift, shift);	1406	my ($self, $name) = (shift, shift);
1298	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1407	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1299	&urxvt::term::_resource	1408	goto &urxvt::term::_resource
1300	}	1409	}
1301		1410
1302	=item $value = $term->x_resource ($pattern)	1411	=item $value = $term->x_resource ($pattern)
1303		1412
1304	Returns the X-Resource for the given pattern, excluding the program or	1413	Returns the X-Resource for the given pattern, excluding the program or
…		…
1308		1417
1309	This method should only be called during the C<on_start> hook, as there is	1418	This method should only be called during the C<on_start> hook, as there is
1310	only one resource database per display, and later invocations might return	1419	only one resource database per display, and later invocations might return
1311	the wrong resources.	1420	the wrong resources.
1312		1421
1313	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1422	=item $success = $term->parse_keysym ($key, $octets)
1314		1423
1315	Adds a keymap translation exactly as specified via a resource. See the	1424	Adds a key binding exactly as specified via a resource. See the
1316	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1425	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1426
		1427	=item $term->register_command ($keysym, $modifiermask, $string)
		1428
		1429	Adds a key binding. This is a lower level api compared to
		1430	C<parse_keysym>, as it expects a parsed key description, and can be
		1431	used only inside either the C<on_init> hook, to add a binding, or the
		1432	C<on_register_command> hook, to modify a parsed binding.
1317		1433
1318	=item $rend = $term->rstyle ([$new_rstyle])	1434	=item $rend = $term->rstyle ([$new_rstyle])
1319		1435
1320	Return and optionally change the current rendition. Text that is output by	1436	Return and optionally change the current rendition. Text that is output by
1321	the terminal application will use this style.	1437	the terminal application will use this style.
…		…
1329		1445
1330	=item ($row, $col) = $term->selection_beg ([$row, $col])	1446	=item ($row, $col) = $term->selection_beg ([$row, $col])
1331		1447
1332	=item ($row, $col) = $term->selection_end ([$row, $col])	1448	=item ($row, $col) = $term->selection_end ([$row, $col])
1333		1449
1334	Return the current values of the selection mark, begin or end positions,	1450	Return the current values of the selection mark, begin or end positions.
1335	and optionally set them to new values.	1451
		1452	When arguments are given, then the selection coordinates are set to
		1453	C<$row> and C<$col>, and the selection screen is set to the current
		1454	screen.
		1455
		1456	=item $screen = $term->selection_screen ([$screen])
		1457
		1458	Returns the current selection screen, and then optionally sets it.
1336		1459
1337	=item $term->selection_make ($eventtime[, $rectangular])	1460	=item $term->selection_make ($eventtime[, $rectangular])
1338		1461
1339	Tries to make a selection as set by C<selection_beg> and	1462	Tries to make a selection as set by C<selection_beg> and
1340	C<selection_end>. If C<$rectangular> is true (default: false), a	1463	C<selection_end>. If C<$rectangular> is true (default: false), a
1341	rectangular selection will be made. This is the prefered function to make	1464	rectangular selection will be made. This is the preferred function to make
1342	a selection.	1465	a selection.
1343		1466
1344	=item $success = $term->selection_grab ($eventtime)	1467	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345		1468
1346	Try to request the primary selection text from the server (for example, as	1469	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1470	true) selection from the server. The corresponding text can be set
1347	set by the next method). No visual feedback will be given. This function	1471	with the next method. No visual feedback will be given. This function
1348	is mostly useful from within C<on_sel_grab> hooks.	1472	is mostly useful from within C<on_sel_grab> hooks.
1349		1473
1350	=item $oldtext = $term->selection ([$newtext])	1474	=item $oldtext = $term->selection ([$newtext, $clipboard])
1351		1475
1352	Return the current selection text and optionally replace it by C<$newtext>.	1476	Return the current selection (clipboard if C<$clipboard> is true) text
		1477	and optionally replace it by C<$newtext>.
		1478
		1479	=item $term->selection_clear ([$clipboard])
		1480
		1481	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353		1482
1354	=item $term->overlay_simple ($x, $y, $text)	1483	=item $term->overlay_simple ($x, $y, $text)
1355		1484
1356	Create a simple multi-line overlay box. See the next method for details.	1485	Create a simple multi-line overlay box. See the next method for details.
1357		1486
…		…
1387		1516
1388	The methods currently supported on C<urxvt::overlay> objects are:	1517	The methods currently supported on C<urxvt::overlay> objects are:
1389		1518
1390	=over 4	1519	=over 4
1391		1520
1392	=item $overlay->set ($x, $y, $text, $rend)	1521	=item $overlay->set ($x, $y, $text[, $rend])
1393		1522
1394	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1523	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1395	text in rxvt-unicode's special encoding and an array of rendition values	1524	text in rxvt-unicode's special encoding and an array of rendition values
1396	at a specific position inside the overlay.	1525	at a specific position inside the overlay.
		1526
		1527	If C<$rend> is missing, then the rendition will not be changed.
1397		1528
1398	=item $overlay->hide	1529	=item $overlay->hide
1399		1530
1400	If visible, hide the overlay, but do not destroy it.	1531	If visible, hide the overlay, but do not destroy it.
1401		1532
…		…
1483	locale-specific encoding of the terminal and can contain command sequences	1614	locale-specific encoding of the terminal and can contain command sequences
1484	(escape codes) that will be interpreted.	1615	(escape codes) that will be interpreted.
1485		1616
1486	=item $term->tt_write ($octets)	1617	=item $term->tt_write ($octets)
1487		1618
1488	Write the octets given in C<$data> to the tty (i.e. as program input). To	1619	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1489	pass characters instead of octets, you should convert your strings first	1620	pass characters instead of octets, you should convert your strings first
1490	to the locale-specific encoding using C<< $term->locale_encode >>.	1621	to the locale-specific encoding using C<< $term->locale_encode >>.
		1622
		1623	=item $term->tt_paste ($octets)
		1624
		1625	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1626	CR and bracketing the data with control sequences if bracketed paste mode
		1627	is set.
1491		1628
1492	=item $old_events = $term->pty_ev_events ([$new_events])	1629	=item $old_events = $term->pty_ev_events ([$new_events])
1493		1630
1494	Replaces the event mask of the pty watcher by the given event mask. Can	1631	Replaces the event mask of the pty watcher by the given event mask. Can
1495	be used to suppress input and output handling to the pty/tty. See the	1632	be used to suppress input and output handling to the pty/tty. See the
…		…
1514	Adds the specified events to the vt event mask. Useful e.g. when you want	1651	Adds the specified events to the vt event mask. Useful e.g. when you want
1515	to receive pointer events all the times:	1652	to receive pointer events all the times:
1516		1653
1517	$term->vt_emask_add (urxvt::PointerMotionMask);	1654	$term->vt_emask_add (urxvt::PointerMotionMask);
1518		1655
		1656	=item $term->set_urgency ($set)
		1657
		1658	Enable/disable the urgency hint on the toplevel window.
		1659
1519	=item $term->focus_in	1660	=item $term->focus_in
1520		1661
1521	=item $term->focus_out	1662	=item $term->focus_out
1522		1663
1523	=item $term->key_press ($state, $keycode[, $time])	1664	=item $term->key_press ($state, $keycode[, $time])
…		…
1611		1752
1612	Used after changing terminal contents to display them.	1753	Used after changing terminal contents to display them.
1613		1754
1614	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1755	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615		1756
1616	Returns the text of the entire row with number C<$row_number>. Row C<0>	1757	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1758	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618	terminal line. The scrollback buffer starts at line C<-1> and extends to
1619	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1759	terminal line. Nothing will be returned if a nonexistent line
1620	is requested.	1760	is requested.
1621		1761
1622	If C<$new_text> is specified, it will replace characters in the current	1762	If C<$new_text> is specified, it will replace characters in the current
1623	line, starting at column C<$start_col> (default C<0>), which is useful	1763	line, starting at column C<$start_col> (default C<0>), which is useful
1624	to replace only parts of a line. The font index in the rendition will	1764	to replace only parts of a line. The font index in the rendition will
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1950	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1951	recent grab.
1812		1952
1813	=item $term->ungrab	1953	=item $term->ungrab
1814		1954
1815	Calls XUngrab for the most recent grab. Is called automatically on	1955	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	1956	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1957	the session.
1818		1958
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1959	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1960
…		…
1822		1962
1823	=item @atoms = $term->XListProperties ($window)	1963	=item @atoms = $term->XListProperties ($window)
1824		1964
1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1965	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826		1966
1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1967	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828		1968
1829	=item $term->XDeleteProperty ($window, $property)	1969	=item $term->XDeleteProperty ($window, $property)
1830		1970
1831	=item $window = $term->DefaultRootWindow	1971	=item $window = $term->DefaultRootWindow
1832		1972
…		…
1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1979	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1840		1980
1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1981	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842		1982
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1983	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1984
		1985	=item $keysym = $term->XStringToKeysym ($string)
		1986
		1987	=item $string = $term->XKeysymToString ($keysym)
1844		1988
1845	Various X or X-related functions. The C<$term> object only serves as	1989	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	1990	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1991	directly onto the X functions of the same name.
1848		1992
1849	=back	1993	=back
1850		1994
1851	=cut	1995	=cut
1852		1996
…		…
1954	my $env = $self->{term}->env;	2098	my $env = $self->{term}->env;
1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2099	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956	delete $env->{LC_ALL};	2100	delete $env->{LC_ALL};
1957	$env->{LC_CTYPE} = $self->{term}->locale;	2101	$env->{LC_CTYPE} = $self->{term}->locale;
1958		2102
1959	urxvt::term->new ($env, "popup",	2103	my $term = urxvt::term->new (
		2104	$env, "popup",
1960	"--perl-lib" => "", "--perl-ext-common" => "",	2105	"--perl-lib" => "", "--perl-ext-common" => "",
1961	"-pty-fd" => -1, "-sl" => 0,	2106	"-pty-fd" => -1, "-sl" => 0,
1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2107	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963	"--transient-for" => $self->{term}->parent,	2108	"--transient-for" => $self->{term}->parent,
1964	"-display" => $self->{term}->display_id,	2109	"-display" => $self->{term}->display_id,
1965	"-pe" => "urxvt-popup")	2110	"-pe" => "urxvt-popup",
1966	or die "unable to create popup window\n";	2111	) or die "unable to create popup window\n";
		2112
		2113	unless (delete $term->{urxvt_popup_init_done}) {
		2114	$term->ungrab;
		2115	$term->destroy;
		2116	die "unable to initialise popup window\n";
		2117	}
1967	}	2118	}
1968		2119
1969	sub DESTROY {	2120	sub DESTROY {
1970	my ($self) = @_;	2121	my ($self) = @_;
1971		2122
…		…
2002		2153
2003	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2154	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004		2155
2005	Set the callback to be called when the timer triggers.	2156	Set the callback to be called when the timer triggers.
2006		2157
2007	=item $tstamp = $timer->at
2008
2009	Return the time this watcher will fire next.
2010
2011	=item $timer = $timer->set ($tstamp)	2158	=item $timer = $timer->set ($tstamp[, $interval])
2012		2159
2013	Set the time the event is generated to $tstamp.	2160	Set the time the event is generated to $tstamp (and optionally specifies a
		2161	new $interval).
2014		2162
2015	=item $timer = $timer->interval ($interval)	2163	=item $timer = $timer->interval ($interval)
2016		2164
2017	Normally (and when C<$interval> is C<0>), the timer will automatically	2165	By default (and when C<$interval> is C<0>), the timer will automatically
2018	stop after it has fired once. If C<$interval> is non-zero, then the timer	2166	stop after it has fired once. If C<$interval> is non-zero, then the timer
2019	is automatically rescheduled at the given intervals.	2167	is automatically rescheduled at the given intervals.
2020		2168
2021	=item $timer = $timer->start	2169	=item $timer = $timer->start
2022		2170
2023	Start the timer.	2171	Start the timer.
2024		2172
2025	=item $timer = $timer->start ($tstamp)	2173	=item $timer = $timer->start ($tstamp[, $interval])
2026		2174
2027	Set the event trigger time to C<$tstamp> and start the timer.	2175	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2176	also replaces the interval.
2028		2177
2029	=item $timer = $timer->after ($delay)	2178	=item $timer = $timer->after ($delay[, $interval])
2030		2179
2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2180	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032		2181
2033	=item $timer = $timer->stop	2182	=item $timer = $timer->stop
2034		2183
…		…
2165		2314
2166	=back	2315	=back
2167		2316
2168	=head1 AUTHOR	2317	=head1 AUTHOR
2169		2318
2170	Marc Lehmann <pcg@goof.com>	2319	Marc Lehmann <schmorp@schmorp.de>
2171	http://software.schmorp.de/pkg/rxvt-unicode	2320	http://software.schmorp.de/pkg/rxvt-unicode
2172		2321
2173	=cut	2322	=cut
2174		2323
2175	1	2324	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 UTC vs. Revision 1.207 by root, Tue Jun 5 21:29:52 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 2012 UTC