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.110 by root, Thu Jan 19 16:22:13 2006 UTC vs.
Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 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
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	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
62	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
63	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
64	between two vertical bars:	71	between two vertical bars:
65		72
66	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: ^(/[^:]+):\
67		81
68	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
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	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
86	runtime.	100	runtime.
87		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
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	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
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	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
95	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
96	popup is displayed.	127	popup is being displayed.
97		128
98	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
99	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.
100	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
101	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
102	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
103		134
104	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
105	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
106	C<a>s:	137	C<a>s:
107		138
108	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
109	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
110	: ()	141	: ()
111	};	142	};
112		143
113	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
114		145
…		…
121	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>
122	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
123	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
124	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
125	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
126	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.
127		189
128	=item selection-autotransform	190	=item selection-autotransform
129		191
130	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
131	whenever a selection is made.	193	whenever a selection is made.
…		…
158		220
159	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
160	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
161	the message into vi commands to load the file.	223	the message into vi commands to load the file.
162		224
163	=item mark-urls	225	=item tabbed
164		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
165	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
166	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
167	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
168	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.
169		258
170	=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.
171		263
172	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.
173	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.
174	a custom pixmap. No scaling is supported in this mode. Exmaple:
175		266
176	@@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.
177		313
178	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
179		315
180	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
181	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
182	similar-looking ascii character.	318	similar-looking ascii character.
183		319
184	=item digital-clock	320	=item digital-clock
185		321
186	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.
187		391
188	=item example-refresh-hooks	392	=item example-refresh-hooks
189		393
190	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
191	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
192	overlays or changes.	396	overlays or changes.
193
194	=item selection-pastebin
195
196	This is a little rarely useful extension that Uploads the selection as
197	textfile to a remote site (or does other things). (The implementation is
198	not currently secure for use in a multiuser environment as it writes to
199	F</tmp> directly.).
200
201	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
202	i.e.
203
204	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
205
206	Pressing this combination runs a command with C<%> replaced by the name of
207	the textfile. This command can be set via a resource:
208
209	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
210
211	And the default is likely not useful to anybody but the few people around
212	here :)
213
214	The name of the textfile is the hex encoded md5 sum of the selection, so
215	the same content should lead to the same filename.
216
217	After a successful upload the selection will be replaced by the text given
218	in the C<selection-pastebin-url> resource (again, the % is the placeholder
219	for the filename):
220
221	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
222		397
223	=back	398	=back
224		399
225	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
226		401
…		…
242		417
243	=over 4	418	=over 4
244		419
245	=item $text	420	=item $text
246		421
247	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
248	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
249		424
250	=item $string	425	=item $string
251		426
252	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
260		435
261	=back	436	=back
262		437
263	=head2 Extension Objects	438	=head2 Extension Objects
264		439
265	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
266	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
267	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
268	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
269	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
270	use.	446	internal use.
271		447
272	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
273	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
274		450
275	It has the following methods and data members:	451	It has the following methods and data members:
…		…
296	=head2 Hooks	472	=head2 Hooks
297		473
298	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
299	called whenever the relevant event happens.	475	called whenever the relevant event happens.
300		476
301	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
302	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
303		479
304	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
305	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
306	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
307		483
308	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
309		485
310	=over 4	486	=over 4
311		487
312	=item on_init $term	488	=item on_init $term
313		489
314	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
315	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
316	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
317	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
318	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
319		506
320	=item on_reset $term	507	=item on_reset $term
321		508
322	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
323	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
324	variables.	511	variables.
325		512
326	=item on_start $term
327
328	Called at the very end of initialisation of a new terminal, just before
329	returning to the mainloop.
330
331	=item on_child_start $term, $pid	513	=item on_child_start $term, $pid
332		514
333	Called just after the child process has been C<fork>ed.	515	Called just after the child process has been C<fork>ed.
334		516
335	=item on_child_exit $term, $status	517	=item on_child_exit $term, $status
…		…
350		532
351	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
352	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
353	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
354		536
355	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
356		538
357	=item on_sel_extend $term	539	=item on_sel_extend $term
358		540
359	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
360	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
361	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
362	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
363	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
364	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
365		547
366	See the F<selection> example extension.	548	See the F<selection> example extension.
367		549
368	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
369		551
370	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
371	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
372	show this many lines of scrollback.	554	show this many lines of scrollback.
373		555
374	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
375		557
…		…
379		561
380	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
381	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
382	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
383		565
384	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
385		577
386	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
387	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
388	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
389	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
390	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
391	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
392		594
393	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
394	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
395	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
396		601
397	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
398		603
399	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
400	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
421	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
422	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
423		628
424	=item on_refresh_begin $term	629	=item on_refresh_begin $term
425		630
426	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
427	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
428	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
429	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
430		635
431	=item on_refresh_end $term	636	=item on_refresh_end $term
432		637
433	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
434		639
435	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
436		641
437	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
438	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
439	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $term, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
440		654
441	=item on_x_event $term, $event	655	=item on_x_event $term, $event
442		656
443	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
444	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
445	members are not passed.	659	members are not passed.
446		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
447	=item on_focus_in $term	665	=item on_focus_in $term
448		666
449	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
450	does focus in processing.	668	does focus in processing.
451		669
452	=item on_focus_out $term	670	=item on_focus_out $term
453		671
454	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
455	focus out processing.	673	focus out processing.
456		674
457	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
458		676
		677	=item on_property_notify $term, $event
		678
