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.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 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 wether 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
198	=item selection-pastebin
199
200	This is a little rarely useful extension that Uploads the selection as
201	textfile to a remote site (or does other things). (The implementation is
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		397
227	=back	398	=back
228		399
229	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
230		401
…		…
246		417
247	=over 4	418	=over 4
248		419
249	=item $text	420	=item $text
250		421
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	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.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
253		424
254	=item $string	425	=item $string
255		426
256	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
…		…
264		435
265	=back	436	=back
266		437
267	=head2 Extension Objects	438	=head2 Extension Objects
268		439
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
274	use.	446	internal use.
275		447
276	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
277	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
278		450
279	It has the following methods and data members:	451	It has the following methods and data members:
…		…
300	=head2 Hooks	472	=head2 Hooks
301		473
302	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
303	called whenever the relevant event happens.	475	called whenever the relevant event happens.
304		476
305	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
306	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
307		479
308	B<All> of these hooks must return a boolean value. If any of the called	480	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	481	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.	482	relevant action might not be carried out by the C++ code.
…		…
323	place.	495	place.
324		496
325	=item on_start $term	497	=item on_start $term
326		498
327	Called at the very end of initialisation of a new terminal, just before	499	Called at the very end of initialisation of a new terminal, just before
328	returning to the mainloop.	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).
329		506
330	=item on_reset $term	507	=item on_reset $term
331		508
332	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
333	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
…		…
355		532
356	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
357	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
358	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
359		536
360	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.
361		538
362	=item on_sel_extend $term	539	=item on_sel_extend $term
363		540
364	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
365	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
366	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
367	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
368	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
369	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
370		547
371	See the F<selection> example extension.	548	See the F<selection> example extension.
372		549
373	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
374		551
375	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
376	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
377	show this many lines of scrollback.	554	show this many lines of scrollback.
378		555
379	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
380		557
…		…
384		561
385	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,
386	$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
387	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
388		565
389	=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
390		577
391	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
392	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
393	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
394	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,
395	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
396	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	}
397		594
398	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,
399	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
400	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.
401		601
402	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
403		603
404	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
405	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
…		…
426	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
427	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
428		628
429	=item on_refresh_begin $term	629	=item on_refresh_begin $term
430		630
431	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
432	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
433	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
434	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
435		635
436	=item on_refresh_end $term	636	=item on_refresh_end $term
437		637
438	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>.
439		639
440	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
441		641
442	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
443	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>
444	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 $tern, $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.
445		654
446	=item on_x_event $term, $event	655	=item on_x_event $term, $event
447		656
448	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
449	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
450	members are not passed.	659	members are not passed.
451		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
452	=item on_focus_in $term	665	=item on_focus_in $term
453		666
454	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
455	does focus in processing.	668	does focus in processing.
456		669
457	=item on_focus_out $term	670	=item on_focus_out $term
458		671
459	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
460	focus out processing.	673	focus out processing.
461		674
462	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
463		676
		677	=item on_property_notify $term, $event
		678
464	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
465		680
466	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
467		682
468	=item on_button_press $term, $event	683	=item on_button_press $term, $event
…		…
473		688
474	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
475		690
476	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
477		692
478	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
479	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.
480		695
481	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
482	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
483	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
484		699
485	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
486	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
487		702
488	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.
489		717
490	=back	718	=back
491		719
492	=cut	720	=cut
493		721
…		…
499	use Scalar::Util ();	727	use Scalar::Util ();
500	use List::Util ();	728	use List::Util ();
501		729
502	our $VERSION = 1;	730	our $VERSION = 1;
503	our $TERM;	731	our $TERM;
		732	our @TERM_INIT;
		733	our @TERM_EXT;
