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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC vs.
Revision 1.191 by sf-exg, Fri Jan 7 21:55:28 2011 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
71		81
72	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
86		96
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.	100	runtime.
		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		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
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
91		118
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
104	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
130	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
131		189
132	=item selection-autotransform	190	=item selection-autotransform
133		191
134	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.	193	whenever a selection is made.
…		…
162		220
163	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item readline
168
169	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).
174
175	To avoid too many false positives, this is only done when:
176
177	=over 4
178
179	=item - the mouse is on the same (multi-row-) line as the text cursor.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the text cursor is visible.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item tabbed	225	=item tabbed
191		226
192	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195	button per tab.	230	button per tab.
196		231
197	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
198	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
199	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
200		235
201	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
202		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
203	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
204	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
205	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
206	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
207		258
208	=item automove-background	259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
209		263
210	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
211	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213		266
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
215		313
216	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
217		315
218	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.	318	similar-looking ascii character.
221		319
222	=item digital-clock	320	=item digital-clock
223		321
224	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	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
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	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,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
225		391
226	=item example-refresh-hooks	392	=item example-refresh-hooks
227		393
228	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.	396	overlays or changes.
231		397
232	=item selection-pastebin	398	=item confirm-paste
233		399
234	This is a little rarely useful extension that Uploads the selection as	400	Displays a confirmation dialog when a paste containing at least a full
235	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260		402
261	=back	403	=back
262		404
263	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
264		406
…		…
280		422
281	=over 4	423	=over 4
282		424
283	=item $text	425	=item $text
284		426
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
287		429
288	=item $string	430	=item $string
289		431
290	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
298		440
299	=back	441	=back
300		442
301	=head2 Extension Objects	443	=head2 Extension Objects
302		444
303	Very perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
304	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extenion objects,
305	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
306	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
307	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
308	use.	451	internal use.
309		452
310	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
311	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
312		455
313	It has the following methods and data members:	456	It has the following methods and data members:
…		…
334	=head2 Hooks	477	=head2 Hooks
335		478
336	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
337	called whenever the relevant event happens.	480	called whenever the relevant event happens.
338		481
339	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
340	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
341		484
342	B<All> of these hooks must return a boolean value. If any of the called	485	B<All> of these hooks must return a boolean value. If any of the called
343	hooks returns true, then the event counts as being I<consumed>, and the	486	hooks returns true, then the event counts as being I<consumed>, and the
344	relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
…		…
357	place.	500	place.
358		501
359	=item on_start $term	502	=item on_start $term
360		503
361	Called at the very end of initialisation of a new terminal, just before	504	Called at the very end of initialisation of a new terminal, just before
362	trying to map (display) the toplevel and returning to the mainloop.	505	trying to map (display) the toplevel and returning to the main loop.
363		506
364	=item on_destroy $term	507	=item on_destroy $term
365		508
366	Called whenever something tries to destroy terminal, before doing anything	509	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	510	still fully functional (not for long, though).
368	rarely a good idea.
369		511
370	=item on_reset $term	512	=item on_reset $term
371		513
372	Called after the screen is "reset" for any reason, such as resizing or	514	Called after the screen is "reset" for any reason, such as resizing or
373	control sequences. Here is where you can react on changes to size-related	515	control sequences. Here is where you can react on changes to size-related
…		…
395		537
396	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
397	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
398	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
399		541
400	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
401		543
402	=item on_sel_extend $term	544	=item on_sel_extend $term
403		545
404	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
405	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
406	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
407	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
408	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
409	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
410		552
411	See the F<selection> example extension.	553	See the F<selection> example extension.
412		554
413	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
414		556
415	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
416	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	559	show this many lines of scrollback.
418		560
419	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
420		562
…		…
424		566
425	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
426	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
427	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
428		570
429	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
430		582
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
434	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
435	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
436	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
437		599
438	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
439	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
440	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
441		606
442	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
443		608
444	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
445	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
450	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
451		616
452	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
453	suppress or filter tty input.	618	suppress or filter tty input.
454		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
455	=item on_line_update $term, $row	627	=item on_line_update $term, $row
456		628
457	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
458	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
459	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
466	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
467	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
468		640
469	=item on_refresh_begin $term	641	=item on_refresh_begin $term
470		642
471	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
472	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
473	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
474	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
475		647
476	=item on_refresh_end $term	648	=item on_refresh_end $term
477		649
478	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
479		651
480	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
481		653
482	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
483	C<perl:string> action bound to it (see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
484	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
		657
		658	The event is simply the action string. This interface is assumed to change
		659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
485		666
486	=item on_x_event $term, $event	667	=item on_x_event $term, $event
487		668
488	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
489	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
490	members are not passed.	671	members are not passed.
491		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
492	=item on_focus_in $term	677	=item on_focus_in $term
493		678
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	680	does focus in processing.
496		681
497	=item on_focus_out $term	682	=item on_focus_out $term
498		683
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	685	focus out processing.
501		686
502	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
503		688
504	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
515		700
516	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
517		702
518	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
519		704
520	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
521	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
522		707
523	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
524	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
525	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
526		711
…		…
535		720
536	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
537		722
538	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
540		729
541	=back	730	=back
542		731
543	=cut	732	=cut
544		733
…		…
561	our $LIBDIR;	750	our $LIBDIR;
562	our $RESNAME;	751	our $RESNAME;
563	our $RESCLASS;	752	our $RESCLASS;
564	our $RXVTNAME;	753	our $RXVTNAME;
565		754
566	our $NOCHAR = chr 0xfffe;	755	our $NOCHAR = chr 0xffff;
567		756
568	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
569		758
570	=over 4	759	=over 4
571		760
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
589		778
590	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
591		780
592	All coderefs in this array will be called as methods of the next newly	781	All code references in this array will be called as methods of the next newly
593	created C<urxvt::term> object (during the C<on_init> phase). The array	782	created C<urxvt::term> object (during the C<on_init> phase). The array
594	gets cleared before the codereferences that were in it are being executed,	783	gets cleared before the code references that were in it are being executed,
595	so coderefs can push themselves onto it again if they so desire.	784	so references can push themselves onto it again if they so desire.
596		785
597	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
598	first.	787	first.
599		788
600	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
601		790
602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
609		798
610	=over 4	799	=over 4
611		800
612	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
613		802
614	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
615	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
616	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
617		807
618	=item urxvt::warn $string	808	=item urxvt::warn $string
619		809
620	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
621	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
622	that calls this function.	812	that calls this function.
623		813
624	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
625	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
626		816
627	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
		818
		819	=item @terms = urxvt::termlist
		820
		821	Returns all urxvt::term objects that exist in this process, regardless of
		822	whether they are started, being destroyed etc., so be careful. Only term
		823	objects that have perl extensions attached will be returned (because there
		824	is no urxvt::term objet associated with others).
628		825
629	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
630		827
631	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
632		829
…		…
675		872
676	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
677		874
678	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
679		876
680	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
681		879
682	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
683	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
684	the bitset.	882	the bitset.
685		883
…		…
690	Return the foreground/background colour index, respectively.	888	Return the foreground/background colour index, respectively.
691		889
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		891
694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		893
		894	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695		895
696	Replace the foreground/background colour in the rendition mask with the	896	Replace the foreground/background colour in the rendition mask with the
697	specified one.	897	specified one.
698		898
699	=item $value = urxvt::GET_CUSTOM $rend	899	=item $value = urxvt::GET_CUSTOM $rend
…		…
718	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
719	urxvt::warn ($msg);	919	urxvt::warn ($msg);
720	};	920	};
721	}	921	}
722		922
		923	no warnings 'utf8';
		924