459	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
460		680
461	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
462		682
463	=item on_button_press $term, $event	683	=item on_button_press $term, $event
…		…
468		688
469	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
470		690
471	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
472		692
473	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
474	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
475		695
476	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
477	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
478	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
479		699
480	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
481	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
482		702
483	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
484		717
485	=back	718	=back
486		719
487	=cut	720	=cut
488		721
…		…
494	use Scalar::Util ();	727	use Scalar::Util ();
495	use List::Util ();	728	use List::Util ();
496		729
497	our $VERSION = 1;	730	our $VERSION = 1;
498	our $TERM;	731	our $TERM;
		732	our @TERM_INIT;
		733	our @TERM_EXT;
499	our @HOOKNAME;	734	our @HOOKNAME;
500	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	735	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
501	our %OPTION;	736	our %OPTION;
502		737
503	our $LIBDIR;	738	our $LIBDIR;
504	our $RESNAME;	739	our $RESNAME;
505	our $RESCLASS;	740	our $RESCLASS;
506	our $RXVTNAME;	741	our $RXVTNAME;
507		742
		743	our $NOCHAR = chr 0xffff;
		744
508	=head2 Variables in the C<urxvt> Package	745	=head2 Variables in the C<urxvt> Package
509		746
510	=over 4	747	=over 4
511		748
512	=item $urxvt::LIBDIR	749	=item $urxvt::LIBDIR
…		…
524		761
525	=item $urxvt::TERM	762	=item $urxvt::TERM
526		763
527	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
528	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
		766
		767	=item @urxvt::TERM_INIT
		768
		769	All code references in this array will be called as methods of the next newly
		770	created C<urxvt::term> object (during the C<on_init> phase). The array
		771	gets cleared before the code references that were in it are being executed,
		772	so references can push themselves onto it again if they so desire.
		773
		774	This complements to the perl-eval command line option, but gets executed
		775	first.
		776
		777	=item @urxvt::TERM_EXT
		778
		779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		780	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		781	but before other extensions. Gets cleared just like C<@TERM_INIT>.
529		782
530	=back	783	=back
531		784
532	=head2 Functions in the C<urxvt> Package	785	=head2 Functions in the C<urxvt> Package
533		786
…		…
547		800
548	Using this function has the advantage that its output ends up in the	801	Using this function has the advantage that its output ends up in the
549	correct place, e.g. on stderr of the connecting urxvtc client.	802	correct place, e.g. on stderr of the connecting urxvtc client.
550		803
551	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
		805
		806	=item @terms = urxvt::termlist
		807
		808	Returns all urxvt::term objects that exist in this process, regardless of
		809	whether they are started, being destroyed etc., so be careful. Only term
		810	objects that have perl extensions attached will be returned (because there
		811	is no urxvt::term objet associated with others).
552		812
553	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
554		814
555	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
556		816
…		…
614	Return the foreground/background colour index, respectively.	874	Return the foreground/background colour index, respectively.
615		875
616	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
617		877
618	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	878	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		879
		880	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
619		881
620	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
621	specified one.	883	specified one.
622		884
623	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
…		…
642	unless $msg =~ /\n$/;	904	unless $msg =~ /\n$/;
643	urxvt::warn ($msg);	905	urxvt::warn ($msg);
644	};	906	};
645	}	907	}
646		908
		909	no warnings 'utf8';
		910
