ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 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 "vars"' 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	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be vewiwed
		38	using F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	laoded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	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
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item automove-background
265
266	This is basically a very small extension that dynamically changes the
267	background pixmap offset to the window position, in effect creating the
268	same effect as pseudo transparency with a custom pixmap. No scaling is
269	supported in this mode. Exmaple:
270
271	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
272
273	=item block-graphics-to-ascii
274
275	A not very useful example of filtering all text output to the terminal
276	by replacing all line-drawing characters (U+2500 .. U+259F) by a
277	similar-looking ascii character.
278
279	=item digital-clock
280
281	Displays a digital clock using the built-in overlay.
282
283	=item remote-clipboard
284
285	Somewhat of a misnomer, this extension adds two menu entries to the
286	selection popup that allows one ti run external commands to store the
287	selection somewhere and fetch it again.
288
289	We use it to implement a "distributed selection mechanism", which just
290	means that one command uploads the file to a remote server, and another
291	reads it.
292
293	The commands can be set using the C<URxvt.remote-selection.store> and
294	C<URxvt.remote-selection.fetch> resources. The first should read the
295	selection to store from STDIN (always in UTF-8), the second should provide
296	the selection data on STDOUT (also in UTF-8).
297
298	The defaults (which are likely useless to you) use rsh and cat:
299
300	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302
303	=item selection-pastebin
304
305	This is a little rarely useful extension that Uploads the selection as
306	textfile to a remote site (or does other things). (The implementation is
307	not currently secure for use in a multiuser environment as it writes to
308	F</tmp> directly.).
309
310	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
311	i.e.
312
313	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
314
315	Pressing this combination runs a command with C<%> replaced by the name of
316	the textfile. This command can be set via a resource:
317
318	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
319
320	And the default is likely not useful to anybody but the few people around
321	here :)
322
323	The name of the textfile is the hex encoded md5 sum of the selection, so
324	the same content should lead to the same filename.
325
326	After a successful upload the selection will be replaced by the text given
327	in the C<selection-pastebin-url> resource (again, the % is the placeholder
328	for the filename):
329
330	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331
332	=item example-refresh-hooks
333
334	Displays a very simple digital clock in the upper right corner of the
335	window. Illustrates overwriting the refresh callbacks to create your own
336	overlays or changes.
337
338	=back
339		50
340	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
341		52
342	=head2 General API Considerations	53	=head2 General API Considerations
343		54
…		…
357		68
358	=over 4	69	=over 4
359		70
360	=item $text	71	=item $text
361		72
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
363	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
364		75
365	=item $string	76	=item $string
366		77
367	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
371	=item $octets	82	=item $octets
372		83
373	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
374	locale-specific way.	85	locale-specific way.
375		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
376	=back	93	=back
377		94
378	=head2 Extension Objects	95	=head2 Extension Objects
379		96
380	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
381	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
382	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
383	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
384	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
385	use.	103	internal use.
386		104
387	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
388	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
389		107
390	It has the following methods and data members:	108	It has the following methods and data members:
…		…
411	=head2 Hooks	129	=head2 Hooks
412		130
413	The following subroutines can be declared in extension files, and will be	131	The following subroutines can be declared in extension files, and will be
414	called whenever the relevant event happens.	132	called whenever the relevant event happens.
415		133
416	The first argument passed to them is an extension oject as described in	134	The first argument passed to them is an extension object as described in
417	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
418		136
419	B<All> of these hooks must return a boolean value. If any of the called	137	B<All> of these hooks must return a boolean value. If any of the called
420	hooks returns true, then the event counts as being I<consumed>, and the	138	hooks returns true, then the event counts as being I<consumed>, and the
421	relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
…		…
434	place.	152	place.
435		153
436	=item on_start $term	154	=item on_start $term
437		155
438	Called at the very end of initialisation of a new terminal, just before	156	Called at the very end of initialisation of a new terminal, just before
439	trying to map (display) the toplevel and returning to the mainloop.	157	trying to map (display) the toplevel and returning to the main loop.
440		158
441	=item on_destroy $term	159	=item on_destroy $term
442		160
443	Called whenever something tries to destroy terminal, when the terminal is	161	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	162	still fully functional (not for long, though).
…		…
471		189
472	Called whenever a selection has been copied, but before the selection is	190	Called whenever a selection has been copied, but before the selection is
473	requested from the server. The selection text can be queried and changed	191	requested from the server. The selection text can be queried and changed
474	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
475		193
476	Returning a true value aborts selection grabbing. It will still be hilighted.	194	Returning a true value aborts selection grabbing. It will still be highlighted.
477		195
478	=item on_sel_extend $term	196	=item on_sel_extend $term
479		197
480	Called whenever the user tries to extend the selection (e.g. with a double	198	Called whenever the user tries to extend the selection (e.g. with a double
481	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
482	should extend the selection itelf and return true to suppress the built-in	200	should extend the selection itself and return true to suppress the built-in
483	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
484	returns true, it will be called on every further click by the user and is	202	returns true, it will be called on every further click by the user and is
485	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
486		204
487	See the F<selection> example extension.	205	See the F<selection> example extension.
488		206
489	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
490		208
491	Called whenever the view offset changes, i..e the user or program	209	Called whenever the view offset changes, i.e. the user or program
492	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	211	show this many lines of scrollback.
494		212
495	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
496		214
…		…
500		218
501	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	219	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
502	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	220	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
503	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
504		222
505	=item on_osc_seq $term, $op, $args	223	=item on_osc_seq $term, $op, $args, $resp
506		224
507	Called on every OSC sequence and can be used to suppress it or modify its	225	Called on every OSC sequence and can be used to suppress it or modify its
508	behaviour. The default should be to return an empty list. A true value	226	behaviour. The default should be to return an empty list. A true value
509	suppresses execution of the request completely. Make sure you don't get	227	suppresses execution of the request completely. Make sure you don't get
510	confused by recursive invocations when you output an osc sequence within	228	confused by recursive invocations when you output an OSC sequence within
511	this callback.	229	this callback.
512		230
513	C<on_osc_seq_perl> should be used for new behaviour.	231	C<on_osc_seq_perl> should be used for new behaviour.
514		232
515	=item on_osc_seq_perl $term, $string	233	=item on_osc_seq_perl $term, $args, $resp
516		234
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
520	string should start with the extension name and a colon, to distinguish	238	string should start with the extension name (sans -osc) and a semicolon,
521	it from commands for other extensions, and this might be enforced in the	239	to distinguish it from commands for other extensions, and this might be
522	future.	240	enforced in the future.
		241
		242	For example, C<overlay-osc> uses this:
		243
		244	sub on_osc_seq_perl {
		245	my ($self, $osc, $resp) = @_;
		246
		247	return unless $osc =~ s/^overlay;//;
		248
		249	... process remaining $osc string
		250	}
523		251
524	Be careful not ever to trust (in a security sense) the data you receive,	252	Be careful not ever to trust (in a security sense) the data you receive,
525	as its source can not easily be controleld (e-mail content, messages from	253	as its source can not easily be controlled (e-mail content, messages from
526	other users on the same system etc.).	254	other users on the same system etc.).
		255
		256	For responses, C<$resp> contains the end-of-args separator used by the
		257	sender.
527		258
528	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
529		260
530	Called whenever text is about to be output, with the text as argument. You	261	Called whenever text is about to be output, with the text as argument. You
531	can filter/change and output the text yourself by returning a true value	262	can filter/change and output the text yourself by returning a true value
…		…
536	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
537		268
538	Called whenever some data is written to the tty/pty and can be used to	269	Called whenever some data is written to the tty/pty and can be used to
539	suppress or filter tty input.	270	suppress or filter tty input.
540		271
		272	=item on_tt_paste $term, $octets
		273
		274	Called whenever text is about to be pasted, with the text as argument. You
		275	can filter/change and paste the text yourself by returning a true value
		276	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		277	locale-encoded.
		278
541	=item on_line_update $term, $row	279	=item on_line_update $term, $row
542		280
543	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
544	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
545	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
552	later with the already-modified line (e.g. if unrelated parts change), so	290	later with the already-modified line (e.g. if unrelated parts change), so
553	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
554		292
555	=item on_refresh_begin $term	293	=item on_refresh_begin $term
556		294
557	Called just before the screen gets redrawn. Can be used for overlay	295	Called just before the screen gets redrawn. Can be used for overlay or
558	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
559	restoring them in refresh_end. The built-in overlay and selection display	297	restoring them in refresh_end. The built-in overlay and selection display
560	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
561		299
562	=item on_refresh_end $term	300	=item on_refresh_end $term
563		301
564	Called just after the screen gets redrawn. See C<on_refresh_begin>.	302	Called just after the screen gets redrawn. See C<on_refresh_begin>.
565		303
566	=item on_user_command $term, $string	304	=item on_user_command $term, $string
567		305
568	Called whenever the a user-configured event is being activated (e.g. via	306	Called whenever a user-configured event is being activated (e.g. via
569	a C<perl:string> action bound to a key, see description of the B<keysym>	307	a C<perl:string> action bound to a key, see description of the B<keysym>
570	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
571		309
572	The event is simply the action string. This interface is assumed to change	310	The event is simply the action string. This interface is assumed to change
573	slightly in the future.	311	slightly in the future.
574		312
		313	=item on_register_command $term, $keysym, $modifiermask, $string
		314
		315	Called after parsing a keysym resource but before registering the
		316	associated binding. If this hook returns TRUE the binding is not
		317	registered. It can be used to modify a binding by calling
		318	C<register_command>.
		319
575	=item on_resize_all_windows $tern, $new_width, $new_height	320	=item on_resize_all_windows $term, $new_width, $new_height
576		321
577	Called just after the new window size has been calculcated, but before	322	Called just after the new window size has been calculated, but before
578	windows are actually being resized or hints are being set. If this hook	323	windows are actually being resized or hints are being set. If this hook
579	returns TRUE, setting of the window hints is being skipped.	324	returns TRUE, setting of the window hints is being skipped.
580		325
581	=item on_x_event $term, $event	326	=item on_x_event $term, $event
582		327
583	Called on every X event received on the vt window (and possibly other	328	Called on every X event received on the vt window (and possibly other
584	windows). Should only be used as a last resort. Most event structure	329	windows). Should only be used as a last resort. Most event structure
585	members are not passed.	330	members are not passed.
586		331
		332	=item on_root_event $term, $event
		333
		334	Like C<on_x_event>, but is called for events on the root window.
		335
587	=item on_focus_in $term	336	=item on_focus_in $term
588		337
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	339	does focus in processing.
591		340
592	=item on_focus_out $term	341	=item on_focus_out $term
593		342
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	344	focus out processing.
596		345
597	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
598		347
599	=item on_property_notify $term, $event	348	=item on_property_notify $term, $event
…		…
610		359
611	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
612		361
613	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
614		363
615	Called whenever the corresponding X event is received for the terminal If	364	Called whenever the corresponding X event is received for the terminal. If
616	the hook returns true, then the even will be ignored by rxvt-unicode.	365	the hook returns true, then the event will be ignored by rxvt-unicode.
617		366
618	The event is a hash with most values as named by Xlib (see the XEvent	367	The event is a hash with most values as named by Xlib (see the XEvent
619	manpage), with the additional members C<row> and C<col>, which are the	368	manpage), with the additional members C<row> and C<col>, which are the
620	(real, not screen-based) row and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
621		370
…		…
631	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
632		381
633	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
634	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
635		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
636	=back	389	=back
637		390
638	=cut	391	=cut
639		392
640	package urxvt;	393	package urxvt;
641		394
642	use utf8;	395	use utf8;
643	use strict;	396	use strict 'vars';
644	use Carp ();	397	use Carp ();
645	use Scalar::Util ();	398	use Scalar::Util ();
646	use List::Util ();	399	use List::Util ();
647		400
648	our $VERSION = 1;	401	our $VERSION = 1;
649	our $TERM;	402	our $TERM;
650	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
651	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
652	our @HOOKNAME;	405	our @HOOKNAME;
653	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
654	our %OPTION;	407	our %OPTION;
655		408
656	our $LIBDIR;	409	our $LIBDIR;
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
684		437
685	=item @urxvt::TERM_INIT	438	=item @urxvt::TERM_INIT
686		439
687	All coderefs in this array will be called as methods of the next newly	440	All code references in this array will be called as methods of the next newly
688	created C<urxvt::term> object (during the C<on_init> phase). The array	441	created C<urxvt::term> object (during the C<on_init> phase). The array
689	gets cleared before the codereferences that were in it are being executed,	442	gets cleared before the code references that were in it are being executed,
690	so coderefs can push themselves onto it again if they so desire.	443	so references can push themselves onto it again if they so desire.
691		444
692	This complements to the perl-eval commandline option, but gets executed	445	This complements to the perl-eval command line option, but gets executed
693	first.	446	first.
694		447
695	=item @urxvt::TERM_EXT	448	=item @urxvt::TERM_EXT
696		449
697	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	450	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
704		457
705	=over 4	458	=over 4
706		459
707	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
708		461
709	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
710	costs! The only time this is acceptable is when the terminal process	463	include a trailing newline). Avoid at all costs! The only time this
711	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
712		466
713	=item urxvt::warn $string	467	=item urxvt::warn $string
714		468
715	Calls C<rxvt_warn> with the given string which should not include a	469	Calls C<rxvt_warn> with the given string which should include a trailing
716	newline. The module also overwrites the C<warn> builtin with a function	470	newline. The module also overwrites the C<warn> builtin with a function
717	that calls this function.	471	that calls this function.
718		472
719	Using this function has the advantage that its output ends up in the	473	Using this function has the advantage that its output ends up in the
720	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
723		477
724	=item @terms = urxvt::termlist	478	=item @terms = urxvt::termlist
725		479
726	Returns all urxvt::term objects that exist in this process, regardless of	480	Returns all urxvt::term objects that exist in this process, regardless of
727	wether they are started, being destroyed etc., so be careful. Only term	481	whether they are started, being destroyed etc., so be careful. Only term
728	objects that have perl extensions attached will be returned (because there	482	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	483	is no urxvt::term object associated with others).
730		484
731	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
732		486
733	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
734		488
…		…
777		531
778	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
779		533
780	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
781		535
782	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	536	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		537	urxvt::RS_RVid, urxvt::RS_Uline
783		538
784	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
785	underline, respectively. To enable such a style, just logically OR it into	540	underline, respectively. To enable such a style, just logically OR it into
786	the bitset.	541	the bitset.
787		542
…		…
824	};	579	};
825	}	580	}
826		581
827	no warnings 'utf8';	582	no warnings 'utf8';
828		583
		584	sub parse_resource {
		585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		586
		587	$name =~ y/-/./ if $isarg;
		588
		589	$term->scan_meta;
		590
		591	my $r = $term->{meta}{resource};
		592	keys %$r; # reste iterator
		593	while (my ($pattern, $v) = each %$r) {
		594	if (
		595	$pattern =~ /\.$/
		596	? $pattern eq substr $name, 0, length $pattern
		597	: $pattern eq $name
		598	) {
		599	$name = "$urxvt::RESCLASS.$name";
		600
		601	push @{ $term->{perl_ext_3} }, $v->[0];
		602
		603	if ($v->[1] eq "boolean") {
		604	$term->put_option_db ($name, $flag ? "true" : "false");
		605	return 1;
		606	} else {
		607	$term->put_option_db ($name, $value);
		608	return 1 + 2;
		609	}
		610	}
		611	}
		612
		613	0
		614	}
		615
		616	sub usage {
		617	my ($term, $usage_type) = @_;
		618
		619	$term->scan_meta;
		620
		621	my $r = $term->{meta}{resource};
		622
		623	for my $pattern (sort keys %$r) {
		624	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		625
		626	$desc .= " (-pe $ext)";
		627
		628	if ($usage_type == 1) {
		629	$pattern =~ y/./-/;
		630	$pattern =~ s/-$/-.../g;
		631
		632	if ($type eq "boolean") {
		633	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		634	} else {
		635	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		636	}
		637	} else {
		638	$pattern =~ s/\.$/.*/g;
		639	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		640	}
		641	}
		642	}
		643