723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
724		926
725	sub verbose {	927	sub verbose {
726	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
727	warn "$msg\n" if $level <= $verbosity;	929	warn "$msg\n" if $level <= $verbosity;
…		…
743		945
744	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
745	or die "$path: $!";	947	or die "$path: $!";
746		948
747	my $source =	949	my $source =
748	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
749	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
750	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
751	. "\n};\n1";	953	. "\n};\n1";
752		954
753	eval $source	955	eval $source
…		…
764	local $TERM = shift;	966	local $TERM = shift;
765	my $htype = shift;	967	my $htype = shift;
766		968
767	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
769		971
770	my %ext_arg;	972	my %ext_arg;
771		973
772	{	974	{
773	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
774	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
778	$TERM->register_package ($_) for @pkg;	980	$TERM->register_package ($_) for @pkg;
779	}	981	}
780		982
781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
782	if ($_ eq "default") {	984	if ($_ eq "default") {
783	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
784	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
785	delete $ext_arg{$1};	987	delete $ext_arg{$1};
786	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
787	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
788	} else {	990	} else {
789	$ext_arg{$_} \|\|= [];	991	$ext_arg{$_} \|\|= [];
790	}	992	}
791	}	993	}
792		994
793	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
794	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
795		997
796	if (@files) {	998	if (@files) {
797	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
798	} else {	1000	} else {
799	warn "perl extension '$ext' not found in perl library search path\n";	1001	warn "perl extension '$ext' not found in perl library search path\n";
800	}	1002	}
801	}	1003	}
802		1004
…		…
808		1010
809	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
810	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
811	if $verbosity >= 10;	1013	if $verbosity >= 10;
812		1014
813	keys %$cb;	1015	for my $pkg (keys %$cb) {
814
815	while (my ($pkg, $cb) = each %$cb) {
816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
817	$retval \|\|= $retval_;	1017	$retval \|\|= $retval_;
818		1018
819	if ($@) {	1019	if ($@) {
820	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
821	warn $@;	1021	warn $@;
…		…
833	# clear package	1033	# clear package
834	%$TERM = ();	1034	%$TERM = ();
835	}	1035	}
836		1036
837	$retval	1037	$retval
		1038	}
		1039
		1040	sub SET_COLOR($$$) {
		1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1042	}
		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask \|= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
838	}	1067	}
839		1068
840	# urxvt::term::extension	1069	# urxvt::term::extension
841		1070
842	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
913	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
914	work.	1143	work.
915		1144
916	=cut	1145	=cut
917		1146
918	our $VERSION = 1;	1147	our $VERSION = '5.23';
919		1148
920	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
921	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
922		1151
923	sub timer {	1152	sub timer {
…		…
925		1154
926	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
927		1156
928	urxvt::timer	1157	urxvt::timer
929	->new	1158	->new
930	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
931	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
932	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
933	$cb->();	1162	$cb->();
934	})	1163	})
935	}	1164	}
936		1165
937	sub io {	1166	sub io {
938	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
939		1168
940	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
941		1172
942	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
943	->new	1174	->new
944	->fd (fileno $arg{fh})	1175	->fd ($fd)
945	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
946	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
947	->start	1178	->start
948	->cb (sub {	1179	->cb ($cb)
949	$cb->(($_[1] & 1 ? 'r' : '')
950	. ($_[1] & 2 ? 'w' : ''));
951	})],
952	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
953	}	1206	}
954		1207
955	sub DESTROY {	1208	sub DESTROY {
956	$_[0][1]->stop;	1209	$_[0][1]->stop;
957	}	1210	}
958		1211
959	sub condvar {	1212	sub one_event {
960	bless \my $flag, urxvt::anyevent::condvar::
961	}
962
963	sub urxvt::anyevent::condvar::broadcast {
964	${$_[0]}++;
965	}
966
967	sub urxvt::anyevent::condvar::wait {
968	unless (${$_[0]}) {
969	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
970	}
971	}	1214	}
972		1215
973	package urxvt::term;	1216	package urxvt::term;
974		1217
975	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
1011	hash which defines the environment of the new terminal.	1254	hash which defines the environment of the new terminal.
1012		1255
1013	Croaks (and probably outputs an error message) if the new instance	1256	Croaks (and probably outputs an error message) if the new instance
1014	couldn't be created. Returns C<undef> if the new instance didn't	1257	couldn't be created. Returns C<undef> if the new instance didn't
1015	initialise perl, and the terminal object otherwise. The C<init> and	1258	initialise perl, and the terminal object otherwise. The C<init> and
1016	C<start> hooks will be called during this call.	1259	C<start> hooks will be called before this call returns, and are free to
		1260	refer to global data (which is race free).
