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.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 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:
…		…
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.
91		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	};
		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	evalution, 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 mark-urls	225	=item tabbed
168		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		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):
		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
169	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
170	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
171	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
172	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.
173		258
174	=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.
175		263
176	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.
177	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.
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179		266
180	@@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.
181		313
182	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
183		315
184	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
185	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
186	similar-looking ascii character.	318	similar-looking ascii character.
187		319
188	=item digital-clock	320	=item digital-clock
189		321
190	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.
191		391
192	=item example-refresh-hooks	392	=item example-refresh-hooks
193		393
194	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
195	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.	396	overlays or changes.
197		397
198	=item selection-pastebin	398	=item confirm-paste
199		399
200	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
201	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226		402
227	=back	403	=back
228		404
229	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
230		406
…		…
246		422
247	=over 4	423	=over 4
248		424
249	=item $text	425	=item $text
250		426
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	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.
253		429
254	=item $string	430	=item $string
255		431
256	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
…		…
264		440
265	=back	441	=back
266		442
267	=head2 Extension Objects	443	=head2 Extension Objects
268		444
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
274	use.	451	internal use.
275		452
276	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
277	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
278		455
279	It has the following methods and data members:	456	It has the following methods and data members:
…		…
300	=head2 Hooks	477	=head2 Hooks
301		478
302	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
303	called whenever the relevant event happens.	480	called whenever the relevant event happens.
304		481
305	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
306	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
307		484
308	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
309	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
310	relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
…		…
323	place.	500	place.
324		501
325	=item on_start $term	502	=item on_start $term
326		503
327	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
328	trying to map (display) the toplevel and returning to the mainloop.	505	trying to map (display) the toplevel and returning to the main loop.
329		506
330	=item on_destroy $term	507	=item on_destroy $term
331		508
332	Called whenever something tries to destroy terminal, before doing anything	509	Called whenever something tries to destroy terminal, when the terminal is
333	yet. If this hook returns true, then destruction is skipped, but this is	510	still fully functional (not for long, though).
334	rarely a good idea.
335		511
336	=item on_reset $term	512	=item on_reset $term
337		513
338	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
339	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
…		…
361		537
362	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
363	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
364	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
365		541
366	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.
367		543
368	=item on_sel_extend $term	544	=item on_sel_extend $term
369		545
370	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
371	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
372	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
373	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
374	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
375	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
376		552
377	See the F<selection> example extension.	553	See the F<selection> example extension.
378		554
379	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
380		556
381	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
382	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
383	show this many lines of scrollback.	559	show this many lines of scrollback.
384		560
385	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
386		562
…		…
390		566
391	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,
392	$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
393	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
394		570
395	=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
396		582
397	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
398	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
399	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
400	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,
401	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
402	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	}
403		599
404	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,
405	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
406	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.
407		606
408	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
409		608
410	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
411	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
…		…
416	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
417		616
418	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
419	suppress or filter tty input.	618	suppress or filter tty input.
420		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
421	=item on_line_update $term, $row	627	=item on_line_update $term, $row
422		628
423	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
424	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
425	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,
…		…
432	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
433	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
434		640
435	=item on_refresh_begin $term	641	=item on_refresh_begin $term
436		642
437	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
438	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
439	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
440	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
441		647
442	=item on_refresh_end $term	648	=item on_refresh_end $term
443		649
444	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>.
445		651
446	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
447		653
448	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
449	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>
450	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.
451		666
452	=item on_x_event $term, $event	667	=item on_x_event $term, $event
453		668
454	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
455	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
456	members are not passed.	671	members are not passed.
457		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
458	=item on_focus_in $term	677	=item on_focus_in $term
459		678
460	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
461	does focus in processing.	680	does focus in processing.
462		681
463	=item on_focus_out $term	682	=item on_focus_out $term
464		683
465	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
466	focus out processing.	685	focus out processing.
467		686
468	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
469		688
		689	=item on_property_notify $term, $event
		690
470	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
471		692
472	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
473		694
474	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
479		700
480	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
481		702
482	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
483		704
484	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
485	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.
486		707
487	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
488	manpage), with the additional members C<row> and C<col>, which are the row	709	manpage), with the additional members C<row> and C<col>, which are the
489	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
490		711
491	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
492	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
493		714
494	subwindow.	715	subwindow.
		716
		717	=item on_client_message $term, $event
		718
		719	=item on_wm_protocols $term, $event
		720
		721	=item on_wm_delete_window $term, $event
		722
		723	Called when various types of ClientMessage events are received (all with
		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.
495		729
496	=back	730	=back
497		731
498	=cut	732	=cut
499		733
…		…
516	our $LIBDIR;	750	our $LIBDIR;
517	our $RESNAME;	751	our $RESNAME;
518	our $RESCLASS;	752	our $RESCLASS;
519	our $RXVTNAME;	753	our $RXVTNAME;
520		754
		755	our $NOCHAR = chr 0xffff;
		756
521	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
522		758
523	=over 4	759	=over 4
524		760
525	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
540	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
541	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
542		778
543	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
544		780
545	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
546	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
547	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,
548	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.
549		785
550	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
551	first.	787	first.
552		788
553	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
554		790
555	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
…		…
576		812
577	Using this function has the advantage that its output ends up in the	813	Using this function has the advantage that its output ends up in the
578	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
579		815
580	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
		817
		818	=item @terms = urxvt::termlist
		819
		820	Returns all urxvt::term objects that exist in this process, regardless of
		821	whether they are started, being destroyed etc., so be careful. Only term
		822	objects that have perl extensions attached will be returned (because there
		823	is no urxvt::term objet associated with others).
581		824
582	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
583		826
584	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
585		828
…		…
628		871
629	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
630		873
631	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
632		875
633	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
634		878
635	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
636	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
637	the bitset.	881	the bitset.
638		882
…		…
643	Return the foreground/background colour index, respectively.	887	Return the foreground/background colour index, respectively.
644		888
645	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	889	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
646		890
647	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	891	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		892
		893	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
648		894
649	Replace the foreground/background colour in the rendition mask with the	895	Replace the foreground/background colour in the rendition mask with the
650	specified one.	896	specified one.
651		897
652	=item $value = urxvt::GET_CUSTOM $rend	898	=item $value = urxvt::GET_CUSTOM $rend
…		…
671	unless $msg =~ /\n$/;	917	unless $msg =~ /\n$/;
672	urxvt::warn ($msg);	918	urxvt::warn ($msg);
673	};	919	};
674	}	920	}
675		921
		922	no warnings 'utf8';
		923