647	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	911	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
648		912
649	sub verbose {	913	sub verbose {
650	my ($level, $msg) = @_;	914	my ($level, $msg) = @_;
651	warn "$msg\n" if $level <= $verbosity;	915	warn "$msg\n" if $level <= $verbosity;
…		…
654	my %extension_pkg;	918	my %extension_pkg;
655		919
656	# load a single script into its own package, once only	920	# load a single script into its own package, once only
657	sub extension_package($) {	921	sub extension_package($) {
658	my ($path) = @_;	922	my ($path) = @_;
659
660	no strict 'refs';
661		923
662	$extension_pkg{$path} ||= do {	924	$extension_pkg{$path} ||= do {
663	$path =~ /([^\/\\]+)$/;	925	$path =~ /([^\/\\]+)$/;
664	my $pkg = $1;	926	my $pkg = $1;
665	$pkg =~ s/[^[:word:]]/_/g;	927	$pkg =~ s/[^[:word:]]/_/g;
…		…
668	verbose 3, "loading extension '$path' into package '$pkg'";	930	verbose 3, "loading extension '$path' into package '$pkg'";
669		931
670	open my $fh, "<:raw", $path	932	open my $fh, "<:raw", $path
671	or die "$path: $!";	933	or die "$path: $!";
672		934
673	@{"$pkg\::ISA"} = urxvt::term::extension::;
674
675	my $source =	935	my $source =
676	"package $pkg; use strict; use utf8;\n"	936	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
677	. "#line 1 \"$path\"\n{\n"	937	. "#line 1 \"$path\"\n{\n"
678	. (do { local $/; <$fh> })	938	. (do { local $/; <$fh> })
679	. "\n};\n1";	939	. "\n};\n1";
680		940
681	eval $source	941	eval $source
…		…
692	local $TERM = shift;	952	local $TERM = shift;
693	my $htype = shift;	953	my $htype = shift;
694		954
695	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
696	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
697		957
698	my %ext_arg;	958	my %ext_arg;
699		959
		960	{
		961	my @init = @TERM_INIT;
		962	@TERM_INIT = ();
		963	$_->($TERM) for @init;
		964	my @pkg = @TERM_EXT;
		965	@TERM_EXT = ();
		966	$TERM->register_package ($_) for @pkg;
		967	}
		968
700	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	969	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
701	if ($_ eq "default") {	970	if ($_ eq "default") {
702	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	971	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
703	} elsif (/^-(.*)$/) {	972	} elsif (/^-(.*)$/) {
704	delete $ext_arg{$1};	973	delete $ext_arg{$1};
705	} elsif (/^([^<]+)<(.*)>$/) {	974	} elsif (/^([^<]+)<(.*)>$/) {
706	push @{ $ext_arg{$1} }, $2;	975	push @{ $ext_arg{$1} }, $2;
707	} else {	976	} else {
708	$ext_arg{$_} ||= [];	977	$ext_arg{$_} ||= [];
709	}	978	}
710	}	979	}
711		980
712	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
713	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
714		983
715	if (@files) {	984	if (@files) {
716	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
717	} else {	986	} else {
718	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
719	}	988	}
720	}	989	}
721		990
…		…
727		996
728	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
729	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
730	if $verbosity >= 10;	999	if $verbosity >= 10;
731		1000
732	keys %$cb;	1001	for my $pkg (keys %$cb) {
733
734	while (my ($pkg, $cb) = each %$cb) {
735	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
736	and last;	1003	$retval ||= $retval_;
737		1004
738	if ($@) {	1005	if ($@) {
739	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
740	warn $@;	1007	warn $@;
741	}	1008	}
…		…
752	# clear package	1019	# clear package
753	%$TERM = ();	1020	%$TERM = ();
754	}	1021	}
755		1022
756	$retval	1023	$retval
		1024	}
		1025
		1026	sub SET_COLOR($$$) {
		1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
		1029
		1030	sub rend2mask {
		1031	no strict 'refs';
		1032	my ($str, $mask) = (@_, 0);
		1033	my %color = ( fg => undef, bg => undef );
		1034	my @failed;
		1035	for my $spec ( split /\s+/, $str ) {
		1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask |= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
757	}	1053	}
758		1054
759	# urxvt::term::extension	1055	# urxvt::term::extension
760		1056
761	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
832	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
833	work.	1129	work.
834		1130
835	=cut	1131	=cut
836		1132
837	our $VERSION = 1;	1133	our $VERSION = '5.23';
838		1134
839	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
840	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
841		1137
842	sub timer {	1138	sub timer {
…		…
844		1140
845	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
846		1142
847	urxvt::timer	1143	urxvt::timer
848	->new	1144	->new
849	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
850	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
851	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
852	$cb->();	1148	$cb->();
853	})	1149	})
854	}	1150	}
855		1151
856	sub io {	1152	sub io {
857	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
858		1154
859	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
860		1158
861	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
862	->new	1160	->new
863	->fd (fileno $arg{fh})	1161	->fd ($fd)
864	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
865	| ($arg{poll} =~ /w/ ? 2 : 0))	1163	| ($arg{poll} =~ /w/ ? 2 : 0))
866	->start	1164	->start
867	->cb (sub {	1165	->cb ($cb)
868	$cb->(($_[1] & 1 ? 'r' : '')
869	. ($_[1] & 2 ? 'w' : ''));
870	})],
871	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
872	}	1192	}
873		1193
874	sub DESTROY {	1194	sub DESTROY {
875	$_[0][1]->stop;	1195	$_[0][1]->stop;
876	}	1196	}
877		1197
878	sub condvar {	1198	sub one_event {
879	bless \my $flag, urxvt::anyevent::condvar::
880	}
881
882	sub urxvt::anyevent::condvar::broadcast {
883	${$_[0]}++;
884	}
885
886	sub urxvt::anyevent::condvar::wait {
887	unless (${$_[0]}) {
888	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
889	}
890	}	1200	}
891		1201
892	package urxvt::term;	1202	package urxvt::term;
893		1203
894	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
899		1209
900	# find on_xxx subs in the package and register them	1210	# find on_xxx subs in the package and register them
901	# as hooks	1211	# as hooks
902	sub register_package {	1212	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1213	my ($self, $pkg, $argv) = @_;
		1214
		1215	no strict 'refs';
		1216
		1217	urxvt::verbose 6, "register package $pkg to $self";
		1218
		1219	@{"$pkg\::ISA"} = urxvt::term::extension::;
904		1220
905	my $proxy = bless {	1221	my $proxy = bless {
906	_pkg => $pkg,	1222	_pkg => $pkg,
907	argv => $argv,	1223	argv => $argv,
908	}, $pkg;	1224	}, $pkg;
…		…
924	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
925		1241
926	Croaks (and probably outputs an error message) if the new instance	1242	Croaks (and probably outputs an error message) if the new instance
927	couldn't be created. Returns C<undef> if the new instance didn't	1243	couldn't be created. Returns C<undef> if the new instance didn't
928	initialise perl, and the terminal object otherwise. The C<init> and	1244	initialise perl, and the terminal object otherwise. The C<init> and
929	C<start> hooks will be called during this call.	1245	C<start> hooks will be called before this call returns, and are free to
		1246	refer to global data (which is race free).
930		1247
931	=cut	1248	=cut
932		1249
933	sub new {	1250	sub new {
934	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
935		1252
		1253	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1254	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1255
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1257	}
938		1258
939	=item $term->destroy	1259	=item $term->destroy
940		1260
941	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
…		…
971		1291
972	Returns true if the option specified by C<$optval> is enabled, and	1292	Returns true if the option specified by C<$optval> is enabled, and
973	optionally change it. All option values are stored by name in the hash	1293	optionally change it. All option values are stored by name in the hash
974	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
975		1295
976	Here is a a likely non-exhaustive list of option names, please see the	1296	Here is a likely non-exhaustive list of option names, please see the
977	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
978		1298
979	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
980	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
981	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
998	likely change).	1318	likely change).
999		1319
1000	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
1001	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1002		1322
1003	Here is a a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1004	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1005	to see the actual list:	1325	to see the actual list:
1006		1326
1007	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1008	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1009	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1010	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1011	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1012	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1013	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1014	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1015	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1016	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1017	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1018	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1019	visualBell	1339	visualBell
1020		1340
1021	=cut	1341	=cut
1022		1342
1023	sub resource($$;$) {	1343	sub resource($$;$) {
1024	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1025	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1026	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1027	}	1347	}
1028		1348
1029	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1030		1350
1031	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1056		1376
1057	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1058		1378
1059	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1060		1380
1061	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1062	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1063		1390
1064	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1065		1392
1066	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1067	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1068	rectangular selection will be made. This is the prefered function to make	1395	rectangular selection will be made. This is the preferred function to make
1069	a selection.	1396	a selection.
1070		1397
1071	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1072		1399
1073	Try to request the primary selection text from the server (for example, as	1400	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1401	true) selection from the server. The corresponding text can be set
1074	set by the next method). No visual feedback will be given. This function	1402	with the next method. No visual feedback will be given. This function
1075	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1076		1404
1077	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1078		1406
1079	Return the current selection text and optionally replace it by C<$newtext>.	1407	Return the current selection (clipboard if C<$clipboard> is true) text
		1408	and optionally replace it by C<$newtext>.
		1409
		1410	=item $term->selection_clear ([$clipboard])
		1411
		1412	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1080		1413
1081	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1082		1415
1083	Create a simple multi-line overlay box. See the next method for details.	1416	Create a simple multi-line overlay box. See the next method for details.
1084		1417
…		…
1114		1447
1115	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1116		1449
1117	=over 4	1450	=over 4
1118		1451
1119	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1120		1453
1121	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1454	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1122	text in rxvt-unicode's special encoding and an array of rendition values	1455	text in rxvt-unicode's special encoding and an array of rendition values
1123	at a specific position inside the overlay.	1456	at a specific position inside the overlay.
		1457
		1458	If C<$rend> is missing, then the rendition will not be changed.
1124		1459
1125	=item $overlay->hide	1460	=item $overlay->hide
1126		1461
1127	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1128		1463
…		…
1198		1533
1199	Normally its not a good idea to use this function, as programs might be	1534	Normally its not a good idea to use this function, as programs might be
1200	confused by changes in cursor position or scrolling. Its useful inside a	1535	confused by changes in cursor position or scrolling. Its useful inside a
1201	C<on_add_lines> hook, though.	1536	C<on_add_lines> hook, though.
1202		1537
		1538	=item $term->scr_change_screen ($screen)
		1539
		1540	Switch to given screen - 0 primary, 1 secondary.
		1541
1203	=item $term->cmd_parse ($octets)	1542	=item $term->cmd_parse ($octets)
1204		1543
1205	Similar to C<scr_add_lines>, but the argument must be in the	1544	Similar to C<scr_add_lines>, but the argument must be in the
1206	locale-specific encoding of the terminal and can contain command sequences	1545	locale-specific encoding of the terminal and can contain command sequences
1207	(escape codes) that will be interpreted.	1546	(escape codes) that will be interpreted.
1208		1547
1209	=item $term->tt_write ($octets)	1548	=item $term->tt_write ($octets)
1210		1549
1211	Write the octets given in C<$data> to the tty (i.e. as program input). To	1550	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1212	pass characters instead of octets, you should convert your strings first	1551	pass characters instead of octets, you should convert your strings first
1213	to the locale-specific encoding using C<< $term->locale_encode >>.	1552	to the locale-specific encoding using C<< $term->locale_encode >>.
1214		1553
1215	=item $old_events = $term->pty_ev_events ([$new_events])	1554	=item $old_events = $term->pty_ev_events ([$new_events])
1216		1555
1217	Replaces the event mask of the pty watcher by the given event mask. Can	1556	Replaces the event mask of the pty watcher by the given event mask. Can
1218	be used to suppress input and output handling to the pty/tty. See the	1557	be used to suppress input and output handling to the pty/tty. See the
1219	description of C<< urxvt::timer->events >>. Make sure to always restore	1558	description of C<< urxvt::timer->events >>. Make sure to always restore
1220	the previous value.	1559	the previous value.
1221		1560
		1561	=item $fd = $term->pty_fd
		1562
		1563	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1564	is used.
		1565