1017		1261
1018	=cut	1262	=cut
1019		1263
1020	sub new {	1264	sub new {
1021	my ($class, $env, @args) = @_;	1265	my ($class, $env, @args) = @_;
1022		1266
		1267	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1268	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1269
1023	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1270	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1024	}	1271	}
1025		1272
1026	=item $term->destroy	1273	=item $term->destroy
1027		1274
1028	Destroy the terminal object (close the window, free resources	1275	Destroy the terminal object (close the window, free resources
…		…
1058		1305
1059	Returns true if the option specified by C<$optval> is enabled, and	1306	Returns true if the option specified by C<$optval> is enabled, and
1060	optionally change it. All option values are stored by name in the hash	1307	optionally change it. All option values are stored by name in the hash
1061	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1062		1309
1063	Here is a a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
1064	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
1065		1312
1066	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1085	likely change).	1332	likely change).
1086		1333
1087	Please note that resource strings will currently only be freed when the	1334	Please note that resource strings will currently only be freed when the
1088	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
1089		1336
1090	Here is a a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
1091	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
1092	to see the actual list:	1339	to see the actual list:
1093		1340
1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1095	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1096	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
1097	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1104	secondaryScreen secondaryScroll selectstyle shade term_name title	1351	secondaryScreen secondaryScroll shade term_name title
1105	transient_for transparent transparent_all tripleclickwords utmpInhibit	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
1106	visualBell	1353	visualBell
1107		1354
1108	=cut	1355	=cut
1109		1356
1110	sub resource($$;$) {	1357	sub resource($$;$) {
1111	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
1112	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1113	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
1114	}	1361	}
1115		1362
1116	=item $value = $term->x_resource ($pattern)	1363	=item $value = $term->x_resource ($pattern)
1117		1364
1118	Returns the X-Resource for the given pattern, excluding the program or	1365	Returns the X-Resource for the given pattern, excluding the program or
…		…
1143		1390
1144	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
1145		1392
1146	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
1147		1394
1148	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
1149	and optionally set them to new values.	1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
1150		1404
1151	=item $term->selection_make ($eventtime[, $rectangular])	1405	=item $term->selection_make ($eventtime[, $rectangular])
1152		1406
1153	Tries to make a selection as set by C<selection_beg> and	1407	Tries to make a selection as set by C<selection_beg> and
1154	C<selection_end>. If C<$rectangular> is true (default: false), a	1408	C<selection_end>. If C<$rectangular> is true (default: false), a
1155	rectangular selection will be made. This is the prefered function to make	1409	rectangular selection will be made. This is the preferred function to make
1156	a selection.	1410	a selection.
1157		1411
1158	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1159		1413
1160	Try to request the primary selection text from the server (for example, as	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1415	true) selection from the server. The corresponding text can be set
1161	set by the next method). No visual feedback will be given. This function	1416	with the next method. No visual feedback will be given. This function
1162	is mostly useful from within C<on_sel_grab> hooks.	1417	is mostly useful from within C<on_sel_grab> hooks.
1163		1418
1164	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
1165		1420
1166	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1167		1427
1168	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
1169		1429
1170	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
1171		1431
…		…
1201		1461
1202	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
1203		1463
1204	=over 4	1464	=over 4
1205		1465
1206	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
1207		1467
1208	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1468	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1209	text in rxvt-unicode's special encoding and an array of rendition values	1469	text in rxvt-unicode's special encoding and an array of rendition values
1210	at a specific position inside the overlay.	1470	at a specific position inside the overlay.
		1471
		1472	If C<$rend> is missing, then the rendition will not be changed.