676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	924	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677		925
678	sub verbose {	926	sub verbose {
679	my ($level, $msg) = @_;	927	my ($level, $msg) = @_;
680	warn "$msg\n" if $level <= $verbosity;	928	warn "$msg\n" if $level <= $verbosity;
…		…
696		944
697	open my $fh, "<:raw", $path	945	open my $fh, "<:raw", $path
698	or die "$path: $!";	946	or die "$path: $!";
699		947
700	my $source =	948	my $source =
701	"package $pkg; use strict; use utf8;\n"	949	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
702	. "#line 1 \"$path\"\n{\n"	950	. "#line 1 \"$path\"\n{\n"
703	. (do { local $/; <$fh> })	951	. (do { local $/; <$fh> })
704	. "\n};\n1";	952	. "\n};\n1";
705		953
706	eval $source	954	eval $source
…		…
717	local $TERM = shift;	965	local $TERM = shift;
718	my $htype = shift;	966	my $htype = shift;
719		967
720	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
722		970
723	my %ext_arg;	971	my %ext_arg;
724		972
725	{	973	{
726	my @init = @TERM_INIT;	974	my @init = @TERM_INIT;
727	@TERM_INIT = ();	975	@TERM_INIT = ();
…		…
731	$TERM->register_package ($_) for @pkg;	979	$TERM->register_package ($_) for @pkg;
732	}	980	}
733		981
734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	982	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
735	if ($_ eq "default") {	983	if ($_ eq "default") {
736	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	984	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
737	} elsif (/^-(.*)$/) {	985	} elsif (/^-(.*)$/) {
738	delete $ext_arg{$1};	986	delete $ext_arg{$1};
739	} elsif (/^([^<]+)<(.*)>$/) {	987	} elsif (/^([^<]+)<(.*)>$/) {
740	push @{ $ext_arg{$1} }, $2;	988	push @{ $ext_arg{$1} }, $2;
741	} else {	989	} else {
742	$ext_arg{$_} ||= [];	990	$ext_arg{$_} ||= [];
743	}	991	}
744	}	992	}
745		993
746	while (my ($ext, $argv) = each %ext_arg) {	994	for my $ext (sort keys %ext_arg) {
747	my @files = grep -f $_, map "$_/$ext", @dirs;	995	my @files = grep -f $_, map "$_/$ext", @dirs;
748		996
749	if (@files) {	997	if (@files) {
750	$TERM->register_package (extension_package $files[0], $argv);	998	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
751	} else {	999	} else {
752	warn "perl extension '$ext' not found in perl library search path\n";	1000	warn "perl extension '$ext' not found in perl library search path\n";
753	}	1001	}
754	}	1002	}
755		1003
…		…
761		1009
762	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
763	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
764	if $verbosity >= 10;	1012	if $verbosity >= 10;
765		1013
766	keys %$cb;	1014	for my $pkg (keys %$cb) {
767
768	while (my ($pkg, $cb) = each %$cb) {
769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
770	$retval ||= $retval_;	1016	$retval ||= $retval_;
771		1017
772	if ($@) {	1018	if ($@) {
773	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
774	warn $@;	1020	warn $@;
…		…
786	# clear package	1032	# clear package
787	%$TERM = ();	1033	%$TERM = ();
788	}	1034	}
789		1035
790	$retval	1036	$retval
		1037	}
		1038
		1039	sub SET_COLOR($$$) {
		1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1041	}
		1042
		1043	sub rend2mask {
		1044	no strict 'refs';
		1045	my ($str, $mask) = (@_, 0);
		1046	my %color = ( fg => undef, bg => undef );
		1047	my @failed;
		1048	for my $spec ( split /\s+/, $str ) {
		1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask |= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
791	}	1066	}
792		1067
793	# urxvt::term::extension	1068	# urxvt::term::extension
794		1069
795	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
866	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
867	work.	1142	work.
868		1143
869	=cut	1144	=cut
870		1145
871	our $VERSION = 1;	1146	our $VERSION = '5.23';
872		1147
873	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
874	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
875		1150
876	sub timer {	1151	sub timer {
…		…
878		1153
879	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
880		1155
881	urxvt::timer	1156	urxvt::timer
882	->new	1157	->new
883	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
884	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
885	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
886	$cb->();	1161	$cb->();
887	})	1162	})
888	}	1163	}
889		1164
890	sub io {	1165	sub io {
891	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
892		1167
893	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
894		1171
895	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
896	->new	1173	->new
897	->fd (fileno $arg{fh})	1174	->fd ($fd)
898	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
899	| ($arg{poll} =~ /w/ ? 2 : 0))	1176	| ($arg{poll} =~ /w/ ? 2 : 0))
900	->start	1177	->start
901	->cb (sub {	1178	->cb ($cb)
902	$cb->(($_[1] & 1 ? 'r' : '')
903	. ($_[1] & 2 ? 'w' : ''));
904	})],
905	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
906	}	1205	}
907		1206
908	sub DESTROY {	1207	sub DESTROY {
909	$_[0][1]->stop;	1208	$_[0][1]->stop;
910	}	1209	}
911		1210
912	sub condvar {	1211	sub one_event {
913	bless \my $flag, urxvt::anyevent::condvar::
914	}
915
916	sub urxvt::anyevent::condvar::broadcast {
917	${$_[0]}++;
918	}
919
920	sub urxvt::anyevent::condvar::wait {
921	unless (${$_[0]}) {
922	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
923	}
924	}	1213	}
925		1214
926	package urxvt::term;	1215	package urxvt::term;
927		1216
928	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
964	hash which defines the environment of the new terminal.	1253	hash which defines the environment of the new terminal.
965		1254
966	Croaks (and probably outputs an error message) if the new instance	1255	Croaks (and probably outputs an error message) if the new instance
967	couldn't be created. Returns C<undef> if the new instance didn't	1256	couldn't be created. Returns C<undef> if the new instance didn't
968	initialise perl, and the terminal object otherwise. The C<init> and	1257	initialise perl, and the terminal object otherwise. The C<init> and
969	C<start> hooks will be called during this call.	1258	C<start> hooks will be called before this call returns, and are free to
		1259	refer to global data (which is race free).