829	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
830		645
831	sub verbose {	646	sub verbose {
832	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
833	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
845	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
846	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
847		662
848	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
849		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
850	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
851	or die "$path: $!";	668	or die "$path: $!";
852		669
853	my $source =	670	my $source =
854	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
855	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
856	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
857	. "\n};\n1";	674	. "\n};\n1";
858		675
859	eval $source	676	eval $source
…		…
869	sub invoke {	686	sub invoke {
870	local $TERM = shift;	687	local $TERM = shift;
871	my $htype = shift;	688	my $htype = shift;
872		689
873	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
875		692
876	my %ext_arg;	693	my %ext_arg;
877		694
878	{	695	{
879	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
880	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
882	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
883	@TERM_EXT = ();	700	@TERM_EXT = ();
884	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
885	}	702	}
886		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
887	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
888	if ($_ eq "default") {	708	if ($_ eq "default") {
889	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
890	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
891	delete $ext_arg{$1};	711	delete $ext_arg{$1};
892	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
…		…
943		763
944	sub SET_COLOR($$$) {	764	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	766	}
947		767
948	# urxvt::term::extension	768	sub rend2mask {
		769	no strict 'refs';
		770	my ($str, $mask) = (@_, 0);
		771	my %color = ( fg => undef, bg => undef );
		772	my @failed;
		773	for my $spec ( split /\s+/, $str ) {
		774	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		775	$color{lc($1)} = $2;
		776	} else {
		777	my $neg = $spec =~ s/^[-^]//;
		778	unless ( exists &{"RS_$spec"} ) {
		779	push @failed, $spec;
		780	next;
		781	}
		782	my $cur = &{"RS_$spec"};
		783	if ( $neg ) {
		784	$mask &= ~$cur;
		785	} else {
		786	$mask |= $cur;
		787	}
		788	}
		789	}
		790	($mask, @color{qw(fg bg)}, \@failed)
		791	}
949		792
950	package urxvt::term::extension;	793	package urxvt::term::extension;
951		794
952	sub enable {	795	sub enable {
953	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
1008		851
1009	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
1010	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
1011	}	854	}
1012		855
		856	sub x_resource {
		857	my ($self, $name) = @_;
		858	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		859	$self->{term}->x_resource ($name)
		860	}
		861
		862	sub x_resource_boolean {
		863	my ($self, $name) = @_;
		864	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		865	$self->{term}->x_resource_boolean ($name)
		866	}
		867
1013	package urxvt::anyevent;	868	package urxvt::anyevent;
1014		869
1015	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
1016		871
1017	The sole purpose of this class is to deliver an interface to the	872	The sole purpose of this class is to deliver an interface to the
1018	C<AnyEvent> module - any module using it will work inside urxvt without	873	C<AnyEvent> module - any module using it will work inside urxvt without
1019	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
1020	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
1021	is that you cannot use blocking APIs, but the non-blocking variant should	876
1022	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
1023		879
1024	=cut	880	=cut
1025		881
1026	our $VERSION = 1;	882	our $VERSION = '5.23';
1027		883
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		886
1031	sub timer {	887	sub timer {
…		…
1033		889
1034	my $cb = $arg{cb};	890	my $cb = $arg{cb};
1035		891
1036	urxvt::timer	892	urxvt::timer
1037	->new	893	->new
1038	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
1041	$cb->();	897	$cb->();
1042	})	898	})
1043	}	899	}
1044		900
1045	sub io {	901	sub io {
1046	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
1047		903
1048	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
1049		907
1050	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
1051	->new	909	->new
1052	->fd (fileno $arg{fh})	910	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	913	->start
1056	->cb (sub {	914	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	urxvt::anyevent::	915	], urxvt::anyevent::
		916	}
		917
		918	sub idle {
		919	my ($class, %arg) = @_;
		920
		921	my $cb = $arg{cb};
		922
		923	urxvt::iw
		924	->new
		925	->start
		926	->cb ($cb)
		927	}
		928
		929	sub child {
		930	my ($class, %arg) = @_;
		931
		932	my $cb = $arg{cb};
		933
		934	urxvt::pw
		935	->new
		936	->start ($arg{pid})
		937	->cb (sub {
		938	$_[0]->stop; # need to cancel manually
		939	$cb->($_[0]->rpid, $_[0]->rstatus);
		940	})
1061	}	941	}
1062		942
1063	sub DESTROY {	943	sub DESTROY {
1064	$_[0][1]->stop;	944	$_[0][1]->stop;
1065	}	945	}
1066		946
1067	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
1068	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
1069	}
1070
1071	sub urxvt::anyevent::condvar::broadcast {
1072	${$_[0]}++;
1073	}
1074
1075	sub urxvt::anyevent::condvar::wait {
1076	unless (${$_[0]}) {
1077	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	949	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	950	}
1080		951
1081	package urxvt::term;	952	package urxvt::term;
1082		953
1083	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
1096	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
1097		968
1098	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
1099		970
1100	my $proxy = bless {	971	my $proxy = bless {
1101	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
1102	argv => $argv,	974	argv => $argv,
1103	}, $pkg;	975	}, $pkg;
1104	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
1105		977
1106	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
1107		979
…		…
1110	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
1111	}	983	}
1112	}	984	}
1113	}	985	}
1114		986
		987	sub perl_libdirs {
		988	map { split /:/ }
		989	$_[0]->resource ("perl_lib"),
		990	$ENV{URXVT_PERL_LIB},
		991	"$ENV{HOME}/.urxvt/ext",
		992	"$LIBDIR/perl"
		993	}
		994
		995	sub scan_meta {
		996	my ($self) = @_;
		997	my @libdirs = perl_libdirs $self;
		998
		999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1000
		1001	my %meta;
		1002
		1003	$self->{meta_libdirs} = join "\x00", @libdirs;
		1004	$self->{meta} = \%meta;
		1005
		1006	for my $dir (reverse @libdirs) {
		1007	opendir my $fh, $dir
		1008	or next;
		1009	for my $ext (readdir $fh) {
		1010	$ext ne "."
		1011	and $ext ne ".."
		1012	and open my $fh, "<", "$dir/$ext"
		1013	or next;
		1014
		1015	while (<$fh>) {
		1016	if (/^#:META:X_RESOURCE:(.*)/) {
		1017	my ($pattern, $type, $desc) = split /:/, $1;
		1018	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1021	} else {
		1022	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1023	}
		1024	} elsif (/^\s*(?:#|$)/) {
		1025	# skip other comments and empty lines
		1026	} else {
		1027	last; # stop parsing on first non-empty non-comment line
		1028	}
		1029	}
		1030	}
		1031	}
		1032	}
		1033