1222	=item $windowid = $term->parent	1566	=item $windowid = $term->parent
1223		1567
1224	Return the window id of the toplevel window.	1568	Return the window id of the toplevel window.
1225		1569
1226	=item $windowid = $term->vt	1570	=item $windowid = $term->vt
…		…
1232	Adds the specified events to the vt event mask. Useful e.g. when you want	1576	Adds the specified events to the vt event mask. Useful e.g. when you want
1233	to receive pointer events all the times:	1577	to receive pointer events all the times:
1234		1578
1235	$term->vt_emask_add (urxvt::PointerMotionMask);	1579	$term->vt_emask_add (urxvt::PointerMotionMask);
1236		1580
		1581	=item $term->focus_in
		1582
		1583	=item $term->focus_out
		1584
		1585	=item $term->key_press ($state, $keycode[, $time])
		1586
		1587	=item $term->key_release ($state, $keycode[, $time])
		1588
		1589	Deliver various fake events to to terminal.
		1590
1237	=item $window_width = $term->width	1591	=item $window_width = $term->width
1238		1592
1239	=item $window_height = $term->height	1593	=item $window_height = $term->height
1240		1594
1241	=item $font_width = $term->fwidth	1595	=item $font_width = $term->fwidth
…		…
1271	=item $env = $term->env	1625	=item $env = $term->env
1272		1626
1273	Returns a copy of the environment in effect for the terminal as a hashref	1627	Returns a copy of the environment in effect for the terminal as a hashref
1274	similar to C<\%ENV>.	1628	similar to C<\%ENV>.
1275		1629
		1630	=item @envv = $term->envv
		1631
		1632	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1633
		1634	=item @argv = $term->argv
		1635
		1636	Return the argument vector as this terminal, similar to @ARGV, but
		1637	includes the program name as first element.
		1638
1276	=cut	1639	=cut
1277		1640
1278	sub env {	1641	sub env {
1279	if (my $env = $_[0]->_env) {
1280	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1642	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1281	} else {
1282	+{ %ENV }
1283	}
1284	}	1643	}
1285		1644
1286	=item $modifiermask = $term->ModLevel3Mask	1645	=item $modifiermask = $term->ModLevel3Mask
1287		1646
1288	=item $modifiermask = $term->ModMetaMask	1647	=item $modifiermask = $term->ModMetaMask
1289		1648
1290	=item $modifiermask = $term->ModNumLockMask	1649	=item $modifiermask = $term->ModNumLockMask
1291		1650
1292	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1651	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1293	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1652	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1653
		1654	=item $screen = $term->current_screen
		1655
		1656	Returns the currently displayed screen (0 primary, 1 secondary).
		1657
		1658	=item $cursor_is_hidden = $term->hidden_cursor
		1659
		1660	Returns whether the cursor is currently hidden or not.
1294		1661
1295	=item $view_start = $term->view_start ([$newvalue])	1662	=item $view_start = $term->view_start ([$newvalue])
1296		1663
1297	Returns the row number of the topmost displayed line. Maximum value is	1664	Returns the row number of the topmost displayed line. Maximum value is
1298	C<0>, which displays the normal terminal contents. Lower values scroll	1665	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1306		1673
1307	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1308		1675
1309	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1310		1677
1311	Returns the text of the entire row with number C<$row_number>. Row C<0>	1678	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1312	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1679	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1313	terminal line. The scrollback buffer starts at line C<-1> and extends to
1314	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1315	is requested.	1681	is requested.
1316		1682
1317	If C<$new_text> is specified, it will replace characters in the current	1683	If C<$new_text> is specified, it will replace characters in the current
1318	line, starting at column C<$start_col> (default C<0>), which is useful	1684	line, starting at column C<$start_col> (default C<0>), which is useful
1319	to replace only parts of a line. The font index in the rendition will	1685	to replace only parts of a line. The font index in the rendition will
1320	automatically be updated.	1686	automatically be updated.
1321		1687
1322	C<$text> is in a special encoding: tabs and wide characters that use more	1688	C<$text> is in a special encoding: tabs and wide characters that use more
1323	than one cell when displayed are padded with urxvt::NOCHAR characters	1689	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1324	(C<chr 65535>). Characters with combining characters and other characters	1690	characters. Characters with combining characters and other characters that
1325	that do not fit into the normal tetx encoding will be replaced with	1691	do not fit into the normal text encoding will be replaced with characters
1326	characters in the private use area.	1692	in the private use area.
1327		1693
1328	You have to obey this encoding when changing text. The advantage is	1694	You have to obey this encoding when changing text. The advantage is
1329	that C<substr> and similar functions work on screen cells and not on	1695	that C<substr> and similar functions work on screen cells and not on
1330	characters.	1696	characters.
1331		1697
…		…
1475	where one character corresponds to one screen cell. See	1841	where one character corresponds to one screen cell. See
1476	C<< $term->ROW_t >> for details.	1842	C<< $term->ROW_t >> for details.
1477		1843
1478	=item $string = $term->special_decode $text	1844	=item $string = $term->special_decode $text
1479		1845
1480	Converts rxvt-unicodes text reprsentation into a perl string. See	1846	Converts rxvt-unicodes text representation into a perl string. See
1481	C<< $term->ROW_t >> for details.	1847	C<< $term->ROW_t >> for details.
1482		1848
1483	=item $success = $term->grab_button ($button, $modifiermask)	1849	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1484		1850
		1851	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1852
1485	Registers a synchronous button grab. See the XGrabButton manpage.	1853	Register/unregister a synchronous button grab. See the XGrabButton
		1854	manpage.
