ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC

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

Diff Legend

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