[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.201 by sf-exg, Tue Nov 29 19:20:18 2011 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
…		…
416	=back	451	=back
417		452
418	=head2 Extension Objects	453	=head2 Extension Objects
419		454
420	Every perl extension is a perl class. A separate perl object is created	455	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,	456	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	457	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	458	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	459	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	460	that begin with an underscore character C<_>: these are reserved for
426	internal use.	461	internal use.
…		…
590	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
591		626
592	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	628	suppress or filter tty input.
594		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
595	=item on_line_update $term, $row	637	=item on_line_update $term, $row
596		638
597	Called whenever a line was updated or changed. Can be used to filter	639	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	640	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,	641	that are being shown will be filtered, and, due to performance reasons,
…		…
624	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
625		667
626	The event is simply the action string. This interface is assumed to change	668	The event is simply the action string. This interface is assumed to change
627	slightly in the future.	669	slightly in the future.
628		670
629	=item on_resize_all_windows $tern, $new_width, $new_height	671	=item on_resize_all_windows $term, $new_width, $new_height
630		672
631	Called just after the new window size has been calculated, but before	673	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	674	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	675	returns TRUE, setting of the window hints is being skipped.
634		676
…		…
668		710
669	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
670		712
671	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
672		714
673	Called whenever the corresponding X event is received for the terminal If	715	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.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
675		717
676	The event is a hash with most values as named by Xlib (see the XEvent	718	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	719	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.	720	(real, not screen-based) row and column under the mouse cursor.
679		721
…		…
688		730
689	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
690		732
691	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
693		739
694	=back	740	=back
695		741
696	=cut	742	=cut
697		743
…		…
762		808
763	=over 4	809	=over 4
764		810
765	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
766		812
767	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
770		817
771	=item urxvt::warn $string	818	=item urxvt::warn $string
772		819
773	Calls C<rxvt_warn> with the given string which should not include a	820	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	821	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	822	that calls this function.
776		823
777	Using this function has the advantage that its output ends up in the	824	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.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
783		830
784	Returns all urxvt::term objects that exist in this process, regardless of	831	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	832	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
788		835
789	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
790		837
791	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
792		839
…		…
835		882
836	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
837		884
838	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
839		886
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
841		889
842	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	892	the bitset.
845		893
…		…
927	sub invoke {	975	sub invoke {
928	local $TERM = shift;	976	local $TERM = shift;
929	my $htype = shift;	977	my $htype = shift;
930		978
931	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
933		981
934	my %ext_arg;	982	my %ext_arg;
935		983
936	{	984	{
937	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
…		…
1104	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.	1153	work.
1106		1154
1107	=cut	1155	=cut
1108		1156
1109	our $VERSION = '3.4';	1157	our $VERSION = '5.23';
1110		1158
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1161
1114	sub timer {	1162	sub timer {
…		…
1116		1164
1117	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
1118		1166
1119	urxvt::timer	1167	urxvt::timer
1120	->new	1168	->new
1121	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1124	$cb->();	1172	$cb->();
1125	})	1173	})
1126	}	1174	}
1127		1175
1128	sub io {	1176	sub io {
1129	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1130		1178
1131	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1132		1182
1133	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1134	->new	1184	->new
1135	->fd (fileno $arg{fh})	1185	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1188	->start
1139	->cb (sub {	1189	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
1144	}	1216	}
1145		1217
1146	sub DESTROY {	1218	sub DESTROY {
1147	$_[0][1]->stop;	1219	$_[0][1]->stop;
1148	}	1220	}
1149		1221
		1222	# only needed for AnyEvent < 6 compatibility
1150	sub one_event {	1223	sub one_event {
1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1152	}	1225	}
1153		1226
1154	package urxvt::term;	1227	package urxvt::term;
…		…
1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1247		1320
1248	Here is a likely non-exhaustive list of option names, please see the	1321	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:	1322	source file F</src/optinc.h> to see the actual list:
1250		1323
1251	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1256	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1257		1331
1258	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1259		1333
1260	Returns the current resource value associated with a given name and	1334	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>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1274		1348
1275	Here is a likely non-exhaustive list of resource names, not all of which	1349	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>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1277	to see the actual list:	1351	to see the actual list:
1278		1352
1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1281	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289	secondaryScreen secondaryScroll shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1290	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1291	visualBell	1366	utmpInhibit visualBell
1292		1367
1293	=cut	1368	=cut
1294		1369
1295	sub resource($$;$) {	1370	sub resource($$;$) {
1296	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
…		…
1307		1382
1308	This method should only be called during the C<on_start> hook, as there is	1383	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	1384	only one resource database per display, and later invocations might return
1310	the wrong resources.	1385	the wrong resources.
1311		1386
1312	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1387	=item $success = $term->parse_keysym ($key, $octets)
1313		1388
1314	Adds a keymap translation exactly as specified via a resource. See the	1389	Adds a key binding exactly as specified via a resource. See the
1315	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1390	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1316		1391
1317	=item $rend = $term->rstyle ([$new_rstyle])	1392	=item $rend = $term->rstyle ([$new_rstyle])
1318		1393
1319	Return and optionally change the current rendition. Text that is output by	1394	Return and optionally change the current rendition. Text that is output by
…		…
1328		1403
1329	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1330		1405
1331	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1332		1407
1333	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1334	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1335		1417
1336	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1337		1419
1338	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1339	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1340	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1341	a selection.	1423	a selection.
1342		1424
1343	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344		1426
1345	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	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	1429	with the next method. No visual feedback will be given. This function
1347	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1348		1431
1349	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1350		1433
1351	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352		1440
1353	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1354		1442
1355	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1356		1444
…		…
1484	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1485	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1486		1574
1487	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1488		1576
1489	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	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	1578	pass characters instead of octets, you should convert your strings first
1491	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1492		1586
1493	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1494		1588
1495	Replaces the event mask of the pty watcher by the given event mask. Can	1589	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	1590	be used to suppress input and output handling to the pty/tty. See the
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1905	recent grab.
1812		1906
1813	=item $term->ungrab	1907	=item $term->ungrab
1814		1908
1815	Calls XUngrab for the most recent grab. Is called automatically on	1909	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	1910	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1911	the session.
1818		1912
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1914
…		…
1842		1936
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		1938
1845	Various X or X-related functions. The C<$term> object only serves as	1939	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	1940	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1848		1942
1849	=back	1943	=back
1850		1944
1851	=cut	1945	=cut
1852		1946
…		…
2009		2103
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2105
2012	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
2013		2107
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
2019		2109
2020	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
2021		2112
2022	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
2023		2114
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	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	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
2027		2118
2028	=item $timer = $timer->start	2119	=item $timer = $timer->start
2029		2120
2030	Start the timer.	2121	Start the timer.
2031		2122
2032	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
2033		2124
2034	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
2035		2127
2036	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
2037		2129
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2131
2040	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
2041		2133
…		…
2172		2264
2173	=back	2265	=back
2174		2266
2175	=head1 AUTHOR	2267	=head1 AUTHOR
2176		2268
2177	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2179		2271
2180	=cut	2272	=cut
2181		2273
2182	1	2274	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.201 by sf-exg, Tue Nov 29 19:20:18 2011 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.201 by sf-exg, Tue Nov 29 19:20:18 2011 UTC