1486		1855
1487	=item $success = $term->grab ($eventtime[, $sync])	1856	=item $success = $term->grab ($eventtime[, $sync])
1488		1857
1489	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1858	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1490	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1859	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1491		1860
1492	=item $term->allow_events_async	1861	=item $term->allow_events_async
1493		1862
1494	Calls XAllowEvents with AsyncBoth for the most recent grab.	1863	Calls XAllowEvents with AsyncBoth for the most recent grab.
1495		1864
…		…
1502	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1503	recent grab.	1872	recent grab.
1504		1873
1505	=item $term->ungrab	1874	=item $term->ungrab
1506		1875
1507	Calls XUngrab for the most recent grab. Is called automatically on	1876	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1508	evaluation errors, as it is better to lose the grab in the error case as	1877	evaluation errors, as it is better to lose the grab in the error case as
1509	the session.	1878	the session.
		1879
		1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1881
		1882	=item $atom_name = $term->XGetAtomName ($atom)
		1883
		1884	=item @atoms = $term->XListProperties ($window)
		1885
		1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1887
		1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1889
		1890	=item $term->XDeleteProperty ($window, $property)
		1891
		1892	=item $window = $term->DefaultRootWindow
		1893
		1894	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1895
		1896	=item $term->XMapWindow ($window)
		1897
		1898	=item $term->XUnmapWindow ($window)
		1899
		1900	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1901
		1902	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1903
		1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1905
		1906	Various X or X-related functions. The C<$term> object only serves as
		1907	the source of the display, otherwise those functions map more-or-less
		1908	directly onto the X functions of the same name.
