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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 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
…		…
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343		345
344	=item selection-pastebin	346	=item selection-pastebin
345		347
346	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
347	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
348	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
349	F</tmp> directly.).	351	F</tmp> directly.).
350		352
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
370		372
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372		374
373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
375	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
376	or not.	378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
377		393
378	=item example-refresh-hooks	394	=item example-refresh-hooks
379		395
380	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
381	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
382	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
383		412
384	=back	413	=back
385		414
386	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
387		416
…		…
403		432
404	=over 4	433	=over 4
405		434
406	=item $text	435	=item $text
407		436
408	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
409	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
410		439
411	=item $string	440	=item $string
412		441
413	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
417	=item $octets	446	=item $octets
418		447
419	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
420	locale-specific way.	449	locale-specific way.
421		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
422	=back	457	=back
423		458
424	=head2 Extension Objects	459	=head2 Extension Objects
425		460
426	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
427	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
428	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
429	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
430	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
431	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
432	internal use.	467	internal use.
…		…
596	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
597		632
598	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
599	suppress or filter tty input.	634	suppress or filter tty input.
600		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
601	=item on_line_update $term, $row	643	=item on_line_update $term, $row
602		644
603	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
604	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
605	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
630	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
631		673
632	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
633	slightly in the future.	675	slightly in the future.
634		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
635	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
636		685
637	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
638	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
639	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
640		689
…		…
674		723
675	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
676		725
677	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
678		727
679	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
680	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
681		730
682	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
683	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
684	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
685		734
…		…
694		743
695	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
696		745
697	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
698	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
699		752
700	=back	753	=back
701		754
702	=cut	755	=cut
703		756
…		…
768		821
769	=over 4	822	=over 4
770		823
771	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
772		825
773	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
774	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
775	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
776		830
777	=item urxvt::warn $string	831	=item urxvt::warn $string
778		832
779	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
780	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
781	that calls this function.	835	that calls this function.
782		836
783	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
784	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
788	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
789		843
790	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
791	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
792	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
793	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
794		848
795	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
796		850
797	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
798		852
…		…
841		895
842	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
843		897
844	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
845		899
846	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
847		902
848	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
849	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
850	the bitset.	905	the bitset.
851		906
…		…
933	sub invoke {	988	sub invoke {
934	local $TERM = shift;	989	local $TERM = shift;
935	my $htype = shift;	990	my $htype = shift;
936		991
937	if ($htype == 0) { # INIT	992	if ($htype == 0) { # INIT
938	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	993	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
939		994
940	my %ext_arg;	995	my %ext_arg;
941		996
942	{	997	{
943	my @init = @TERM_INIT;	998	my @init = @TERM_INIT;
…		…
1110	is that you cannot use blocking APIs, but the non-blocking variant should	1165	is that you cannot use blocking APIs, but the non-blocking variant should
1111	work.	1166	work.
1112		1167
1113	=cut	1168	=cut
1114		1169
1115	our $VERSION = '3.4';	1170	our $VERSION = '5.23';
1116		1171
1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1172	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1173	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119		1174
1120	sub timer {	1175	sub timer {
…		…
1122		1177
1123	my $cb = $arg{cb};	1178	my $cb = $arg{cb};
1124		1179
1125	urxvt::timer	1180	urxvt::timer
1126	->new	1181	->new
1127	->start (urxvt::NOW + $arg{after})	1182	->after ($arg{after}, $arg{interval})
1128	->cb (sub {	1183	->cb ($arg{interval} ? $cb : sub {
1129	$_[0]->stop; # need to cancel manually	1184	$_[0]->stop; # need to cancel manually
1130	$cb->();	1185	$cb->();
1131	})	1186	})
1132	}	1187	}
1133		1188
1134	sub io {	1189	sub io {
1135	my ($class, %arg) = @_;	1190	my ($class, %arg) = @_;
1136		1191
1137	my $cb = $arg{cb};	1192	my $cb = $arg{cb};
		1193	my $fd = fileno $arg{fh};
		1194	defined $fd or $fd = $arg{fh};
1138		1195
1139	bless [$arg{fh}, urxvt::iow	1196	bless [$arg{fh}, urxvt::iow
1140	->new	1197	->new
1141	->fd (fileno $arg{fh})	1198	->fd ($fd)
1142	->events (($arg{poll} =~ /r/ ? 1 : 0)	1199	->events (($arg{poll} =~ /r/ ? 1 : 0)
1143	\| ($arg{poll} =~ /w/ ? 2 : 0))	1200	\| ($arg{poll} =~ /w/ ? 2 : 0))
1144	->start	1201	->start
1145	->cb (sub {	1202	->cb ($cb)
1146	$cb->(($_[1] & 1 ? 'r' : '')
1147	. ($_[1] & 2 ? 'w' : ''));
1148	})],
1149	urxvt::anyevent::	1203	], urxvt::anyevent::
		1204	}
		1205
		1206	sub idle {
		1207	my ($class, %arg) = @_;
		1208
		1209	my $cb = $arg{cb};
		1210
		1211	urxvt::iw
		1212	->new
		1213	->start
		1214	->cb ($cb)
		1215	}
		1216
		1217	sub child {
		1218	my ($class, %arg) = @_;
		1219
		1220	my $cb = $arg{cb};
		1221
		1222	urxvt::pw
		1223	->new
		1224	->start ($arg{pid})
		1225	->cb (sub {
		1226	$_[0]->stop; # need to cancel manually
		1227	$cb->($_[0]->rpid, $_[0]->rstatus);
		1228	})
1150	}	1229	}
1151		1230
1152	sub DESTROY {	1231	sub DESTROY {
1153	$_[0][1]->stop;	1232	$_[0][1]->stop;
1154	}	1233	}
1155		1234
		1235	# only needed for AnyEvent < 6 compatibility
1156	sub one_event {	1236	sub one_event {
1157	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1237	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1158	}	1238	}
1159		1239
1160	package urxvt::term;	1240	package urxvt::term;
…		…
1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1332	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1253		1333
1254	Here is a likely non-exhaustive list of option names, please see the	1334	Here is a likely non-exhaustive list of option names, please see the
1255	source file F</src/optinc.h> to see the actual list:	1335	source file F</src/optinc.h> to see the actual list:
1256		1336
1257	borderLess console cursorBlink cursorUnderline hold iconic insecure	1337	borderLess buffered console cursorBlink cursorUnderline hold iconic
1258	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1338	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1339	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1260	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1340	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1261	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1341	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1262	transparent tripleclickwords utmpInhibit visualBell	1342	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1343	urgentOnBell utmpInhibit visualBell
1263		1344
1264	=item $value = $term->resource ($name[, $newval])	1345	=item $value = $term->resource ($name[, $newval])
1265		1346
1266	Returns the current resource value associated with a given name and	1347	Returns the current resource value associated with a given name and
1267	optionally sets a new value. Setting values is most useful in the C<init>	1348	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1280		1361
1281	Here is a likely non-exhaustive list of resource names, not all of which	1362	Here is a likely non-exhaustive list of resource names, not all of which
1282	are supported in every build, please see the source file F</src/rsinc.h>	1363	are supported in every build, please see the source file F</src/rsinc.h>
1283	to see the actual list:	1364	to see the actual list:
1284		1365
1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1366	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1367	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1287	display_name embed ext_bwidth fade font geometry hold iconName	1368	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1369	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1370	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1371	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1372	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1373	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1374	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1375	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1376	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295	secondaryScreen secondaryScroll shade term_name title	1377	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1296	transient_for transparent transparent_all tripleclickwords utmpInhibit	1378	term_name title transient_for transparent tripleclickwords urgentOnBell
1297	visualBell	1379	utmpInhibit visualBell
1298		1380
1299	=cut	1381	=cut
1300		1382
1301	sub resource($$;$) {	1383	sub resource($$;$) {
1302	my ($self, $name) = (shift, shift);	1384	my ($self, $name) = (shift, shift);
…		…
1313		1395
1314	This method should only be called during the C<on_start> hook, as there is	1396	This method should only be called during the C<on_start> hook, as there is
1315	only one resource database per display, and later invocations might return	1397	only one resource database per display, and later invocations might return
1316	the wrong resources.	1398	the wrong resources.
1317		1399
1318	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1400	=item $success = $term->parse_keysym ($key, $octets)
1319		1401
1320	Adds a keymap translation exactly as specified via a resource. See the	1402	Adds a key binding exactly as specified via a resource. See the
1321	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1403	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1404
		1405	=item $term->register_command ($keysym, $modifiermask, $string)
		1406
		1407	Adds a key binding. This is a lower level api compared to
		1408	C<parse_keysym>, as it expects a parsed key description, and can be
		1409	used only inside either the C<on_init> hook, to add a binding, or the
		1410	C<on_register_command> hook, to modify a parsed binding.
1322		1411
1323	=item $rend = $term->rstyle ([$new_rstyle])	1412	=item $rend = $term->rstyle ([$new_rstyle])
1324		1413
1325	Return and optionally change the current rendition. Text that is output by	1414	Return and optionally change the current rendition. Text that is output by
1326	the terminal application will use this style.	1415	the terminal application will use this style.
…		…
1334		1423
1335	=item ($row, $col) = $term->selection_beg ([$row, $col])	1424	=item ($row, $col) = $term->selection_beg ([$row, $col])
1336		1425
1337	=item ($row, $col) = $term->selection_end ([$row, $col])	1426	=item ($row, $col) = $term->selection_end ([$row, $col])
1338		1427
1339	Return the current values of the selection mark, begin or end positions,	1428	Return the current values of the selection mark, begin or end positions.
1340	and optionally set them to new values.	1429
		1430	When arguments are given, then the selection coordinates are set to
		1431	C<$row> and C<$col>, and the selection screen is set to the current
		1432	screen.
		1433
		1434	=item $screen = $term->selection_screen ([$screen])
		1435
		1436	Returns the current selection screen, and then optionally sets it.
1341		1437
1342	=item $term->selection_make ($eventtime[, $rectangular])	1438	=item $term->selection_make ($eventtime[, $rectangular])
1343		1439
1344	Tries to make a selection as set by C<selection_beg> and	1440	Tries to make a selection as set by C<selection_beg> and
1345	C<selection_end>. If C<$rectangular> is true (default: false), a	1441	C<selection_end>. If C<$rectangular> is true (default: false), a
1346	rectangular selection will be made. This is the prefered function to make	1442	rectangular selection will be made. This is the preferred function to make
1347	a selection.	1443	a selection.
1348		1444
1349	=item $success = $term->selection_grab ($eventtime)	1445	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350		1446
1351	Try to request the primary selection text from the server (for example, as	1447	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1448	true) selection from the server. The corresponding text can be set
1352	set by the next method). No visual feedback will be given. This function	1449	with the next method. No visual feedback will be given. This function
1353	is mostly useful from within C<on_sel_grab> hooks.	1450	is mostly useful from within C<on_sel_grab> hooks.
1354		1451
1355	=item $oldtext = $term->selection ([$newtext])	1452	=item $oldtext = $term->selection ([$newtext, $clipboard])
1356		1453
1357	Return the current selection text and optionally replace it by C<$newtext>.	1454	Return the current selection (clipboard if C<$clipboard> is true) text
		1455	and optionally replace it by C<$newtext>.
		1456
		1457	=item $term->selection_clear ([$clipboard])
		1458
		1459	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358		1460
1359	=item $term->overlay_simple ($x, $y, $text)	1461	=item $term->overlay_simple ($x, $y, $text)
1360		1462
1361	Create a simple multi-line overlay box. See the next method for details.	1463	Create a simple multi-line overlay box. See the next method for details.
1362		1464
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1592	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1593	(escape codes) that will be interpreted.
1492		1594
1493	=item $term->tt_write ($octets)	1595	=item $term->tt_write ($octets)
1494		1596
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1597	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1598	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1599	to the locale-specific encoding using C<< $term->locale_encode >>.
		1600
		1601	=item $term->tt_paste ($octets)
		1602
		1603	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1604	CR and bracketing the data with control sequences if bracketed paste mode
		1605	is set.
1498		1606
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1607	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1608
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1609	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1610	be used to suppress input and output handling to the pty/tty. See the
…		…
1816	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1924	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817	recent grab.	1925	recent grab.
1818		1926
1819	=item $term->ungrab	1927	=item $term->ungrab
1820		1928
1821	Calls XUngrab for the most recent grab. Is called automatically on	1929	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822	evaluation errors, as it is better to lose the grab in the error case as	1930	evaluation errors, as it is better to lose the grab in the error case as
1823	the session.	1931	the session.
1824		1932
1825	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1933	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826		1934
…		…
1846		1954
1847	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1955	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1848		1956
1849	=item $term->XChangeInput ($window, $add_events[, $del_events])	1957	=item $term->XChangeInput ($window, $add_events[, $del_events])
1850		1958
		1959	=item $keysym = $term->XStringToKeysym ($string)
		1960
		1961	=item $string = $term->XKeysymToString ($keysym)
		1962
1851	Various X or X-related functions. The C<$term> object only serves as	1963	Various X or X-related functions. The C<$term> object only serves as
1852	the source of the display, otherwise those functions map more-or-less	1964	the source of the display, otherwise those functions map more-or-less
1853	directory onto the X functions of the same name.	1965	directly onto the X functions of the same name.
1854		1966
1855	=back	1967	=back
1856		1968
1857	=cut	1969	=cut
1858		1970
…		…
2015		2127
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2128	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2129
2018	Set the callback to be called when the timer triggers.	2130	Set the callback to be called when the timer triggers.
2019		2131
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2132	=item $timer = $timer->set ($tstamp[, $interval])
2025		2133
2026	Set the time the event is generated to $tstamp.	2134	Set the time the event is generated to $tstamp (and optionally specifies a
		2135	new $interval).
2027		2136
2028	=item $timer = $timer->interval ($interval)	2137	=item $timer = $timer->interval ($interval)
2029		2138
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2139	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2140	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2141	is automatically rescheduled at the given intervals.
2033		2142
2034	=item $timer = $timer->start	2143	=item $timer = $timer->start
2035		2144
2036	Start the timer.	2145	Start the timer.
2037		2146
2038	=item $timer = $timer->start ($tstamp)	2147	=item $timer = $timer->start ($tstamp[, $interval])
2039		2148
2040	Set the event trigger time to C<$tstamp> and start the timer.	2149	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2150	also replaces the interval.
2041		2151
2042	=item $timer = $timer->after ($delay)	2152	=item $timer = $timer->after ($delay[, $interval])
2043		2153
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2154	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2155
2046	=item $timer = $timer->stop	2156	=item $timer = $timer->stop
2047		2157
…		…
2178		2288
2179	=back	2289	=back
2180		2290
2181	=head1 AUTHOR	2291	=head1 AUTHOR
2182		2292
2183	Marc Lehmann <pcg@goof.com>	2293	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2294	http://software.schmorp.de/pkg/rxvt-unicode
2185		2295
2186	=cut	2296	=cut
2187		2297
2188	1	2298	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs. Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC