[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.190 by root, Fri Jan 7 21:17:08 2011 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:
…		…
86		96
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.
		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	};
91		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	evaluation, 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 readline
168
169	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).
174
175	It only works when clicking into the same line (possibly extended over
176	multiple rows) as the text cursor and on the primary screen, to reduce the
177	risk of misinterpreting. The normal selection isn't disabled, so quick
178	successive clicks might interfere with selection creation in harmless
179	ways.
180
181	=item tabbed	225	=item tabbed
182		226
183	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186	button per tab.	230	button per tab.
187		231
188	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
189	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
190	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
191		235
192	=item mark-urls	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):
193		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
194	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
195	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
196	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
197	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.
198		258
199	=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.
200		263
201	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.
202	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.
203	a custom pixmap. No scaling is supported in this mode. Exmaple:
204		266
205	@@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.
206		313
207	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
208		315
209	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
210	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
211	similar-looking ascii character.	318	similar-looking ascii character.
212		319
213	=item digital-clock	320	=item digital-clock
214		321
215	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.
216		391
217	=item example-refresh-hooks	392	=item example-refresh-hooks
218		393
219	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
220	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
221	overlays or changes.	396	overlays or changes.
222		397
223	=item selection-pastebin	398	=item confirm-paste
224		399
225	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
226	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
227	not currently secure for use in a multiuser environment as it writes to
228	F</tmp> directly.).
229
230	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231	i.e.
232
233	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235	Pressing this combination runs a command with C<%> replaced by the name of
236	the textfile. This command can be set via a resource:
237
238	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240	And the default is likely not useful to anybody but the few people around
241	here :)
242
243	The name of the textfile is the hex encoded md5 sum of the selection, so
244	the same content should lead to the same filename.
245
246	After a successful upload the selection will be replaced by the text given
247	in the C<selection-pastebin-url> resource (again, the % is the placeholder
248	for the filename):
249
250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251		402
252	=back	403	=back
253		404
254	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
255		406
…		…
271		422
272	=over 4	423	=over 4
273		424
274	=item $text	425	=item $text
275		426
276	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
277	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.
278		429
279	=item $string	430	=item $string
280		431
281	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
…		…
289		440
290	=back	441	=back
291		442
292	=head2 Extension Objects	443	=head2 Extension Objects
293		444
294	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
295	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,
296	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
297	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
298	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
299	use.	451	internal use.
300		452
301	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
302	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
303		455
304	It has the following methods and data members:	456	It has the following methods and data members:
…		…
325	=head2 Hooks	477	=head2 Hooks
326		478
327	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
328	called whenever the relevant event happens.	480	called whenever the relevant event happens.
329		481
330	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
331	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
332		484
333	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
334	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
335	relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
…		…
348	place.	500	place.
349		501
350	=item on_start $term	502	=item on_start $term
351		503
352	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
353	trying to map (display) the toplevel and returning to the mainloop.	505	trying to map (display) the toplevel and returning to the main loop.
354		506
355	=item on_destroy $term	507	=item on_destroy $term
356		508
357	Called whenever something tries to destroy terminal, before doing anything	509	Called whenever something tries to destroy terminal, when the terminal is
358	yet. If this hook returns true, then destruction is skipped, but this is	510	still fully functional (not for long, though).
359	rarely a good idea.
360		511
361	=item on_reset $term	512	=item on_reset $term
362		513
363	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
364	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
…		…
386		537
387	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
388	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
389	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
390		541
391	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.
392		543
393	=item on_sel_extend $term	544	=item on_sel_extend $term
394		545
395	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
396	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
397	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
398	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
399	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
400	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
401		552
402	See the F<selection> example extension.	553	See the F<selection> example extension.
403		554
404	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
405		556
406	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
407	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
408	show this many lines of scrollback.	559	show this many lines of scrollback.
409		560
410	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
411		562
…		…
415		566
416	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,
417	$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
418	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
419		570
420	=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
421		582
422	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
424	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
425	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,
426	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
427	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	}
428		599
429	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,
430	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
431	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.
432		606
433	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
434		608
435	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
436	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
…		…
441	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
442		616
443	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
444	suppress or filter tty input.	618	suppress or filter tty input.
445		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
446	=item on_line_update $term, $row	627	=item on_line_update $term, $row
447		628
448	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
449	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
450	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,
…		…
457	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
458	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
459		640
460	=item on_refresh_begin $term	641	=item on_refresh_begin $term
461		642
462	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
463	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
464	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
465	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
466		647
467	=item on_refresh_end $term	648	=item on_refresh_end $term
468		649
469	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>.
470		651
471	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
472		653
473	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
474	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>
475	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.
476		666
477	=item on_x_event $term, $event	667	=item on_x_event $term, $event
478		668
479	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
480	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
481	members are not passed.	671	members are not passed.
482		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
483	=item on_focus_in $term	677	=item on_focus_in $term
484		678
485	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
486	does focus in processing.	680	does focus in processing.
487		681
488	=item on_focus_out $term	682	=item on_focus_out $term
489		683
490	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
491	focus out processing.	685	focus out processing.
492		686
493	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
494		688
495	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
506		700
507	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
508		702
509	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
510		704
511	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
512	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.
513		707
514	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
515	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
516	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
517		711
…		…
526		720
527	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
528		722
529	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	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.
531		729
532	=back	730	=back
533		731
534	=cut	732	=cut
535		733
…		…
552	our $LIBDIR;	750	our $LIBDIR;
553	our $RESNAME;	751	our $RESNAME;
554	our $RESCLASS;	752	our $RESCLASS;
555	our $RXVTNAME;	753	our $RXVTNAME;
556		754
557	our $NOCHAR = chr 0xfffe;	755	our $NOCHAR = chr 0xffff;
558		756
559	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
560		758
561	=over 4	759	=over 4
562		760
…		…
578	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
579	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
580		778
581	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
582		780
583	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
584	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
585	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,
586	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.
587		785
588	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
589	first.	787	first.
590		788
591	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
592		790
593	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
…		…
600		798
601	=over 4	799	=over 4
602		800
603	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
604		802
605	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
606	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
607	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	temrinal from starting up.
608		807
609	=item urxvt::warn $string	808	=item urxvt::warn $string
610		809
611	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
612	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
613	that calls this function.	812	that calls this function.
614		813
615	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
616	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
617		816
618	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
		818
		819	=item @terms = urxvt::termlist
		820
		821	Returns all urxvt::term objects that exist in this process, regardless of
		822	whether they are started, being destroyed etc., so be careful. Only term
		823	objects that have perl extensions attached will be returned (because there
		824	is no urxvt::term objet associated with others).
619		825
620	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
621		827
622	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
623		829
…		…
666		872
667	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
668		874
669	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
670		876
671	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
672		879
673	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
674	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
675	the bitset.	882	the bitset.
676		883
…		…
681	Return the foreground/background colour index, respectively.	888	Return the foreground/background colour index, respectively.
682		889
683	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684		891
685	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		893
		894	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
686		895
687	Replace the foreground/background colour in the rendition mask with the	896	Replace the foreground/background colour in the rendition mask with the
688	specified one.	897	specified one.
689		898
690	=item $value = urxvt::GET_CUSTOM $rend	899	=item $value = urxvt::GET_CUSTOM $rend
…		…
709	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
710	urxvt::warn ($msg);	919	urxvt::warn ($msg);
711	};	920	};
712	}	921	}
713		922
		923	no warnings 'utf8';
		924
714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715		926
716	sub verbose {	927	sub verbose {
717	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
718	warn "$msg\n" if $level <= $verbosity;	929	warn "$msg\n" if $level <= $verbosity;
…		…
734		945
735	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
736	or die "$path: $!";	947	or die "$path: $!";
737		948
738	my $source =	949	my $source =
739	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
740	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
741	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
742	. "\n};\n1";	953	. "\n};\n1";
743		954
744	eval $source	955	eval $source
…		…
755	local $TERM = shift;	966	local $TERM = shift;
756	my $htype = shift;	967	my $htype = shift;
757		968
758	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
760		971
761	my %ext_arg;	972	my %ext_arg;
762		973
763	{	974	{
764	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
765	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
769	$TERM->register_package ($_) for @pkg;	980	$TERM->register_package ($_) for @pkg;
770	}	981	}
771		982
772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
773	if ($_ eq "default") {	984	if ($_ eq "default") {
774	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
776	delete $ext_arg{$1};	987	delete $ext_arg{$1};
777	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
778	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
779	} else {	990	} else {
780	$ext_arg{$_} \|\|= [];	991	$ext_arg{$_} \|\|= [];
781	}	992	}
782	}	993	}
783		994
784	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
785	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
786		997
787	if (@files) {	998	if (@files) {
788	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789	} else {	1000	} else {
790	warn "perl extension '$ext' not found in perl library search path\n";	1001	warn "perl extension '$ext' not found in perl library search path\n";
791	}	1002	}
792	}	1003	}
793		1004
…		…
799		1010
800	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
801	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802	if $verbosity >= 10;	1013	if $verbosity >= 10;
803		1014
804	keys %$cb;	1015	for my $pkg (keys %$cb) {
805
806	while (my ($pkg, $cb) = each %$cb) {
807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
808	$retval \|\|= $retval_;	1017	$retval \|\|= $retval_;
809		1018
810	if ($@) {	1019	if ($@) {
811	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
812	warn $@;	1021	warn $@;
…		…
824	# clear package	1033	# clear package
825	%$TERM = ();	1034	%$TERM = ();
826	}	1035	}
827		1036
828	$retval	1037	$retval
		1038	}
		1039
		1040	sub SET_COLOR($$$) {
		1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1042	}
		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask \|= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
829	}	1067	}
830		1068
831	# urxvt::term::extension	1069	# urxvt::term::extension
832		1070
833	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
904	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
905	work.	1143	work.
906		1144
907	=cut	1145	=cut
908		1146
909	our $VERSION = 1;	1147	our $VERSION = '5.23';
910		1148
911	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
912	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
913		1151
914	sub timer {	1152	sub timer {
…		…
916		1154
917	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
918		1156
919	urxvt::timer	1157	urxvt::timer
920	->new	1158	->new
921	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
922	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
923	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
924	$cb->();	1162	$cb->();
925	})	1163	})
926	}	1164	}
927		1165
928	sub io {	1166	sub io {
929	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
930		1168
931	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
932		1172
933	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
934	->new	1174	->new
935	->fd (fileno $arg{fh})	1175	->fd ($fd)
936	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
937	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
938	->start	1178	->start
939	->cb (sub {	1179	->cb ($cb)
940	$cb->(($_[1] & 1 ? 'r' : '')
941	. ($_[1] & 2 ? 'w' : ''));
942	})],
943	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
944	}	1206	}
945		1207
946	sub DESTROY {	1208	sub DESTROY {
947	$_[0][1]->stop;	1209	$_[0][1]->stop;
948	}	1210	}
949		1211
950	sub condvar {	1212	sub one_event {
951	bless \my $flag, urxvt::anyevent::condvar::
952	}
953
954	sub urxvt::anyevent::condvar::broadcast {
955	${$_[0]}++;
956	}
957
958	sub urxvt::anyevent::condvar::wait {
959	unless (${$_[0]}) {
960	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
961	}
962	}	1214	}
963		1215
964	package urxvt::term;	1216	package urxvt::term;
965		1217
966	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
1002	hash which defines the environment of the new terminal.	1254	hash which defines the environment of the new terminal.
1003		1255
1004	Croaks (and probably outputs an error message) if the new instance	1256	Croaks (and probably outputs an error message) if the new instance
1005	couldn't be created. Returns C<undef> if the new instance didn't	1257	couldn't be created. Returns C<undef> if the new instance didn't
1006	initialise perl, and the terminal object otherwise. The C<init> and	1258	initialise perl, and the terminal object otherwise. The C<init> and
1007	C<start> hooks will be called during this call.	1259	C<start> hooks will be called before this call returns, and are free to
		1260	refer to global data (which is race free).
1008		1261
1009	=cut	1262	=cut
1010		1263
1011	sub new {	1264	sub new {
1012	my ($class, $env, @args) = @_;	1265	my ($class, $env, @args) = @_;
1013		1266
		1267	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1268	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1269
1014	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1270	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015	}	1271	}
1016		1272
1017	=item $term->destroy	1273	=item $term->destroy
1018		1274
1019	Destroy the terminal object (close the window, free resources	1275	Destroy the terminal object (close the window, free resources
…		…
1049		1305
1050	Returns true if the option specified by C<$optval> is enabled, and	1306	Returns true if the option specified by C<$optval> is enabled, and
1051	optionally change it. All option values are stored by name in the hash	1307	optionally change it. All option values are stored by name in the hash
1052	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1053		1309
1054	Here is a a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
1055	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
1056		1312
1057	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1076	likely change).	1332	likely change).
1077		1333
1078	Please note that resource strings will currently only be freed when the	1334	Please note that resource strings will currently only be freed when the
1079	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
1080		1336
1081	Here is a a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
1082	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
1083	to see the actual list:	1339	to see the actual list:
1084		1340
1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1086	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1087	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
1088	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1095	secondaryScreen secondaryScroll selectstyle shade term_name title	1351	secondaryScreen secondaryScroll shade term_name title
1096	transient_for transparent transparent_all tripleclickwords utmpInhibit	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
1097	visualBell	1353	visualBell
1098		1354
1099	=cut	1355	=cut
1100		1356
1101	sub resource($$;$) {	1357	sub resource($$;$) {
1102	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
1103	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1104	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
1105	}	1361	}
1106		1362
1107	=item $value = $term->x_resource ($pattern)	1363	=item $value = $term->x_resource ($pattern)
1108		1364
1109	Returns the X-Resource for the given pattern, excluding the program or	1365	Returns the X-Resource for the given pattern, excluding the program or
…		…
1134		1390
1135	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
1136		1392
1137	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
1138		1394
1139	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
1140	and optionally set them to new values.	1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
1141		1404
1142	=item $term->selection_make ($eventtime[, $rectangular])	1405	=item $term->selection_make ($eventtime[, $rectangular])
1143		1406
1144	Tries to make a selection as set by C<selection_beg> and	1407	Tries to make a selection as set by C<selection_beg> and
1145	C<selection_end>. If C<$rectangular> is true (default: false), a	1408	C<selection_end>. If C<$rectangular> is true (default: false), a
1146	rectangular selection will be made. This is the prefered function to make	1409	rectangular selection will be made. This is the preferred function to make
1147	a selection.	1410	a selection.
1148		1411
1149	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1150		1413
1151	Try to request the primary selection text from the server (for example, as	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1415	true) selection from the server. The corresponding text can be set
1152	set by the next method). No visual feedback will be given. This function	1416	with the next method. No visual feedback will be given. This function
1153	is mostly useful from within C<on_sel_grab> hooks.	1417	is mostly useful from within C<on_sel_grab> hooks.
1154		1418
1155	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
1156		1420
1157	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1158		1427
1159	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
1160		1429
1161	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
1162		1431
…		…
1192		1461
1193	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
1194		1463
1195	=over 4	1464	=over 4
1196		1465
1197	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
1198		1467
1199	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1468	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1200	text in rxvt-unicode's special encoding and an array of rendition values	1469	text in rxvt-unicode's special encoding and an array of rendition values
1201	at a specific position inside the overlay.	1470	at a specific position inside the overlay.
		1471
		1472	If C<$rend> is missing, then the rendition will not be changed.
1202		1473
1203	=item $overlay->hide	1474	=item $overlay->hide
1204		1475
1205	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
1206		1477
…		…
1288	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1289	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1290		1561
1291	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1292		1563
1293	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1294	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
1295	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1296		1573
1297	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1298		1575
1299	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1300	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
1301	description of C<< urxvt::timer->events >>. Make sure to always restore	1578	description of C<< urxvt::timer->events >>. Make sure to always restore
1302	the previous value.	1579	the previous value.
1303		1580
		1581	=item $fd = $term->pty_fd
		1582
		1583	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1584	is used.
		1585
1304	=item $windowid = $term->parent	1586	=item $windowid = $term->parent
1305		1587
1306	Return the window id of the toplevel window.	1588	Return the window id of the toplevel window.
1307		1589
1308	=item $windowid = $term->vt	1590	=item $windowid = $term->vt
…		…
1314	Adds the specified events to the vt event mask. Useful e.g. when you want	1596	Adds the specified events to the vt event mask. Useful e.g. when you want
1315	to receive pointer events all the times:	1597	to receive pointer events all the times:
1316		1598
1317	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
1318		1600
		1601	=item $term->focus_in
		1602
		1603	=item $term->focus_out
		1604
		1605	=item $term->key_press ($state, $keycode[, $time])
		1606
		1607	=item $term->key_release ($state, $keycode[, $time])
		1608
		1609	Deliver various fake events to to terminal.
		1610
1319	=item $window_width = $term->width	1611	=item $window_width = $term->width
1320		1612
1321	=item $window_height = $term->height	1613	=item $window_height = $term->height
1322		1614
1323	=item $font_width = $term->fwidth	1615	=item $font_width = $term->fwidth
…		…
1353	=item $env = $term->env	1645	=item $env = $term->env
1354		1646
1355	Returns a copy of the environment in effect for the terminal as a hashref	1647	Returns a copy of the environment in effect for the terminal as a hashref
1356	similar to C<\%ENV>.	1648	similar to C<\%ENV>.
1357		1649
		1650	=item @envv = $term->envv
		1651
		1652	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1653
		1654	=item @argv = $term->argv
		1655
		1656	Return the argument vector as this terminal, similar to @ARGV, but
		1657	includes the program name as first element.
		1658
1358	=cut	1659	=cut
1359		1660
1360	sub env {	1661	sub env {
1361	if (my $env = $_[0]->_env) {
1362	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1662	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363	} else {
1364	+{ %ENV }
1365	}
1366	}	1663	}
1367		1664
1368	=item $modifiermask = $term->ModLevel3Mask	1665	=item $modifiermask = $term->ModLevel3Mask
1369		1666
1370	=item $modifiermask = $term->ModMetaMask	1667	=item $modifiermask = $term->ModMetaMask
…		…
1375	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1672	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1376		1673
1377	=item $screen = $term->current_screen	1674	=item $screen = $term->current_screen
1378		1675
1379	Returns the currently displayed screen (0 primary, 1 secondary).	1676	Returns the currently displayed screen (0 primary, 1 secondary).
		1677
		1678	=item $cursor_is_hidden = $term->hidden_cursor
		1679
		1680	Returns whether the cursor is currently hidden or not.
1380		1681
1381	=item $view_start = $term->view_start ([$newvalue])	1682	=item $view_start = $term->view_start ([$newvalue])
1382		1683
1383	Returns the row number of the topmost displayed line. Maximum value is	1684	Returns the row number of the topmost displayed line. Maximum value is
1384	C<0>, which displays the normal terminal contents. Lower values scroll	1685	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1392		1693
1393	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1394		1695
1395	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1396		1697
1397	Returns the text of the entire row with number C<$row_number>. Row C<0>	1698	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1398	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1699	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1399	terminal line. The scrollback buffer starts at line C<-1> and extends to
1400	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1401	is requested.	1701	is requested.
1402		1702
1403	If C<$new_text> is specified, it will replace characters in the current	1703	If C<$new_text> is specified, it will replace characters in the current
1404	line, starting at column C<$start_col> (default C<0>), which is useful	1704	line, starting at column C<$start_col> (default C<0>), which is useful
1405	to replace only parts of a line. The font index in the rendition will	1705	to replace only parts of a line. The font index in the rendition will
1406	automatically be updated.	1706	automatically be updated.
1407		1707
1408	C<$text> is in a special encoding: tabs and wide characters that use	1708	C<$text> is in a special encoding: tabs and wide characters that use more
1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1709	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410	characters. Characters with combining characters and other characters that	1710	characters. Characters with combining characters and other characters that
1411	do not fit into the normal tetx encoding will be replaced with characters	1711	do not fit into the normal text encoding will be replaced with characters
1412	in the private use area.	1712	in the private use area.
1413		1713
1414	You have to obey this encoding when changing text. The advantage is	1714	You have to obey this encoding when changing text. The advantage is
1415	that C<substr> and similar functions work on screen cells and not on	1715	that C<substr> and similar functions work on screen cells and not on
1416	characters.	1716	characters.
…		…
1561	where one character corresponds to one screen cell. See	1861	where one character corresponds to one screen cell. See
1562	C<< $term->ROW_t >> for details.	1862	C<< $term->ROW_t >> for details.
1563		1863
1564	=item $string = $term->special_decode $text	1864	=item $string = $term->special_decode $text
1565		1865
1566	Converts rxvt-unicodes text reprsentation into a perl string. See	1866	Converts rxvt-unicodes text representation into a perl string. See
1567	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1568		1868
1569	=item $success = $term->grab_button ($button, $modifiermask)	1869	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570		1870
		1871	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1872
1571	Registers a synchronous button grab. See the XGrabButton manpage.	1873	Register/unregister a synchronous button grab. See the XGrabButton
		1874	manpage.