504	our @HOOKNAME;	734	our @HOOKNAME;
505	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	735	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506	our %OPTION;	736	our %OPTION;
507		737
508	our $LIBDIR;	738	our $LIBDIR;
509	our $RESNAME;	739	our $RESNAME;
510	our $RESCLASS;	740	our $RESCLASS;
511	our $RXVTNAME;	741	our $RXVTNAME;
512		742
		743	our $NOCHAR = chr 0xffff;
		744
513	=head2 Variables in the C<urxvt> Package	745	=head2 Variables in the C<urxvt> Package
514		746
515	=over 4	747	=over 4
516		748
517	=item $urxvt::LIBDIR	749	=item $urxvt::LIBDIR
…		…
529		761
530	=item $urxvt::TERM	762	=item $urxvt::TERM
531		763
532	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
533	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>.
534		782
535	=back	783	=back
536		784
537	=head2 Functions in the C<urxvt> Package	785	=head2 Functions in the C<urxvt> Package
538		786
…		…
552		800
553	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
554	correct place, e.g. on stderr of the connecting urxvtc client.	802	correct place, e.g. on stderr of the connecting urxvtc client.
555		803
556	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).
557		812
558	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
559		814
560	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
561		816
…		…
619	Return the foreground/background colour index, respectively.	874	Return the foreground/background colour index, respectively.
620		875
621	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
622		877
623	=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
624		881
625	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
626	specified one.	883	specified one.
627		884
628	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
…		…
647	unless $msg =~ /\n$/;	904	unless $msg =~ /\n$/;
648	urxvt::warn ($msg);	905	urxvt::warn ($msg);
649	};	906	};
650	}	907	}
651		908
		909	no warnings 'utf8';
		910