970		1260
971	=cut	1261	=cut
972		1262
973	sub new {	1263	sub new {
974	my ($class, $env, @args) = @_;	1264	my ($class, $env, @args) = @_;
975		1265
		1266	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1267	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1268
976	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1269	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
977	}	1270	}
978		1271
979	=item $term->destroy	1272	=item $term->destroy
980		1273
981	Destroy the terminal object (close the window, free resources	1274	Destroy the terminal object (close the window, free resources
…		…
1011		1304
1012	Returns true if the option specified by C<$optval> is enabled, and	1305	Returns true if the option specified by C<$optval> is enabled, and
1013	optionally change it. All option values are stored by name in the hash	1306	optionally change it. All option values are stored by name in the hash
1014	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1015		1308
1016	Here is a a likely non-exhaustive list of option names, please see the	1309	Here is a likely non-exhaustive list of option names, please see the
1017	source file F</src/optinc.h> to see the actual list:	1310	source file F</src/optinc.h> to see the actual list:
1018		1311
1019	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1038	likely change).	1331	likely change).
1039		1332
1040	Please note that resource strings will currently only be freed when the	1333	Please note that resource strings will currently only be freed when the
1041	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
1042		1335
1043	Here is a a likely non-exhaustive list of resource names, not all of which	1336	Here is a likely non-exhaustive list of resource names, not all of which
1044	are supported in every build, please see the source file F</src/rsinc.h>	1337	are supported in every build, please see the source file F</src/rsinc.h>
1045	to see the actual list:	1338	to see the actual list:
1046		1339
1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1048	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1049	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1057	secondaryScreen secondaryScroll selectstyle shade term_name title	1350	secondaryScreen secondaryScroll shade term_name title
1058	transient_for transparent transparent_all tripleclickwords utmpInhibit	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
1059	visualBell	1352	visualBell
1060		1353
1061	=cut	1354	=cut
1062		1355
1063	sub resource($$;$) {	1356	sub resource($$;$) {
1064	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
1065	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1066	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
1067	}	1360	}
1068		1361
1069	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
1070		1363
1071	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
1096		1389
1097	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1098		1391
1099	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1100		1393
1101	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1102	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1103		1403
1104	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1105		1405
1106	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1107	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1108	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1109	a selection.	1409	a selection.
1110		1410
1111	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1112		1412
1113	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
1114	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
1115	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1116		1417
1117	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1118		1419
1119	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1120		1426
1121	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1122		1428
1123	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1124		1430
…		…
1154		1460
1155	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1156		1462
1157	=over 4	1463	=over 4
1158		1464
1159	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1160		1466
1161	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1162	text in rxvt-unicode's special encoding and an array of rendition values	1468	text in rxvt-unicode's special encoding and an array of rendition values
1163	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1164		1472
1165	=item $overlay->hide	1473	=item $overlay->hide
1166		1474
1167	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1168		1476
…		…
1238		1546
1239	Normally its not a good idea to use this function, as programs might be	1547	Normally its not a good idea to use this function, as programs might be
1240	confused by changes in cursor position or scrolling. Its useful inside a	1548	confused by changes in cursor position or scrolling. Its useful inside a
1241	C<on_add_lines> hook, though.	1549	C<on_add_lines> hook, though.
1242		1550
		1551	=item $term->scr_change_screen ($screen)
		1552
		1553	Switch to given screen - 0 primary, 1 secondary.
		1554
1243	=item $term->cmd_parse ($octets)	1555	=item $term->cmd_parse ($octets)
1244		1556
1245	Similar to C<scr_add_lines>, but the argument must be in the	1557	Similar to C<scr_add_lines>, but the argument must be in the
1246	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1247	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1248		1560
1249	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1250		1562
1251	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1252	pass characters instead of octets, you should convert your strings first	1564	pass characters instead of octets, you should convert your strings first
1253	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1254		1572
1255	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1256		1574
1257	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1258	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
1259	description of C<< urxvt::timer->events >>. Make sure to always restore	1577	description of C<< urxvt::timer->events >>. Make sure to always restore
1260	the previous value.	1578	the previous value.
1261		1579
		1580	=item $fd = $term->pty_fd
		1581
		1582	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1583	is used.
		1584