1115	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1116		1035
1117	Creates a new terminal, very similar as if you had started it with system	1036	Creates a new terminal, very similar as if you had started it with system
1118	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1037	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1119	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
…		…
1170		1089
1171	Returns true if the option specified by C<$optval> is enabled, and	1090	Returns true if the option specified by C<$optval> is enabled, and
1172	optionally change it. All option values are stored by name in the hash	1091	optionally change it. All option values are stored by name in the hash
1173	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1092	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174		1093
1175	Here is a a likely non-exhaustive list of option names, please see the	1094	Here is a likely non-exhaustive list of option names, please see the
1176	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1177		1096
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1184		1104
1185	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1186		1106
1187	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1188	optionally sets a new value. Setting values is most useful in the C<init>	1108	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1197	likely change).	1117	likely change).
1198		1118
1199	Please note that resource strings will currently only be freed when the	1119	Please note that resource strings will currently only be freed when the
1200	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1201		1121
1202	Here is a a likely non-exhaustive list of resource names, not all of which	1122	Here is a likely non-exhaustive list of resource names, not all of which
1203	are supported in every build, please see the source file F</src/rsinc.h>	1123	are supported in every build, please see the source file F</src/rsinc.h>
1204	to see the actual list:	1124	to see the actual list:
1205		1125
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1139	utmpInhibit visualBell
1219		1140
1220	=cut	1141	=cut
1221		1142
1222	sub resource($$;$) {	1143	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1226	}	1147	}
1227		1148
1228	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1229		1150
1230	Returns the X-Resource for the given pattern, excluding the program or	1151	Returns the X-Resource for the given pattern, excluding the program or
1231	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1232	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1233	resource with that pattern exists.	1154	resource with that pattern exists.
1234		1155
		1156	Extensions that define extra resource or command line arguments also need
		1157	to call this method to access their values.
		1158
		1159	If the method is called on an extension object (basically, from an
		1160	extension), then the special prefix C<%.> will be replaced by the name of
		1161	the extension and a dot, and the lone string C<%> will be replcaed by the
		1162	extension name itself. This makes it possible to code extensions so you
		1163	can rename them and get a new set of commandline switches and resources
		1164	without having to change the actual code.
		1165