652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	911	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
653		912
654	sub verbose {	913	sub verbose {
655	my ($level, $msg) = @_;	914	my ($level, $msg) = @_;
656	warn "$msg\n" if $level <= $verbosity;	915	warn "$msg\n" if $level <= $verbosity;
…		…
659	my %extension_pkg;	918	my %extension_pkg;
660		919
661	# load a single script into its own package, once only	920	# load a single script into its own package, once only
662	sub extension_package($) {	921	sub extension_package($) {
663	my ($path) = @_;	922	my ($path) = @_;
664
665	no strict 'refs';
666		923
667	$extension_pkg{$path} ||= do {	924	$extension_pkg{$path} ||= do {
668	$path =~ /([^\/\\]+)$/;	925	$path =~ /([^\/\\]+)$/;
669	my $pkg = $1;	926	my $pkg = $1;
670	$pkg =~ s/[^[:word:]]/_/g;	927	$pkg =~ s/[^[:word:]]/_/g;
…		…
673	verbose 3, "loading extension '$path' into package '$pkg'";	930	verbose 3, "loading extension '$path' into package '$pkg'";
674		931
675	open my $fh, "<:raw", $path	932	open my $fh, "<:raw", $path
676	or die "$path: $!";	933	or die "$path: $!";
677		934
678	@{"$pkg\::ISA"} = urxvt::term::extension::;
679
680	my $source =	935	my $source =
681	"package $pkg; use strict; use utf8;\n"	936	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
682	. "#line 1 \"$path\"\n{\n"	937	. "#line 1 \"$path\"\n{\n"
683	. (do { local $/; <$fh> })	938	. (do { local $/; <$fh> })
684	. "\n};\n1";	939	. "\n};\n1";
685		940
686	eval $source	941	eval $source
…		…
697	local $TERM = shift;	952	local $TERM = shift;
698	my $htype = shift;	953	my $htype = shift;
699		954
700	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
701	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
702		957
703	my %ext_arg;	958	my %ext_arg;
704		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
705	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	969	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
706	if ($_ eq "default") {	970	if ($_ eq "default") {
707	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	971	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
708	} elsif (/^-(.*)$/) {	972	} elsif (/^-(.*)$/) {
709	delete $ext_arg{$1};	973	delete $ext_arg{$1};
710	} elsif (/^([^<]+)<(.*)>$/) {	974	} elsif (/^([^<]+)<(.*)>$/) {
711	push @{ $ext_arg{$1} }, $2;	975	push @{ $ext_arg{$1} }, $2;
712	} else {	976	} else {
713	$ext_arg{$_} ||= [];	977	$ext_arg{$_} ||= [];
714	}	978	}
715	}	979	}
716		980
717	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
718	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
719		983
720	if (@files) {	984	if (@files) {
721	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
722	} else {	986	} else {
723	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";
724	}	988	}
725	}	989	}
726		990
…		…
732		996
733	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
734	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
735	if $verbosity >= 10;	999	if $verbosity >= 10;
736		1000
737	keys %$cb;	1001	for my $pkg (keys %$cb) {
738
739	while (my ($pkg, $cb) = each %$cb) {
740	$retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1003	$retval ||= $retval_;
741		1004
742	if ($@) {	1005	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	1007	warn $@;
745	}	1008	}
…		…
756	# clear package	1019	# clear package
757	%$TERM = ();	1020	%$TERM = ();
758	}	1021	}
759		1022
760	$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)
761	}	1053	}
762		1054
763	# urxvt::term::extension	1055	# urxvt::term::extension
764		1056
765	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
836	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
837	work.	1129	work.
838		1130
839	=cut	1131	=cut
840		1132
841	our $VERSION = 1;	1133	our $VERSION = '5.23';
842		1134
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		1137
846	sub timer {	1138	sub timer {
…		…
848		1140
849	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
850		1142
851	urxvt::timer	1143	urxvt::timer
852	->new	1144	->new
853	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
854	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
856	$cb->();	1148	$cb->();
857	})	1149	})
858	}	1150	}
859		1151
860	sub io {	1152	sub io {
861	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
862		1154
863	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
864		1158
865	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
866	->new	1160	->new
867	->fd (fileno $arg{fh})	1161	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	1163	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	1164	->start
871	->cb (sub {	1165	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	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	})
876	}	1192	}
877		1193
878	sub DESTROY {	1194	sub DESTROY {
879	$_[0][1]->stop;	1195	$_[0][1]->stop;
880	}	1196	}
881		1197
882	sub condvar {	1198	sub one_event {
883	bless \my $flag, urxvt::anyevent::condvar::
884	}
885
886	sub urxvt::anyevent::condvar::broadcast {
887	${$_[0]}++;
888	}
889
890	sub urxvt::anyevent::condvar::wait {
891	unless (${$_[0]}) {
892	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";
893	}
894	}	1200	}
895		1201
896	package urxvt::term;	1202	package urxvt::term;
897		1203
898	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
903		1209
904	# find on_xxx subs in the package and register them	1210	# find on_xxx subs in the package and register them
905	# as hooks	1211	# as hooks
906	sub register_package {	1212	sub register_package {
907	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::;
908		1220
909	my $proxy = bless {	1221	my $proxy = bless {
910	_pkg => $pkg,	1222	_pkg => $pkg,
911	argv => $argv,	1223	argv => $argv,
912	}, $pkg;	1224	}, $pkg;
…		…
928	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
929		1241
930	Croaks (and probably outputs an error message) if the new instance	1242	Croaks (and probably outputs an error message) if the new instance
931	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
932	initialise perl, and the terminal object otherwise. The C<init> and	1244	initialise perl, and the terminal object otherwise. The C<init> and
933	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).
934		1247
935	=cut	1248	=cut
936		1249
937	sub new {	1250	sub new {
938	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
939		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
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1257	}
942		1258
943	=item $term->destroy	1259	=item $term->destroy
944		1260
945	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
…		…
975		1291
976	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
977	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
978	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.
979		1295
980	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
981	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
982		1298
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1002	likely change).	1318	likely change).
1003		1319
1004	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
1005	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1006		1322
1007	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
1008	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>
1009	to see the actual list:	1325	to see the actual list:
1010		1326
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1013	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1023	visualBell	1339	visualBell
1024		1340
1025	=cut	1341	=cut
1026		1342
1027	sub resource($$;$) {	1343	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1031	}	1347	}
1032		1348
1033	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1034		1350
1035	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
…		…
1060		1376
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1378
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1380
1065	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.
1066	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.
1067		1390
1068	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1069		1392
1070	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
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1118		1441
1119	The methods currently supported on C<urxvt::overlay> objects are:	1442	The methods currently supported on C<urxvt::overlay> objects are:
1120		1443
1121	=over 4	1444	=over 4
1122		1445
1123	=item $overlay->set ($x, $y, $text, $rend)	1446	=item $overlay->set ($x, $y, $text[, $rend])
1124		1447
1125	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1448	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1126	text in rxvt-unicode's special encoding and an array of rendition values	1449	text in rxvt-unicode's special encoding and an array of rendition values
1127	at a specific position inside the overlay.	1450	at a specific position inside the overlay.
		1451
		1452	If C<$rend> is missing, then the rendition will not be changed.