1262	=item $windowid = $term->parent	1585	=item $windowid = $term->parent
1263		1586
1264	Return the window id of the toplevel window.	1587	Return the window id of the toplevel window.
1265		1588
1266	=item $windowid = $term->vt	1589	=item $windowid = $term->vt
…		…
1272	Adds the specified events to the vt event mask. Useful e.g. when you want	1595	Adds the specified events to the vt event mask. Useful e.g. when you want
1273	to receive pointer events all the times:	1596	to receive pointer events all the times:
1274		1597
1275	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1276		1599
		1600	=item $term->focus_in
		1601
		1602	=item $term->focus_out
		1603
		1604	=item $term->key_press ($state, $keycode[, $time])
		1605
		1606	=item $term->key_release ($state, $keycode[, $time])
		1607
		1608	Deliver various fake events to to terminal.
		1609
1277	=item $window_width = $term->width	1610	=item $window_width = $term->width
1278		1611
1279	=item $window_height = $term->height	1612	=item $window_height = $term->height
1280		1613
1281	=item $font_width = $term->fwidth	1614	=item $font_width = $term->fwidth
…		…
1311	=item $env = $term->env	1644	=item $env = $term->env
1312		1645
1313	Returns a copy of the environment in effect for the terminal as a hashref	1646	Returns a copy of the environment in effect for the terminal as a hashref
1314	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1315		1648
		1649	=item @envv = $term->envv
		1650
		1651	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1652
		1653	=item @argv = $term->argv
		1654
		1655	Return the argument vector as this terminal, similar to @ARGV, but
		1656	includes the program name as first element.
		1657
1316	=cut	1658	=cut
1317		1659
1318	sub env {	1660	sub env {
1319	if (my $env = $_[0]->_env) {
1320	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1321	} else {
1322	+{ %ENV }
1323	}
1324	}	1662	}
1325		1663
1326	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1327		1665
1328	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
1329		1667
1330	=item $modifiermask = $term->ModNumLockMask	1668	=item $modifiermask = $term->ModNumLockMask
1331		1669
1332	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1670	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1671	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1672
		1673	=item $screen = $term->current_screen
		1674
		1675	Returns the currently displayed screen (0 primary, 1 secondary).
		1676
		1677	=item $cursor_is_hidden = $term->hidden_cursor
		1678
		1679	Returns whether the cursor is currently hidden or not.
1334		1680
1335	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1336		1682
1337	Returns the row number of the topmost displayed line. Maximum value is	1683	Returns the row number of the topmost displayed line. Maximum value is
1338	C<0>, which displays the normal terminal contents. Lower values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1346		1692
1347	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1348		1694
1349	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1350		1696
1351	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1352	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1698	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1353	terminal line. The scrollback buffer starts at line C<-1> and extends to
1354	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1699	terminal line. Nothing will be returned if a nonexistent line
1355	is requested.	1700	is requested.
1356		1701
1357	If C<$new_text> is specified, it will replace characters in the current	1702	If C<$new_text> is specified, it will replace characters in the current
1358	line, starting at column C<$start_col> (default C<0>), which is useful	1703	line, starting at column C<$start_col> (default C<0>), which is useful
1359	to replace only parts of a line. The font index in the rendition will	1704	to replace only parts of a line. The font index in the rendition will
1360	automatically be updated.	1705	automatically be updated.
1361		1706
1362	C<$text> is in a special encoding: tabs and wide characters that use more	1707	C<$text> is in a special encoding: tabs and wide characters that use more
1363	than one cell when displayed are padded with urxvt::NOCHAR characters	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364	(C<chr 65535>). Characters with combining characters and other characters	1709	characters. Characters with combining characters and other characters that
1365	that do not fit into the normal tetx encoding will be replaced with	1710	do not fit into the normal text encoding will be replaced with characters
1366	characters in the private use area.	1711	in the private use area.
1367		1712
1368	You have to obey this encoding when changing text. The advantage is	1713	You have to obey this encoding when changing text. The advantage is
1369	that C<substr> and similar functions work on screen cells and not on	1714	that C<substr> and similar functions work on screen cells and not on
1370	characters.	1715	characters.
1371		1716
…		…
1515	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1516	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1517		1862
1518	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1519		1864
1520	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1521	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1522		1867
1523	=item $success = $term->grab_button ($button, $modifiermask)	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1524		1869
		1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1871