1211		1473
1212	=item $overlay->hide	1474	=item $overlay->hide
1213		1475
1214	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
1215		1477
…		…
1297	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1298	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1299		1561
1300	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1301		1563
1302	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1303	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
1304	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1305		1573
1306	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1307		1575
1308	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1309	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
1310	description of C<< urxvt::timer->events >>. Make sure to always restore	1578	description of C<< urxvt::timer->events >>. Make sure to always restore
1311	the previous value.	1579	the previous value.
1312		1580
		1581	=item $fd = $term->pty_fd
		1582
		1583	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1584	is used.
		1585
1313	=item $windowid = $term->parent	1586	=item $windowid = $term->parent
1314		1587
1315	Return the window id of the toplevel window.	1588	Return the window id of the toplevel window.
1316		1589
1317	=item $windowid = $term->vt	1590	=item $windowid = $term->vt
…		…
1323	Adds the specified events to the vt event mask. Useful e.g. when you want	1596	Adds the specified events to the vt event mask. Useful e.g. when you want
1324	to receive pointer events all the times:	1597	to receive pointer events all the times:
1325		1598
1326	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
1327		1600
		1601	=item $term->focus_in
		1602
		1603	=item $term->focus_out
		1604
		1605	=item $term->key_press ($state, $keycode[, $time])
		1606
		1607	=item $term->key_release ($state, $keycode[, $time])
		1608
		1609	Deliver various fake events to to terminal.
		1610
1328	=item $window_width = $term->width	1611	=item $window_width = $term->width
1329		1612
1330	=item $window_height = $term->height	1613	=item $window_height = $term->height
1331		1614
1332	=item $font_width = $term->fwidth	1615	=item $font_width = $term->fwidth
…		…
1362	=item $env = $term->env	1645	=item $env = $term->env
1363		1646
1364	Returns a copy of the environment in effect for the terminal as a hashref	1647	Returns a copy of the environment in effect for the terminal as a hashref
1365	similar to C<\%ENV>.	1648	similar to C<\%ENV>.
1366		1649
		1650	=item @envv = $term->envv
		1651
		1652	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1653
		1654	=item @argv = $term->argv
		1655
		1656	Return the argument vector as this terminal, similar to @ARGV, but
		1657	includes the program name as first element.
		1658
1367	=cut	1659	=cut
1368		1660
1369	sub env {	1661	sub env {
1370	if (my $env = $_[0]->_env) {
1371	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1662	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1372	} else {
1373	+{ %ENV }
1374	}
1375	}	1663	}
1376		1664
1377	=item $modifiermask = $term->ModLevel3Mask	1665	=item $modifiermask = $term->ModLevel3Mask
1378		1666
1379	=item $modifiermask = $term->ModMetaMask	1667	=item $modifiermask = $term->ModMetaMask
…		…
1387		1675
1388	Returns the currently displayed screen (0 primary, 1 secondary).	1676	Returns the currently displayed screen (0 primary, 1 secondary).
1389		1677
1390	=item $cursor_is_hidden = $term->hidden_cursor	1678	=item $cursor_is_hidden = $term->hidden_cursor
1391		1679
1392	Returns wether the cursor is currently hidden or not.	1680	Returns whether the cursor is currently hidden or not.
1393		1681
1394	=item $view_start = $term->view_start ([$newvalue])	1682	=item $view_start = $term->view_start ([$newvalue])
1395		1683
1396	Returns the row number of the topmost displayed line. Maximum value is	1684	Returns the row number of the topmost displayed line. Maximum value is
1397	C<0>, which displays the normal terminal contents. Lower values scroll	1685	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1405		1693
1406	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1407		1695
1408	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1409		1697
1410	Returns the text of the entire row with number C<$row_number>. Row C<0>	1698	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1411	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1699	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1412	terminal line. The scrollback buffer starts at line C<-1> and extends to
1413	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1414	is requested.	1701	is requested.
1415		1702
1416	If C<$new_text> is specified, it will replace characters in the current	1703	If C<$new_text> is specified, it will replace characters in the current
1417	line, starting at column C<$start_col> (default C<0>), which is useful	1704	line, starting at column C<$start_col> (default C<0>), which is useful
1418	to replace only parts of a line. The font index in the rendition will	1705	to replace only parts of a line. The font index in the rendition will
1419	automatically be updated.	1706	automatically be updated.
1420		1707
1421	C<$text> is in a special encoding: tabs and wide characters that use	1708	C<$text> is in a special encoding: tabs and wide characters that use more
1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1709	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1423	characters. Characters with combining characters and other characters that	1710	characters. Characters with combining characters and other characters that
1424	do not fit into the normal tetx encoding will be replaced with characters	1711	do not fit into the normal text encoding will be replaced with characters
1425	in the private use area.	1712	in the private use area.
1426		1713
1427	You have to obey this encoding when changing text. The advantage is	1714	You have to obey this encoding when changing text. The advantage is
1428	that C<substr> and similar functions work on screen cells and not on	1715	that C<substr> and similar functions work on screen cells and not on
1429	characters.	1716	characters.
…		…
1574	where one character corresponds to one screen cell. See	1861	where one character corresponds to one screen cell. See
1575	C<< $term->ROW_t >> for details.	1862	C<< $term->ROW_t >> for details.
1576		1863
1577	=item $string = $term->special_decode $text	1864	=item $string = $term->special_decode $text
1578		1865
1579	Converts rxvt-unicodes text reprsentation into a perl string. See	1866	Converts rxvt-unicodes text representation into a perl string. See
1580	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1581		1868
1582	=item $success = $term->grab_button ($button, $modifiermask)	1869	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1583		1870
		1871	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1872