1128		1453
1129	=item $overlay->hide	1454	=item $overlay->hide
1130		1455
1131	If visible, hide the overlay, but do not destroy it.	1456	If visible, hide the overlay, but do not destroy it.
1132		1457
…		…
1202		1527
1203	Normally its not a good idea to use this function, as programs might be	1528	Normally its not a good idea to use this function, as programs might be
1204	confused by changes in cursor position or scrolling. Its useful inside a	1529	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1530	C<on_add_lines> hook, though.
1206		1531
		1532	=item $term->scr_change_screen ($screen)
		1533
		1534	Switch to given screen - 0 primary, 1 secondary.
		1535
1207	=item $term->cmd_parse ($octets)	1536	=item $term->cmd_parse ($octets)
1208		1537
1209	Similar to C<scr_add_lines>, but the argument must be in the	1538	Similar to C<scr_add_lines>, but the argument must be in the
1210	locale-specific encoding of the terminal and can contain command sequences	1539	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1540	(escape codes) that will be interpreted.
…		…
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1550	Replaces the event mask of the pty watcher by the given event mask. Can
1222	be used to suppress input and output handling to the pty/tty. See the	1551	be used to suppress input and output handling to the pty/tty. See the
1223	description of C<< urxvt::timer->events >>. Make sure to always restore	1552	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1553	the previous value.
1225		1554
		1555	=item $fd = $term->pty_fd
		1556
		1557	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1558	is used.
		1559
1226	=item $windowid = $term->parent	1560	=item $windowid = $term->parent
1227		1561
1228	Return the window id of the toplevel window.	1562	Return the window id of the toplevel window.
1229		1563
1230	=item $windowid = $term->vt	1564	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1570	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1571	to receive pointer events all the times:
1238		1572
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1573	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1574
		1575	=item $term->focus_in
		1576
		1577	=item $term->focus_out
		1578
		1579	=item $term->key_press ($state, $keycode[, $time])
		1580
		1581	=item $term->key_release ($state, $keycode[, $time])
		1582
		1583	Deliver various fake events to to terminal.
		1584
1241	=item $window_width = $term->width	1585	=item $window_width = $term->width
1242		1586
1243	=item $window_height = $term->height	1587	=item $window_height = $term->height
1244		1588
1245	=item $font_width = $term->fwidth	1589	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1619	=item $env = $term->env
1276		1620
1277	Returns a copy of the environment in effect for the terminal as a hashref	1621	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1622	similar to C<\%ENV>.
1279		1623
		1624	=item @envv = $term->envv
		1625
		1626	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1627
		1628	=item @argv = $term->argv
		1629
		1630	Return the argument vector as this terminal, similar to @ARGV, but
		1631	includes the program name as first element.
		1632