1235	This method should only be called during the C<on_start> hook, as there is	1166	This method should only be called during the C<on_start> hook, as there is
1236	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1237	the wrong resources.	1168	the wrong resources.
1238		1169
1239	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1240		1171
		1172	Like C<x_resource>, above, but interprets the string value as a boolean
		1173	and returns C<1> for true values, C<0> for false values and C<undef> if
		1174	the resource or option isn't specified.
		1175
		1176	You should always use this method to parse boolean resources.
		1177
		1178	=cut
		1179
		1180	sub x_resource_boolean {
		1181	my $res = &x_resource;
		1182
		1183	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1184	}
		1185
		1186	=item $success = $term->parse_keysym ($key, $octets)
		1187
1241	Adds a keymap translation exactly as specified via a resource. See the	1188	Adds a key binding exactly as specified via a resource. See the
1242	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1190
		1191	=item $term->register_command ($keysym, $modifiermask, $string)
		1192
		1193	Adds a key binding. This is a lower level api compared to
		1194	C<parse_keysym>, as it expects a parsed key description, and can be
		1195	used only inside either the C<on_init> hook, to add a binding, or the
		1196	C<on_register_command> hook, to modify a parsed binding.
1243		1197
1244	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1245		1199
1246	Return and optionally change the current rendition. Text that is output by	1200	Return and optionally change the current rendition. Text that is output by
1247	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1255		1209
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1211
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1213
1260	Return the current values of the selection mark, begin or end positions,	1214	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1215
		1216	When arguments are given, then the selection coordinates are set to
		1217	C<$row> and C<$col>, and the selection screen is set to the current
		1218	screen.
		1219
		1220	=item $screen = $term->selection_screen ([$screen])
		1221
		1222	Returns the current selection screen, and then optionally sets it.