1525	Registers a synchronous button grab. See the XGrabButton manpage.	1872	Register/unregister a synchronous button grab. See the XGrabButton
		1873	manpage.
1526		1874
1527	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1528		1876
1529	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1530	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1531		1879
1532	=item $term->allow_events_async	1880	=item $term->allow_events_async
1533		1881
1534	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1535		1883
…		…
1542	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1543	recent grab.	1891	recent grab.
1544		1892
1545	=item $term->ungrab	1893	=item $term->ungrab
1546		1894
1547	Calls XUngrab for the most recent grab. Is called automatically on	1895	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1548	evaluation errors, as it is better to lose the grab in the error case as	1896	evaluation errors, as it is better to lose the grab in the error case as
1549	the session.	1897	the session.
		1898
		1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1900
		1901	=item $atom_name = $term->XGetAtomName ($atom)
		1902
		1903	=item @atoms = $term->XListProperties ($window)
		1904
		1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1906
		1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1908
		1909	=item $term->XDeleteProperty ($window, $property)
		1910
		1911	=item $window = $term->DefaultRootWindow
		1912
		1913	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1914
		1915	=item $term->XMapWindow ($window)
		1916
		1917	=item $term->XUnmapWindow ($window)
		1918
		1919	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1920
		1921	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1922
		1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1924
		1925	Various X or X-related functions. The C<$term> object only serves as
		1926	the source of the display, otherwise those functions map more-or-less
		1927	directly onto the X functions of the same name.