1280	=cut	1633	=cut
1281		1634
1282	sub env {	1635	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1636	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1637	}
1289		1638
1290	=item $modifiermask = $term->ModLevel3Mask	1639	=item $modifiermask = $term->ModLevel3Mask
1291		1640
1292	=item $modifiermask = $term->ModMetaMask	1641	=item $modifiermask = $term->ModMetaMask
1293		1642
1294	=item $modifiermask = $term->ModNumLockMask	1643	=item $modifiermask = $term->ModNumLockMask
1295		1644
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1645	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1646	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1647
		1648	=item $screen = $term->current_screen
		1649
		1650	Returns the currently displayed screen (0 primary, 1 secondary).
		1651
		1652	=item $cursor_is_hidden = $term->hidden_cursor
		1653
		1654	Returns whether the cursor is currently hidden or not.
1298		1655
1299	=item $view_start = $term->view_start ([$newvalue])	1656	=item $view_start = $term->view_start ([$newvalue])
1300		1657
1301	Returns the row number of the topmost displayed line. Maximum value is	1658	Returns the row number of the topmost displayed line. Maximum value is
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1659	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1667
1311	Used after changing terminal contents to display them.	1668	Used after changing terminal contents to display them.
1312		1669
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1670	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1671
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1672	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1316	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1673	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1317	terminal line. The scrollback buffer starts at line C<-1> and extends to
1318	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1674	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1675	is requested.
1320		1676
1321	If C<$new_text> is specified, it will replace characters in the current	1677	If C<$new_text> is specified, it will replace characters in the current
1322	line, starting at column C<$start_col> (default C<0>), which is useful	1678	line, starting at column C<$start_col> (default C<0>), which is useful
1323	to replace only parts of a line. The font index in the rendition will	1679	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1680	automatically be updated.
1325		1681
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1682	C<$text> is in a special encoding: tabs and wide characters that use more
1327	than one cell when displayed are padded with urxvt::NOCHAR characters	1683	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1684	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1685	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1686	in the private use area.
1331		1687
1332	You have to obey this encoding when changing text. The advantage is	1688	You have to obey this encoding when changing text. The advantage is
1333	that C<substr> and similar functions work on screen cells and not on	1689	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1690	characters.
1335		1691
…		…
1479	where one character corresponds to one screen cell. See	1835	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	1836	C<< $term->ROW_t >> for details.
1481		1837
1482	=item $string = $term->special_decode $text	1838	=item $string = $term->special_decode $text
1483		1839
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	1840	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	1841	C<< $term->ROW_t >> for details.
1486		1842
1487	=item $success = $term->grab_button ($button, $modifiermask)	1843	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		1844
		1845	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1846
1489	Registers a synchronous button grab. See the XGrabButton manpage.	1847	Register/unregister a synchronous button grab. See the XGrabButton
		1848	manpage.
1490		1849
1491	=item $success = $term->grab ($eventtime[, $sync])	1850	=item $success = $term->grab ($eventtime[, $sync])
1492		1851
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1852	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1853	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		1854
1496	=item $term->allow_events_async	1855	=item $term->allow_events_async
1497		1856
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	1857	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		1858
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1865	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	1866	recent grab.
1508		1867
1509	=item $term->ungrab	1868	=item $term->ungrab
1510		1869
1511	Calls XUngrab for the most recent grab. Is called automatically on	1870	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1512	evaluation errors, as it is better to lose the grab in the error case as	1871	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	1872	the session.
		1873
		1874	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1875
		1876	=item $atom_name = $term->XGetAtomName ($atom)
		1877
		1878	=item @atoms = $term->XListProperties ($window)
		1879
		1880	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1881
		1882	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1883
		1884	=item $term->XDeleteProperty ($window, $property)
		1885
		1886	=item $window = $term->DefaultRootWindow
		1887
		1888	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1889
		1890	=item $term->XMapWindow ($window)
		1891
		1892	=item $term->XUnmapWindow ($window)
		1893
		1894	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1895
		1896	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1897
		1898	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1899
		1900	Various X or X-related functions. The C<$term> object only serves as
		1901	the source of the display, otherwise those functions map more-or-less
		1902	directly onto the X functions of the same name.