1262		1223
1263	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1264		1225
1265	Tries to make a selection as set by C<selection_beg> and	1226	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1228	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1229	a selection.
1269		1230
1270	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1232
1272	Try to request the primary selection text from the server (for example, as	1233	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1234	true) selection from the server. The corresponding text can be set
1273	set by the next method). No visual feedback will be given. This function	1235	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1275		1237
1276	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1239
1278	Return the current selection text and optionally replace it by C<$newtext>.	1240	Return the current selection (clipboard if C<$clipboard> is true) text
		1241	and optionally replace it by C<$newtext>.
		1242
		1243	=item $term->selection_clear ([$clipboard])
		1244
		1245	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1246
1280	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1281		1248
1282	Create a simple multi-line overlay box. See the next method for details.	1249	Create a simple multi-line overlay box. See the next method for details.
1283		1250
…		…
1313		1280
1314	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1315		1282
1316	=over 4	1283	=over 4
1317		1284
1318	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1319		1286
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1287	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1321	text in rxvt-unicode's special encoding and an array of rendition values	1288	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1289	at a specific position inside the overlay.
		1290
		1291	If C<$rend> is missing, then the rendition will not be changed.
1323		1292
1324	=item $overlay->hide	1293	=item $overlay->hide
1325		1294
1326	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1327		1296
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1411		1380
1412	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1413		1382
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1415	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1385	to the locale-specific encoding using C<< $term->locale_encode >>.
		1386
		1387	=item $term->tt_paste ($octets)
		1388
		1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1390	CR and bracketing the data with control sequences if bracketed paste mode
		1391	is set.