1584	Registers a synchronous button grab. See the XGrabButton manpage.	1873	Register/unregister a synchronous button grab. See the XGrabButton
		1874	manpage.
1585		1875
1586	=item $success = $term->grab ($eventtime[, $sync])	1876	=item $success = $term->grab ($eventtime[, $sync])
1587		1877
1588	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1878	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1589	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1879	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1590		1880
1591	=item $term->allow_events_async	1881	=item $term->allow_events_async
1592		1882
1593	Calls XAllowEvents with AsyncBoth for the most recent grab.	1883	Calls XAllowEvents with AsyncBoth for the most recent grab.
1594		1884
…		…
1601	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1602	recent grab.	1892	recent grab.
1603		1893
1604	=item $term->ungrab	1894	=item $term->ungrab
1605		1895
1606	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1607	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1608	the session.	1898	the session.
1609		1899
1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1611		1901
…		…
1613		1903
1614	=item @atoms = $term->XListProperties ($window)	1904	=item @atoms = $term->XListProperties ($window)
1615		1905
1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1906	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1617		1907
1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1908	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1619		1909
1620	=item $term->XDeleteProperty ($window, $property)	1910	=item $term->XDeleteProperty ($window, $property)
1621		1911
1622	=item $window = $term->DefaultRootWindow	1912	=item $window = $term->DefaultRootWindow
1623		1913
…		…
1633		1923
1634	=item $term->XChangeInput ($window, $add_events[, $del_events])	1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
1635		1925
1636	Various X or X-related functions. The C<$term> object only serves as	1926	Various X or X-related functions. The C<$term> object only serves as
1637	the source of the display, otherwise those functions map more-or-less	1927	the source of the display, otherwise those functions map more-or-less
1638	directory onto the X functions of the same name.	1928	directly onto the X functions of the same name.
1639		1929
1640	=back	1930	=back
1641		1931
1642	=cut	1932	=cut
1643		1933
…		…
1707	my ($self, $text, $cb) = @_;	1997	my ($self, $text, $cb) = @_;
1708		1998
1709	$self->add_item ({ type => "button", text => $text, activate => $cb});	1999	$self->add_item ({ type => "button", text => $text, activate => $cb});
1710	}	2000	}
1711		2001
1712	=item $popup->add_toggle ($text, $cb, $initial_value)	2002	=item $popup->add_toggle ($text, $initial_value, $cb)
1713		2003
1714	Adds a toggle/checkbox item to the popup. Teh callback gets called	2004	Adds a toggle/checkbox item to the popup. The callback gets called
1715	whenever it gets toggled, with a boolean indicating its value as its first	2005	whenever it gets toggled, with a boolean indicating its new value as its
1716	argument.	2006	first argument.
1717		2007
1718	=cut	2008	=cut
1719		2009
1720	sub add_toggle {	2010	sub add_toggle {
1721	my ($self, $text, $cb, $value) = @_;	2011	my ($self, $text, $value, $cb) = @_;
1722		2012
1723	my $item; $item = {	2013	my $item; $item = {
1724	type => "button",	2014	type => "button",
1725	text => " $text",	2015	text => " $text",
1726	value => $value,	2016	value => $value,
…		…
1745	my $env = $self->{term}->env;	2035	my $env = $self->{term}->env;
1746	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2036	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1747	delete $env->{LC_ALL};	2037	delete $env->{LC_ALL};
1748	$env->{LC_CTYPE} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1749		2039
1750	urxvt::term->new ($env, "popup",	2040	my $term = urxvt::term->new (
		2041	$env, "popup",
1751	"--perl-lib" => "", "--perl-ext-common" => "",	2042	"--perl-lib" => "", "--perl-ext-common" => "",
1752	"-pty-fd" => -1, "-sl" => 0,	2043	"-pty-fd" => -1, "-sl" => 0,
1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2044	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1754	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1755	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1756	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1757	or die "unable to create popup window\n";	2048	) or die "unable to create popup window\n";
		2049
		2050	unless (delete $term->{urxvt_popup_init_done}) {
		2051	$term->ungrab;
		2052	$term->destroy;
		2053	die "unable to initialise popup window\n";
		2054	}
1758	}	2055	}
1759		2056
1760	sub DESTROY {	2057	sub DESTROY {
1761	my ($self) = @_;	2058	my ($self) = @_;
1762		2059
…		…
1767	=back	2064	=back
1768		2065
1769	=cut	2066	=cut
1770		2067
1771	package urxvt::watcher;	2068	package urxvt::watcher;
1772
1773	@urxvt::timer::ISA = __PACKAGE__;
1774	@urxvt::iow::ISA = __PACKAGE__;
1775	@urxvt::pw::ISA = __PACKAGE__;
1776	@urxvt::iw::ISA = __PACKAGE__;
1777		2069
1778	=head2 The C<urxvt::timer> Class	2070	=head2 The C<urxvt::timer> Class
1779		2071
1780	This class implements timer watchers/events. Time is represented as a	2072	This class implements timer watchers/events. Time is represented as a
1781	fractional number of seconds since the epoch. Example:	2073	fractional number of seconds since the epoch. Example:
…		…
1785	->new	2077	->new
1786	->interval (1)	2078	->interval (1)
1787	->cb (sub {	2079	->cb (sub {
1788	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1789	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1790	});	2082	});
1791		2083
1792	=over 4	2084	=over 4
1793		2085
1794	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
1795		2087
…		…
1798		2090
1799	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1800		2092
1801	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
1802		2094
1803	=item $tstamp = $timer->at
1804
1805	Return the time this watcher will fire next.
1806
1807	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
1808		2096
1809	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
1810		2099
1811	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
1812		2101
1813	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
1814	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
1815	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
1816		2105
1817	=item $timer = $timer->start	2106	=item $timer = $timer->start
1818		2107
1819	Start the timer.	2108	Start the timer.
1820		2109
1821	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
1822		2111
1823	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
1824		2114
1825	=item $timer = $timer->after ($delay)	2115	=item $timer = $timer->after ($delay[, $interval])
1826		2116
1827	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1828		2118
1829	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
1830		2120
…		…
1838		2128
1839	$term->{socket} = ...	2129	$term->{socket} = ...
1840	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
1841	->new	2131	->new
1842	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
1843	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
1844	->start	2134	->start
1845	->cb (sub {	2135	->cb (sub {
1846	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
1847	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
1848	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
1861	Set the callback to be called when io events are triggered. C<$reventmask>	2151	Set the callback to be called when io events are triggered. C<$reventmask>
1862	is a bitset as described in the C<events> method.	2152	is a bitset as described in the C<events> method.
1863		2153
1864	=item $iow = $iow->fd ($fd)	2154	=item $iow = $iow->fd ($fd)
1865		2155
1866	Set the filedescriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
1867		2157
1868	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
1869		2159
1870	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
1871	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2161	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1872	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
1873		2163
1874	=item $iow = $iow->start	2164	=item $iow = $iow->start
1875		2165
1876	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
1877		2167
1878	=item $iow = $iow->stop	2168	=item $iow = $iow->stop
1879		2169
1880	Stop watching for events on the given filehandle.	2170	Stop watching for events on the given file handle.
1881		2171
1882	=back	2172	=back
1883		2173
1884	=head2 The C<urxvt::iw> Class	2174	=head2 The C<urxvt::iw> Class
1885		2175
…		…
1918	->new	2208	->new
1919	->start ($pid)	2209	->start ($pid)
1920	->cb (sub {	2210	->cb (sub {
1921	my ($pw, $exit_status) = @_;	2211	my ($pw, $exit_status) = @_;
1922	...	2212	...
1923	});	2213	});
1924		2214
1925	=over 4	2215	=over 4
1926		2216
1927	=item $pw = new urxvt::pw	2217	=item $pw = new urxvt::pw
1928		2218
…		…
1932		2222
1933	Set the callback to be called when the timer triggers.	2223	Set the callback to be called when the timer triggers.
1934		2224
1935	=item $pw = $timer->start ($pid)	2225	=item $pw = $timer->start ($pid)
1936		2226
1937	Tells the wqtcher to start watching for process C<$pid>.	2227	Tells the watcher to start watching for process C<$pid>.
1938		2228
1939	=item $pw = $pw->stop	2229	=item $pw = $pw->stop
1940		2230
1941	Stop the watcher.	2231	Stop the watcher.
1942		2232
…		…
1955		2245
1956	=item >= 3 - script loading and management	2246	=item >= 3 - script loading and management
1957		2247
1958	=item >=10 - all called hooks	2248	=item >=10 - all called hooks
1959		2249
1960	=item >=11 - hook reutrn values	2250	=item >=11 - hook return values
1961		2251
1962	=back	2252	=back
1963		2253
1964	=head1 AUTHOR	2254	=head1 AUTHOR
1965		2255
…		…
1967	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
1968		2258
1969	=cut	2259	=cut
1970		2260
1971	1	2261	1
		2262
		2263	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC vs. Revision 1.191 by sf-exg, Fri Jan 7 21:55:28 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC vs.
Revision 1.191 by sf-exg, Fri Jan 7 21:55:28 2011 UTC