1514		1903
1515	=back	1904	=back
1516		1905
1517	=cut	1906	=cut
1518		1907
…		…
1582	my ($self, $text, $cb) = @_;	1971	my ($self, $text, $cb) = @_;
1583		1972
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	1973	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	1974	}
1586		1975
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	1976	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		1977
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	1978	Adds a toggle/checkbox item to the popup. The callback gets called
1590	whenever it gets toggled, with a boolean indicating its value as its first	1979	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	1980	first argument.
1592		1981
1593	=cut	1982	=cut
1594		1983
1595	sub add_toggle {	1984	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	1985	my ($self, $text, $value, $cb) = @_;
1597		1986
1598	my $item; $item = {	1987	my $item; $item = {
1599	type => "button",	1988	type => "button",
1600	text => " $text",	1989	text => " $text",
1601	value => $value,	1990	value => $value,
…		…
1620	my $env = $self->{term}->env;	2009	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2010	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	2011	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	2012	$env->{LC_CTYPE} = $self->{term}->locale;
1624		2013
1625	urxvt::term->new ($env, "popup",	2014	my $term = urxvt::term->new (
		2015	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	2016	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	2017	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2018	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	2019	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	2020	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	2021	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	2022	) or die "unable to create popup window\n";
		2023
		2024	unless (delete $term->{urxvt_popup_init_done}) {
		2025	$term->ungrab;
		2026	$term->destroy;
		2027	die "unable to initialise popup window\n";
		2028	}
1633	}	2029	}
1634		2030
1635	sub DESTROY {	2031	sub DESTROY {
1636	my ($self) = @_;	2032	my ($self) = @_;
1637		2033
1638	delete $self->{term}{_destroy}{$self};	2034	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	2035	$self->{term}->ungrab;
1640	}	2036	}
1641		2037
1642	=back	2038	=back
		2039
		2040	=cut
		2041
		2042	package urxvt::watcher;
1643		2043
1644	=head2 The C<urxvt::timer> Class	2044	=head2 The C<urxvt::timer> Class
1645		2045
1646	This class implements timer watchers/events. Time is represented as a	2046	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2047	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2051	->new
1652	->interval (1)	2052	->interval (1)
1653	->cb (sub {	2053	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2054	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2055	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2056	});
1657		2057
1658	=over 4	2058	=over 4
1659		2059
1660	=item $timer = new urxvt::timer	2060	=item $timer = new urxvt::timer
1661		2061
…		…
1664		2064
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2065	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2066
1667	Set the callback to be called when the timer triggers.	2067	Set the callback to be called when the timer triggers.
1668		2068
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2069	=item $timer = $timer->set ($tstamp[, $interval])
1674		2070
1675	Set the time the event is generated to $tstamp.	2071	Set the time the event is generated to $tstamp (and optionally specifies a
		2072	new $interval).
1676		2073
1677	=item $timer = $timer->interval ($interval)	2074	=item $timer = $timer->interval ($interval)
1678		2075
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2076	By default (and when C<$interval> is C<0>), the timer will automatically
1680	stop after it has fired once. If C<$interval> is non-zero, then the timer	2077	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2078	is automatically rescheduled at the given intervals.
1682		2079
1683	=item $timer = $timer->start	2080	=item $timer = $timer->start
1684		2081
1685	Start the timer.	2082	Start the timer.
1686		2083
1687	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp[, $interval])
1688		2085
1689	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2087	also replaces the interval.
1690		2088
1691	=item $timer = $timer->after ($delay)	2089	=item $timer = $timer->after ($delay[, $interval])
1692		2090
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2091	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2092
1695	=item $timer = $timer->stop	2093	=item $timer = $timer->stop
1696		2094
…		…
1704		2102
1705	$term->{socket} = ...	2103	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2104	$term->{iow} = urxvt::iow
1707	->new	2105	->new
1708	->fd (fileno $term->{socket})	2106	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2107	->events (urxvt::EV_READ)
1710	->start	2108	->start
1711	->cb (sub {	2109	->cb (sub {
1712	my ($iow, $revents) = @_;	2110	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2111	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2112	sysread $term->{socket}, my $buf, 8192
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2125	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2126	is a bitset as described in the C<events> method.
1729		2127
1730	=item $iow = $iow->fd ($fd)	2128	=item $iow = $iow->fd ($fd)
1731		2129
1732	Set the filedescriptor (not handle) to watch.	2130	Set the file descriptor (not handle) to watch.
1733		2131
1734	=item $iow = $iow->events ($eventmask)	2132	=item $iow = $iow->events ($eventmask)
1735		2133
1736	Set the event mask to watch. The only allowed values are	2134	Set the event mask to watch. The only allowed values are
1737	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2135	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2136	together, or C<urxvt::EV_NONE>.
1739		2137
1740	=item $iow = $iow->start	2138	=item $iow = $iow->start
1741		2139
1742	Start watching for requested events on the given handle.	2140	Start watching for requested events on the given handle.
1743		2141
1744	=item $iow = $iow->stop	2142	=item $iow = $iow->stop
1745		2143
1746	Stop watching for events on the given filehandle.	2144	Stop watching for events on the given file handle.
		2145
		2146	=back
		2147
		2148	=head2 The C<urxvt::iw> Class
		2149
		2150	This class implements idle watchers, that get called automatically when
		2151	the process is idle. They should return as fast as possible, after doing
		2152	some useful work.
		2153
		2154	=over 4
		2155
		2156	=item $iw = new urxvt::iw
		2157
		2158	Create a new idle watcher object in stopped state.
		2159
		2160	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2161
		2162	Set the callback to be called when the watcher triggers.
		2163
		2164	=item $timer = $timer->start
		2165
		2166	Start the watcher.
		2167
		2168	=item $timer = $timer->stop
		2169
		2170	Stop the watcher.
		2171
		2172	=back
		2173
		2174	=head2 The C<urxvt::pw> Class
		2175
		2176	This class implements process watchers. They create an event whenever a
		2177	process exits, after which they stop automatically.
		2178
		2179	my $pid = fork;
		2180	...
		2181	$term->{pw} = urxvt::pw
		2182	->new
		2183	->start ($pid)
		2184	->cb (sub {
		2185	my ($pw, $exit_status) = @_;
		2186	...
		2187	});
		2188
		2189	=over 4
		2190
		2191	=item $pw = new urxvt::pw
		2192
		2193	Create a new process watcher in stopped state.
		2194
		2195	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2196
		2197	Set the callback to be called when the timer triggers.
		2198
		2199	=item $pw = $timer->start ($pid)
		2200
		2201	Tells the watcher to start watching for process C<$pid>.
		2202
		2203	=item $pw = $pw->stop
		2204
		2205	Stop the watcher.
1747		2206
1748	=back	2207	=back
1749		2208
1750	=head1 ENVIRONMENT	2209	=head1 ENVIRONMENT
1751		2210
…		…
1760		2219
1761	=item >= 3 - script loading and management	2220	=item >= 3 - script loading and management
1762		2221
1763	=item >=10 - all called hooks	2222	=item >=10 - all called hooks
1764		2223
1765	=item >=11 - hook reutrn values	2224	=item >=11 - hook return values
1766		2225
1767	=back	2226	=back
1768		2227
1769	=head1 AUTHOR	2228	=head1 AUTHOR
1770		2229
…		…
1772	http://software.schmorp.de/pkg/rxvt-unicode	2231	http://software.schmorp.de/pkg/rxvt-unicode
1773		2232
1774	=cut	2233	=cut
1775		2234
1776	1	2235	1
		2236
		2237	# vim: sw=3:

Diff Legend

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