1510		1909
1511	=back	1910	=back
1512		1911
1513	=cut	1912	=cut
1514		1913
…		…
1578	my ($self, $text, $cb) = @_;	1977	my ($self, $text, $cb) = @_;
1579		1978
1580	$self->add_item ({ type => "button", text => $text, activate => $cb});	1979	$self->add_item ({ type => "button", text => $text, activate => $cb});
1581	}	1980	}
1582		1981
1583	=item $popup->add_toggle ($text, $cb, $initial_value)	1982	=item $popup->add_toggle ($text, $initial_value, $cb)
1584		1983
1585	Adds a toggle/checkbox item to the popup. Teh callback gets called	1984	Adds a toggle/checkbox item to the popup. The callback gets called
1586	whenever it gets toggled, with a boolean indicating its value as its first	1985	whenever it gets toggled, with a boolean indicating its new value as its
1587	argument.	1986	first argument.
1588		1987
1589	=cut	1988	=cut
1590		1989
1591	sub add_toggle {	1990	sub add_toggle {
1592	my ($self, $text, $cb, $value) = @_;	1991	my ($self, $text, $value, $cb) = @_;
1593		1992
1594	my $item; $item = {	1993	my $item; $item = {
1595	type => "button",	1994	type => "button",
1596	text => " $text",	1995	text => " $text",
1597	value => $value,	1996	value => $value,
…		…
1616	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1617	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2016	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1618	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1619	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1620		2019
1621	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1622	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1623	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1624	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1625	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1626	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1627	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1628	or die "unable to create popup window\n";	2028	) or die "unable to create popup window\n";
		2029
		2030	unless (delete $term->{urxvt_popup_init_done}) {
		2031	$term->ungrab;
		2032	$term->destroy;
		2033	die "unable to initialise popup window\n";
		2034	}
1629	}	2035	}
1630		2036
1631	sub DESTROY {	2037	sub DESTROY {
1632	my ($self) = @_;	2038	my ($self) = @_;
1633		2039
1634	delete $self->{term}{_destroy}{$self};	2040	delete $self->{term}{_destroy}{$self};
1635	$self->{term}->ungrab;	2041	$self->{term}->ungrab;
1636	}	2042	}
1637		2043
1638	=back	2044	=back
		2045
		2046	=cut
		2047
		2048	package urxvt::watcher;
1639		2049
1640	=head2 The C<urxvt::timer> Class	2050	=head2 The C<urxvt::timer> Class
1641		2051
1642	This class implements timer watchers/events. Time is represented as a	2052	This class implements timer watchers/events. Time is represented as a
1643	fractional number of seconds since the epoch. Example:	2053	fractional number of seconds since the epoch. Example:
…		…
1647	->new	2057	->new
1648	->interval (1)	2058	->interval (1)
1649	->cb (sub {	2059	->cb (sub {
1650	$term->{overlay}->set (0, 0,	2060	$term->{overlay}->set (0, 0,
1651	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1652	});	2062	});
1653		2063
1654	=over 4	2064	=over 4
1655		2065
1656	=item $timer = new urxvt::timer	2066	=item $timer = new urxvt::timer
1657		2067
…		…
1660		2070
1661	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1662		2072
1663	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
1664		2074
1665	=item $tstamp = $timer->at
1666
1667	Return the time this watcher will fire next.
1668
1669	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
1670		2076
1671	Set the time the event is generated to $tstamp.	2077	Set the time the event is generated to $tstamp (and optionally specifies a
		2078	new $interval).
1672		2079
1673	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
1674		2081
1675	Normally (and when C<$interval> is C<0>), the timer will automatically	2082	By default (and when C<$interval> is C<0>), the timer will automatically
1676	stop after it has fired once. If C<$interval> is non-zero, then the timer	2083	stop after it has fired once. If C<$interval> is non-zero, then the timer
1677	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
1678		2085
1679	=item $timer = $timer->start	2086	=item $timer = $timer->start
1680		2087
1681	Start the timer.	2088	Start the timer.
1682		2089
1683	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
1684		2091
1685	Set the event trigger time to C<$tstamp> and start the timer.	2092	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2093	also replaces the interval.
1686		2094
1687	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
1688		2096
1689	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2097	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1690		2098
1691	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
1692		2100
…		…
1700		2108
1701	$term->{socket} = ...	2109	$term->{socket} = ...
1702	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
1703	->new	2111	->new
1704	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
1705	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
1706	->start	2114	->start
1707	->cb (sub {	2115	->cb (sub {
1708	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
1709	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
1710	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
1723	Set the callback to be called when io events are triggered. C<$reventmask>	2131	Set the callback to be called when io events are triggered. C<$reventmask>
1724	is a bitset as described in the C<events> method.	2132	is a bitset as described in the C<events> method.
1725		2133
1726	=item $iow = $iow->fd ($fd)	2134	=item $iow = $iow->fd ($fd)
1727		2135
1728	Set the filedescriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
1729		2137
1730	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
1731		2139
1732	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
1733	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2141	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1734	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
1735		2143
1736	=item $iow = $iow->start	2144	=item $iow = $iow->start
1737		2145
1738	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
1739		2147
1740	=item $iow = $iow->stop	2148	=item $iow = $iow->stop
1741		2149
1742	Stop watching for events on the given filehandle.	2150	Stop watching for events on the given file handle.
		2151
		2152	=back
		2153
		2154	=head2 The C<urxvt::iw> Class
		2155
		2156	This class implements idle watchers, that get called automatically when
		2157	the process is idle. They should return as fast as possible, after doing
		2158	some useful work.
		2159
		2160	=over 4
		2161
		2162	=item $iw = new urxvt::iw
		2163
		2164	Create a new idle watcher object in stopped state.
		2165
		2166	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2167
		2168	Set the callback to be called when the watcher triggers.
		2169
		2170	=item $timer = $timer->start
		2171
		2172	Start the watcher.
		2173
		2174	=item $timer = $timer->stop
		2175
		2176	Stop the watcher.
		2177
		2178	=back
		2179
		2180	=head2 The C<urxvt::pw> Class
		2181
		2182	This class implements process watchers. They create an event whenever a
		2183	process exits, after which they stop automatically.
		2184
		2185	my $pid = fork;
		2186	...
		2187	$term->{pw} = urxvt::pw
		2188	->new
		2189	->start ($pid)
		2190	->cb (sub {
		2191	my ($pw, $exit_status) = @_;
		2192	...
		2193	});
		2194
		2195	=over 4
		2196
		2197	=item $pw = new urxvt::pw
		2198
		2199	Create a new process watcher in stopped state.
		2200
		2201	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2202
		2203	Set the callback to be called when the timer triggers.
		2204
		2205	=item $pw = $timer->start ($pid)
		2206
		2207	Tells the watcher to start watching for process C<$pid>.
		2208
		2209	=item $pw = $pw->stop
		2210
		2211	Stop the watcher.
1743		2212
1744	=back	2213	=back
1745		2214
1746	=head1 ENVIRONMENT	2215	=head1 ENVIRONMENT
1747		2216
…		…
1756		2225
1757	=item >= 3 - script loading and management	2226	=item >= 3 - script loading and management
1758		2227
1759	=item >=10 - all called hooks	2228	=item >=10 - all called hooks
1760		2229
1761	=item >=11 - hook reutrn values	2230	=item >=11 - hook return values
1762		2231
1763	=back	2232	=back
1764		2233
1765	=head1 AUTHOR	2234	=head1 AUTHOR
1766		2235
…		…
1768	http://software.schmorp.de/pkg/rxvt-unicode	2237	http://software.schmorp.de/pkg/rxvt-unicode
1769		2238
1770	=cut	2239	=cut
1771		2240
1772	1	2241	1
		2242
		2243	# vim: sw=3:

Diff Legend

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