1417		1392
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1394
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1395	Replaces the event mask of the pty watcher by the given event mask. Can
1421	be used to suppress input and output handling to the pty/tty. See the	1396	be used to suppress input and output handling to the pty/tty. See the
…		…
1440	Adds the specified events to the vt event mask. Useful e.g. when you want	1415	Adds the specified events to the vt event mask. Useful e.g. when you want
1441	to receive pointer events all the times:	1416	to receive pointer events all the times:
1442		1417
1443	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1444		1419
		1420	=item $term->set_urgency ($set)
		1421
		1422	Enable/disable the urgency hint on the toplevel window.
		1423
1445	=item $term->focus_in	1424	=item $term->focus_in
1446		1425
1447	=item $term->focus_out	1426	=item $term->focus_out
1448		1427
1449	=item $term->key_press ($state, $keycode[, $time])	1428	=item $term->key_press ($state, $keycode[, $time])
…		…
1519		1498
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1499	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1500
1522	=item $cursor_is_hidden = $term->hidden_cursor	1501	=item $cursor_is_hidden = $term->hidden_cursor
1523		1502
1524	Returns wether the cursor is currently hidden or not.	1503	Returns whether the cursor is currently hidden or not.
1525		1504
1526	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1527		1506
1528	Returns the row number of the topmost displayed line. Maximum value is	1507	Returns the row number of the topmost displayed line. Maximum value is
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1537		1516
1538	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1539		1518
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1520
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1543	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1522	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1544	terminal line. The scrollback buffer starts at line C<-1> and extends to
1545	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1524	is requested.
1547		1525
1548	If C<$new_text> is specified, it will replace characters in the current	1526	If C<$new_text> is specified, it will replace characters in the current
1549	line, starting at column C<$start_col> (default C<0>), which is useful	1527	line, starting at column C<$start_col> (default C<0>), which is useful
1550	to replace only parts of a line. The font index in the rendition will	1528	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1529	automatically be updated.
1552		1530
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1531	C<$text> is in a special encoding: tabs and wide characters that use more
1554	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1533	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1534	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1535	in the private use area.
1558		1536
1559	You have to obey this encoding when changing text. The advantage is	1537	You have to obey this encoding when changing text. The advantage is
1560	that C<substr> and similar functions work on screen cells and not on	1538	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1539	characters.
…		…
1706	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1708		1686
1709	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1710		1688
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1713		1691
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1693
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1697	manpage.
1720		1698
1721	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1722		1700
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1703
1726	=item $term->allow_events_async	1704	=item $term->allow_events_async
1727		1705
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1707
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1715	recent grab.
1738		1716
1739	=item $term->ungrab	1717	=item $term->ungrab
1740		1718
1741	Calls XUngrab for the most recent grab. Is called automatically on	1719	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1742	evaluation errors, as it is better to lose the grab in the error case as	1720	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	1721	the session.
1744		1722
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1724
…		…
1748		1726
1749	=item @atoms = $term->XListProperties ($window)	1727	=item @atoms = $term->XListProperties ($window)
1750		1728
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1730
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1732
1755	=item $term->XDeleteProperty ($window, $property)	1733	=item $term->XDeleteProperty ($window, $property)
1756		1734
1757	=item $window = $term->DefaultRootWindow	1735	=item $window = $term->DefaultRootWindow
1758		1736
…		…
1765	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766		1744
1767	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768		1746
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
1770		1752
1771	Various X or X-related functions. The C<$term> object only serves as	1753	Various X or X-related functions. The C<$term> object only serves as
1772	the source of the display, otherwise those functions map more-or-less	1754	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1774		1756
1775	=back	1757	=back
1776		1758
1777	=cut	1759	=cut
1778		1760
…		…
1880	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1863	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1884		1866
1885	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	1875	) or die "unable to create popup window\n";
		1876
		1877	unless (delete $term->{urxvt_popup_init_done}) {
		1878	$term->ungrab;
		1879	$term->destroy;
		1880	die "unable to initialise popup window\n";
		1881	}