1550		1928
1551	=back	1929	=back
1552		1930
1553	=cut	1931	=cut
1554		1932
…		…
1618	my ($self, $text, $cb) = @_;	1996	my ($self, $text, $cb) = @_;
1619		1997
1620	$self->add_item ({ type => "button", text => $text, activate => $cb});	1998	$self->add_item ({ type => "button", text => $text, activate => $cb});
1621	}	1999	}
1622		2000
1623	=item $popup->add_toggle ($text, $cb, $initial_value)	2001	=item $popup->add_toggle ($text, $initial_value, $cb)
1624		2002
1625	Adds a toggle/checkbox item to the popup. Teh callback gets called	2003	Adds a toggle/checkbox item to the popup. The callback gets called
1626	whenever it gets toggled, with a boolean indicating its value as its first	2004	whenever it gets toggled, with a boolean indicating its new value as its
1627	argument.	2005	first argument.
1628		2006
1629	=cut	2007	=cut
1630		2008
1631	sub add_toggle {	2009	sub add_toggle {
1632	my ($self, $text, $cb, $value) = @_;	2010	my ($self, $text, $value, $cb) = @_;
1633		2011
1634	my $item; $item = {	2012	my $item; $item = {
1635	type => "button",	2013	type => "button",
1636	text => " $text",	2014	text => " $text",
1637	value => $value,	2015	value => $value,
…		…
1656	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1657	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1658	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1659	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1660		2038
1661	urxvt::term->new ($env, "popup",	2039	my $term = urxvt::term->new (
		2040	$env, "popup",
1662	"--perl-lib" => "", "--perl-ext-common" => "",	2041	"--perl-lib" => "", "--perl-ext-common" => "",
1663	"-pty-fd" => -1, "-sl" => 0,	2042	"-pty-fd" => -1, "-sl" => 0,
1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1665	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1666	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1667	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1668	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1669	}	2054	}
1670		2055
1671	sub DESTROY {	2056	sub DESTROY {
1672	my ($self) = @_;	2057	my ($self) = @_;
1673		2058
…		…
1678	=back	2063	=back
1679		2064
1680	=cut	2065	=cut
1681		2066
1682	package urxvt::watcher;	2067	package urxvt::watcher;
1683
1684	@urxvt::timer::ISA = __PACKAGE__;
1685	@urxvt::iow::ISA = __PACKAGE__;
1686	@urxvt::pw::ISA = __PACKAGE__;
1687	@urxvt::iw::ISA = __PACKAGE__;
1688		2068
1689	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1690		2070
1691	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1692	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1696	->new	2076	->new
1697	->interval (1)	2077	->interval (1)
1698	->cb (sub {	2078	->cb (sub {
1699	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1700	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1701	});	2081	});
1702		2082
1703	=over 4	2083	=over 4
1704		2084
1705	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1706		2086
…		…
1709		2089
1710	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1711		2091
1712	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1713		2093
1714	=item $tstamp = $timer->at
1715
1716	Return the time this watcher will fire next.
1717
1718	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1719		2095
1720	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1721		2098
1722	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1723		2100
1724	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	By default (and when C<$interval> is C<0>), the timer will automatically
1725	stop after it has fired once. If C<$interval> is non-zero, then the timer	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1726	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1727		2104
1728	=item $timer = $timer->start	2105	=item $timer = $timer->start
1729		2106
1730	Start the timer.	2107	Start the timer.
1731		2108
1732	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1733		2110
1734	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
1735		2113
1736	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
1737		2115
1738	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1739		2117
1740	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1741		2119
…		…
1749		2127
1750	$term->{socket} = ...	2128	$term->{socket} = ...
1751	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1752	->new	2130	->new
1753	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1754	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1755	->start	2133	->start
1756	->cb (sub {	2134	->cb (sub {
1757	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1758	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1759	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1772	Set the callback to be called when io events are triggered. C<$reventmask>	2150	Set the callback to be called when io events are triggered. C<$reventmask>
1773	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1774		2152
1775	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1776		2154
1777	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1778		2156
1779	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1780		2158
1781	Set the event mask to watch. The only allowed values are	2159	Set the event mask to watch. The only allowed values are
1782	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1783	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1784		2162
1785	=item $iow = $iow->start	2163	=item $iow = $iow->start
1786		2164
1787	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1788		2166
1789	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1790		2168
1791	Stop watching for events on the given filehandle.	2169	Stop watching for events on the given file handle.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::iw> Class
		2174
		2175	This class implements idle watchers, that get called automatically when
		2176	the process is idle. They should return as fast as possible, after doing
		2177	some useful work.
		2178
		2179	=over 4
		2180
		2181	=item $iw = new urxvt::iw
		2182
		2183	Create a new idle watcher object in stopped state.
		2184
		2185	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2186
		2187	Set the callback to be called when the watcher triggers.
		2188
		2189	=item $timer = $timer->start
		2190
		2191	Start the watcher.
		2192
		2193	=item $timer = $timer->stop
		2194
		2195	Stop the watcher.
		2196
		2197	=back
		2198
		2199	=head2 The C<urxvt::pw> Class
		2200
		2201	This class implements process watchers. They create an event whenever a
		2202	process exits, after which they stop automatically.
		2203
		2204	my $pid = fork;
		2205	...
		2206	$term->{pw} = urxvt::pw
		2207	->new
		2208	->start ($pid)
		2209	->cb (sub {
		2210	my ($pw, $exit_status) = @_;
		2211	...
		2212	});
		2213
		2214	=over 4
		2215
		2216	=item $pw = new urxvt::pw
		2217
		2218	Create a new process watcher in stopped state.
		2219
		2220	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2221
		2222	Set the callback to be called when the timer triggers.
		2223
		2224	=item $pw = $timer->start ($pid)
		2225
		2226	Tells the watcher to start watching for process C<$pid>.
		2227
		2228	=item $pw = $pw->stop
		2229
		2230	Stop the watcher.
1792		2231
1793	=back	2232	=back
1794		2233
1795	=head1 ENVIRONMENT	2234	=head1 ENVIRONMENT
1796		2235
…		…
1805		2244
1806	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
1807		2246
1808	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
1809		2248
1810	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
1811		2250
1812	=back	2251	=back
1813		2252
1814	=head1 AUTHOR	2253	=head1 AUTHOR
1815		2254
…		…
1817	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
1818		2257
1819	=cut	2258	=cut
1820		2259
1821	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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