1572		1875
1573	=item $success = $term->grab ($eventtime[, $sync])	1876	=item $success = $term->grab ($eventtime[, $sync])
1574		1877
1575	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1878	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1879	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577		1880
1578	=item $term->allow_events_async	1881	=item $term->allow_events_async
1579		1882
1580	Calls XAllowEvents with AsyncBoth for the most recent grab.	1883	Calls XAllowEvents with AsyncBoth for the most recent grab.
1581		1884
…		…
1588	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589	recent grab.	1892	recent grab.
1590		1893
1591	=item $term->ungrab	1894	=item $term->ungrab
1592		1895
1593	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1594	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1595	the session.	1898	the session.
1596		1899
1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598		1901
…		…
1600		1903
1601	=item @atoms = $term->XListProperties ($window)	1904	=item @atoms = $term->XListProperties ($window)
1602		1905
1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1906	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604		1907
1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1908	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1606		1909
1607	=item $term->XDeleteProperty ($window, $property)	1910	=item $term->XDeleteProperty ($window, $property)
1608		1911
1609	=item $window = $term->DefaultRootWindow	1912	=item $window = $term->DefaultRootWindow
1610		1913
…		…
1620		1923
1621	=item $term->XChangeInput ($window, $add_events[, $del_events])	1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
1622		1925
1623	Various X or X-related functions. The C<$term> object only serves as	1926	Various X or X-related functions. The C<$term> object only serves as
1624	the source of the display, otherwise those functions map more-or-less	1927	the source of the display, otherwise those functions map more-or-less
1625	directory onto the X functions of the same name.	1928	directly onto the X functions of the same name.
1626		1929
1627	=back	1930	=back
1628		1931
1629	=cut	1932	=cut
1630		1933
…		…
1694	my ($self, $text, $cb) = @_;	1997	my ($self, $text, $cb) = @_;
1695		1998
1696	$self->add_item ({ type => "button", text => $text, activate => $cb});	1999	$self->add_item ({ type => "button", text => $text, activate => $cb});
1697	}	2000	}
1698		2001
1699	=item $popup->add_toggle ($text, $cb, $initial_value)	2002	=item $popup->add_toggle ($text, $initial_value, $cb)
1700		2003
1701	Adds a toggle/checkbox item to the popup. Teh callback gets called	2004	Adds a toggle/checkbox item to the popup. The callback gets called
1702	whenever it gets toggled, with a boolean indicating its value as its first	2005	whenever it gets toggled, with a boolean indicating its new value as its
1703	argument.	2006	first argument.
1704		2007
1705	=cut	2008	=cut
1706		2009
1707	sub add_toggle {	2010	sub add_toggle {
1708	my ($self, $text, $cb, $value) = @_;	2011	my ($self, $text, $value, $cb) = @_;
1709		2012
1710	my $item; $item = {	2013	my $item; $item = {
1711	type => "button",	2014	type => "button",
1712	text => " $text",	2015	text => " $text",
1713	value => $value,	2016	value => $value,
…		…
1732	my $env = $self->{term}->env;	2035	my $env = $self->{term}->env;
1733	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2036	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1734	delete $env->{LC_ALL};	2037	delete $env->{LC_ALL};
1735	$env->{LC_CTYPE} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1736		2039
1737	urxvt::term->new ($env, "popup",	2040	my $term = urxvt::term->new (
		2041	$env, "popup",
1738	"--perl-lib" => "", "--perl-ext-common" => "",	2042	"--perl-lib" => "", "--perl-ext-common" => "",
1739	"-pty-fd" => -1, "-sl" => 0,	2043	"-pty-fd" => -1, "-sl" => 0,
1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2044	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1741	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1742	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1743	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1744	or die "unable to create popup window\n";	2048	) or die "unable to create popup window\n";
		2049
		2050	unless (delete $term->{urxvt_popup_init_done}) {
		2051	$term->ungrab;
		2052	$term->destroy;
		2053	die "unable to initialise popup window\n";
		2054	}
1745	}	2055	}
1746		2056
1747	sub DESTROY {	2057	sub DESTROY {
1748	my ($self) = @_;	2058	my ($self) = @_;
1749		2059
…		…
1754	=back	2064	=back
1755		2065
1756	=cut	2066	=cut
1757		2067
1758	package urxvt::watcher;	2068	package urxvt::watcher;
1759
1760	@urxvt::timer::ISA = __PACKAGE__;
1761	@urxvt::iow::ISA = __PACKAGE__;
1762	@urxvt::pw::ISA = __PACKAGE__;
1763	@urxvt::iw::ISA = __PACKAGE__;
1764		2069
1765	=head2 The C<urxvt::timer> Class	2070	=head2 The C<urxvt::timer> Class
1766		2071
1767	This class implements timer watchers/events. Time is represented as a	2072	This class implements timer watchers/events. Time is represented as a
1768	fractional number of seconds since the epoch. Example:	2073	fractional number of seconds since the epoch. Example:
…		…
1772	->new	2077	->new
1773	->interval (1)	2078	->interval (1)
1774	->cb (sub {	2079	->cb (sub {
1775	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1776	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1777	});	2082	});
1778		2083
1779	=over 4	2084	=over 4
1780		2085
1781	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
1782		2087
…		…
1785		2090
1786	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1787		2092
1788	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
1789		2094
1790	=item $tstamp = $timer->at
1791
1792	Return the time this watcher will fire next.
1793
1794	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
1795		2096
1796	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
1797		2099
1798	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
1799		2101
1800	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
1801	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
1802	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
1803		2105
1804	=item $timer = $timer->start	2106	=item $timer = $timer->start
1805		2107
1806	Start the timer.	2108	Start the timer.
1807		2109
1808	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
1809		2111
1810	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
1811		2114
1812	=item $timer = $timer->after ($delay)	2115	=item $timer = $timer->after ($delay[, $interval])
1813		2116
1814	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1815		2118
1816	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
1817		2120
…		…
1825		2128
1826	$term->{socket} = ...	2129	$term->{socket} = ...
1827	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
1828	->new	2131	->new
1829	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
1830	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
1831	->start	2134	->start
1832	->cb (sub {	2135	->cb (sub {
1833	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
1834	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
1835	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
1848	Set the callback to be called when io events are triggered. C<$reventmask>	2151	Set the callback to be called when io events are triggered. C<$reventmask>
1849	is a bitset as described in the C<events> method.	2152	is a bitset as described in the C<events> method.
1850		2153
1851	=item $iow = $iow->fd ($fd)	2154	=item $iow = $iow->fd ($fd)
1852		2155
1853	Set the filedescriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
1854		2157
1855	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
1856		2159
1857	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
1858	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2161	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1859	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
1860		2163
1861	=item $iow = $iow->start	2164	=item $iow = $iow->start
1862		2165
1863	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
1864		2167
1865	=item $iow = $iow->stop	2168	=item $iow = $iow->stop
1866		2169
1867	Stop watching for events on the given filehandle.	2170	Stop watching for events on the given file handle.
1868		2171
1869	=back	2172	=back
1870		2173
1871	=head2 The C<urxvt::iw> Class	2174	=head2 The C<urxvt::iw> Class
1872		2175
…		…
1905	->new	2208	->new
1906	->start ($pid)	2209	->start ($pid)
1907	->cb (sub {	2210	->cb (sub {
1908	my ($pw, $exit_status) = @_;	2211	my ($pw, $exit_status) = @_;
1909	...	2212	...
1910	});	2213	});
1911		2214
1912	=over 4	2215	=over 4
1913		2216
1914	=item $pw = new urxvt::pw	2217	=item $pw = new urxvt::pw
1915		2218
…		…
1919		2222
1920	Set the callback to be called when the timer triggers.	2223	Set the callback to be called when the timer triggers.
1921		2224
1922	=item $pw = $timer->start ($pid)	2225	=item $pw = $timer->start ($pid)
1923		2226
1924	Tells the wqtcher to start watching for process C<$pid>.	2227	Tells the watcher to start watching for process C<$pid>.
1925		2228
1926	=item $pw = $pw->stop	2229	=item $pw = $pw->stop
1927		2230
1928	Stop the watcher.	2231	Stop the watcher.
1929		2232
…		…
1942		2245
1943	=item >= 3 - script loading and management	2246	=item >= 3 - script loading and management
1944		2247
1945	=item >=10 - all called hooks	2248	=item >=10 - all called hooks
1946		2249
1947	=item >=11 - hook reutrn values	2250	=item >=11 - hook return values
1948		2251
1949	=back	2252	=back
1950		2253
1951	=head1 AUTHOR	2254	=head1 AUTHOR
1952		2255
…		…
1954	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
1955		2258
1956	=cut	2259	=cut
1957		2260
1958	1	2261	1
		2262
		2263	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs. Revision 1.190 by root, Fri Jan 7 21:17:08 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.190 by root, Fri Jan 7 21:17:08 2011 UTC