1893	}	1882	}
1894		1883
1895	sub DESTROY {	1884	sub DESTROY {
1896	my ($self) = @_;	1885	my ($self) = @_;
1897		1886
…		…
1902	=back	1891	=back
1903		1892
1904	=cut	1893	=cut
1905		1894
1906	package urxvt::watcher;	1895	package urxvt::watcher;
1907
1908	@urxvt::timer::ISA = __PACKAGE__;
1909	@urxvt::iow::ISA = __PACKAGE__;
1910	@urxvt::pw::ISA = __PACKAGE__;
1911	@urxvt::iw::ISA = __PACKAGE__;
1912		1896
1913	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1914		1898
1915	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1920	->new	1904	->new
1921	->interval (1)	1905	->interval (1)
1922	->cb (sub {	1906	->cb (sub {
1923	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	1909	});
1926		1910
1927	=over 4	1911	=over 4
1928		1912
1929	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1930		1914
…		…
1933		1917
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		1919
1936	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1937		1921
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1943		1923
1944	Set the time the event is generated to $tstamp.	1924	Set the time the event is generated to $tstamp (and optionally specifies a
		1925	new $interval).
1945		1926
1946	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1947		1928
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	1929	By default (and when C<$interval> is C<0>), the timer will automatically
1949	stop after it has fired once. If C<$interval> is non-zero, then the timer	1930	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1951		1932
1952	=item $timer = $timer->start	1933	=item $timer = $timer->start
1953		1934
1954	Start the timer.	1935	Start the timer.
1955		1936
1956	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1957		1938
1958	Set the event trigger time to C<$tstamp> and start the timer.	1939	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		1940	also replaces the interval.
1959		1941
1960	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1961		1943
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	1944	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		1945
1964	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1965		1947
…		…
1973		1955
1974	$term->{socket} = ...	1956	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1976	->new	1958	->new
1977	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1979	->start	1961	->start
1980	->cb (sub {	1962	->cb (sub {
1981	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	1978	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1998		1980
1999	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
2000		1982
2001	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
2002		1984
2003	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
2004		1986
2005	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
2006	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	1988	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
2008		1990
2009	=item $iow = $iow->start	1991	=item $iow = $iow->start
2010		1992
2011	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
2012		1994
2013	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
2014		1996
2015	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
2016		1998
2017	=back	1999	=back
2018		2000
2019	=head2 The C<urxvt::iw> Class	2001	=head2 The C<urxvt::iw> Class
2020		2002
…		…
2053	->new	2035	->new
2054	->start ($pid)	2036	->start ($pid)
2055	->cb (sub {	2037	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
2057	...	2039	...
2058	});	2040	});
2059		2041
2060	=over 4	2042	=over 4
2061		2043
2062	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
2063		2045
…		…
2067		2049
2068	Set the callback to be called when the timer triggers.	2050	Set the callback to be called when the timer triggers.
2069		2051
2070	=item $pw = $timer->start ($pid)	2052	=item $pw = $timer->start ($pid)
2071		2053
2072	Tells the wqtcher to start watching for process C<$pid>.	2054	Tells the watcher to start watching for process C<$pid>.
2073		2055
2074	=item $pw = $pw->stop	2056	=item $pw = $pw->stop
2075		2057
2076	Stop the watcher.	2058	Stop the watcher.
2077		2059
…		…
2090		2072
2091	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
2092		2074
2093	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
2094		2076
2095	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
2096		2078
2097	=back	2079	=back
2098		2080
2099	=head1 AUTHOR	2081	=head1 AUTHOR
2100		2082
2101	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
2103		2085
2104	=cut	2086	=cut
2105		2087
2106	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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