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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 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.
…		…
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item tabbed	225	=item tabbed
168		226
169	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
170	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
171	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
172	button per tab.	230	button per tab.
173		231
174	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
175	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,
176	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
177		235
178	=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):
179		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
180	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
181	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
182	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
183	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.
184		258
185	=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.
186		263
187	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 or a list of matches
188	to the window position, in effect creating the same effect as pseudo transparency with	265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
189	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
190		267
191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
192		315
193	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
194		317
195	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
196	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
197	similar-looking ascii character.	320	similar-looking ascii character.
198		321
199	=item digital-clock	322	=item digital-clock
200		323
201	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
202		393
203	=item example-refresh-hooks	394	=item example-refresh-hooks
204		395
205	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
206	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
207	overlays or changes.	398	overlays or changes.
208		399
209	=item selection-pastebin	400	=item confirm-paste
210		401
211	This is a little rarely useful extension that Uploads the selection as	402	Displays a confirmation dialog when a paste containing at least a full
212	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
213	not currently secure for use in a multiuser environment as it writes to
214	F</tmp> directly.).
215
216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
217	i.e.
218
219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
220
221	Pressing this combination runs a command with C<%> replaced by the name of
222	the textfile. This command can be set via a resource:
223
224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
225
226	And the default is likely not useful to anybody but the few people around
227	here :)
228
229	The name of the textfile is the hex encoded md5 sum of the selection, so
230	the same content should lead to the same filename.
231
232	After a successful upload the selection will be replaced by the text given
233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
234	for the filename):
235
236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
237		404
238	=back	405	=back
239		406
240	=head1 API DOCUMENTATION	407	=head1 API DOCUMENTATION
241		408
…		…
257		424
258	=over 4	425	=over 4
259		426
260	=item $text	427	=item $text
261		428
262	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	Rxvt-unicode's special way of encoding text, where one "unicode" character
263	always represents one screen cell. See L<ROW_t> for a discussion of this format.	430	always represents one screen cell. See L<ROW_t> for a discussion of this format.
264		431
265	=item $string	432	=item $string
266		433
267	A perl text string, with an emphasis on I<text>. It can store all unicode	434	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
275		442
276	=back	443	=back
277		444
278	=head2 Extension Objects	445	=head2 Extension Objects
279		446
280	Very perl extension is a perl class. A separate perl object is created	447	Every perl extension is a perl class. A separate perl object is created
281	for each terminal and each extension and passed as the first parameter to	448	for each terminal, and each terminal has its own set of extension objects,
282	hooks. So extensions can use their C<$self> object without having to think	449	which are passed as the first parameter to hooks. So extensions can use
283	about other extensions, with the exception of methods and members that	450	their C<$self> object without having to think about clashes with other
		451	extensions or other terminals, with the exception of methods and members
284	begin with an underscore character C<_>: these are reserved for internal	452	that begin with an underscore character C<_>: these are reserved for
285	use.	453	internal use.
286		454
287	Although it isn't a C<urxvt::term> object, you can call all methods of the	455	Although it isn't a C<urxvt::term> object, you can call all methods of the
288	C<urxvt::term> class on this object.	456	C<urxvt::term> class on this object.
289		457
290	It has the following methods and data members:	458	It has the following methods and data members:
…		…
311	=head2 Hooks	479	=head2 Hooks
312		480
313	The following subroutines can be declared in extension files, and will be	481	The following subroutines can be declared in extension files, and will be
314	called whenever the relevant event happens.	482	called whenever the relevant event happens.
315		483
316	The first argument passed to them is an extension oject as described in	484	The first argument passed to them is an extension object as described in
317	the in the C<Extension Objects> section.	485	the in the C<Extension Objects> section.
318		486
319	B<All> of these hooks must return a boolean value. If any of the called	487	B<All> of these hooks must return a boolean value. If any of the called
320	hooks returns true, then the event counts as being I<consumed>, and the	488	hooks returns true, then the event counts as being I<consumed>, and the
321	relevant action might not be carried out by the C++ code.	489	relevant action might not be carried out by the C++ code.
…		…
334	place.	502	place.
335		503
336	=item on_start $term	504	=item on_start $term
337		505
338	Called at the very end of initialisation of a new terminal, just before	506	Called at the very end of initialisation of a new terminal, just before
339	trying to map (display) the toplevel and returning to the mainloop.	507	trying to map (display) the toplevel and returning to the main loop.
340		508
341	=item on_destroy $term	509	=item on_destroy $term
342		510
343	Called whenever something tries to destroy terminal, before doing anything	511	Called whenever something tries to destroy terminal, when the terminal is
344	yet. If this hook returns true, then destruction is skipped, but this is	512	still fully functional (not for long, though).
345	rarely a good idea.
346		513
347	=item on_reset $term	514	=item on_reset $term
348		515
349	Called after the screen is "reset" for any reason, such as resizing or	516	Called after the screen is "reset" for any reason, such as resizing or
350	control sequences. Here is where you can react on changes to size-related	517	control sequences. Here is where you can react on changes to size-related
…		…
372		539
373	Called whenever a selection has been copied, but before the selection is	540	Called whenever a selection has been copied, but before the selection is
374	requested from the server. The selection text can be queried and changed	541	requested from the server. The selection text can be queried and changed
375	by calling C<< $term->selection >>.	542	by calling C<< $term->selection >>.
376		543
377	Returning a true value aborts selection grabbing. It will still be hilighted.	544	Returning a true value aborts selection grabbing. It will still be highlighted.
378		545
379	=item on_sel_extend $term	546	=item on_sel_extend $term
380		547
381	Called whenever the user tries to extend the selection (e.g. with a double	548	Called whenever the user tries to extend the selection (e.g. with a double
382	click) and is either supposed to return false (normal operation), or	549	click) and is either supposed to return false (normal operation), or
383	should extend the selection itelf and return true to suppress the built-in	550	should extend the selection itself and return true to suppress the built-in
384	processing. This can happen multiple times, as long as the callback	551	processing. This can happen multiple times, as long as the callback
385	returns true, it will be called on every further click by the user and is	552	returns true, it will be called on every further click by the user and is
386	supposed to enlarge the selection more and more, if possible.	553	supposed to enlarge the selection more and more, if possible.
387		554
388	See the F<selection> example extension.	555	See the F<selection> example extension.
389		556
390	=item on_view_change $term, $offset	557	=item on_view_change $term, $offset
391		558
392	Called whenever the view offset changes, i..e the user or program	559	Called whenever the view offset changes, i.e. the user or program
393	scrolls. Offset C<0> means display the normal terminal, positive values	560	scrolls. Offset C<0> means display the normal terminal, positive values
394	show this many lines of scrollback.	561	show this many lines of scrollback.
395		562
396	=item on_scroll_back $term, $lines, $saved	563	=item on_scroll_back $term, $lines, $saved
397		564
…		…
401		568
402	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	569	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
403	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	570	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
404	number of lines that will be in the scrollback buffer.	571	number of lines that will be in the scrollback buffer.
405		572
406	=item on_osc_seq $term, $string	573	=item on_osc_seq $term, $op, $args, $resp
		574
		575	Called on every OSC sequence and can be used to suppress it or modify its
		576	behaviour. The default should be to return an empty list. A true value
		577	suppresses execution of the request completely. Make sure you don't get
		578	confused by recursive invocations when you output an OSC sequence within
		579	this callback.
		580
		581	C<on_osc_seq_perl> should be used for new behaviour.
		582
		583	=item on_osc_seq_perl $term, $args, $resp
407		584
408	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
409	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
410	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
411	string should start with the extension name and a colon, to distinguish	588	string should start with the extension name (sans -osc) and a semicolon,
412	it from commands for other extensions, and this might be enforced in the	589	to distinguish it from commands for other extensions, and this might be
413	future.	590	enforced in the future.
		591
		592	For example, C<overlay-osc> uses this:
		593
		594	sub on_osc_seq_perl {
		595	my ($self, $osc, $resp) = @_;
		596
		597	return unless $osc =~ s/^overlay;//;
		598
		599	... process remaining $osc string
		600	}
414		601
415	Be careful not ever to trust (in a security sense) the data you receive,	602	Be careful not ever to trust (in a security sense) the data you receive,
416	as its source can not easily be controleld (e-mail content, messages from	603	as its source can not easily be controlled (e-mail content, messages from
417	other users on the same system etc.).	604	other users on the same system etc.).
		605
		606	For responses, C<$resp> contains the end-of-args separator used by the
		607	sender.
418		608
419	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
420		610
421	Called whenever text is about to be output, with the text as argument. You	611	Called whenever text is about to be output, with the text as argument. You
422	can filter/change and output the text yourself by returning a true value	612	can filter/change and output the text yourself by returning a true value
…		…
427	=item on_tt_write $term, $octets	617	=item on_tt_write $term, $octets
428		618
429	Called whenever some data is written to the tty/pty and can be used to	619	Called whenever some data is written to the tty/pty and can be used to
430	suppress or filter tty input.	620	suppress or filter tty input.
431		621
		622	=item on_tt_paste $term, $octets
		623
		624	Called whenever text is about to be pasted, with the text as argument. You
		625	can filter/change and paste the text yourself by returning a true value
		626	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		627	locale-encoded.
		628
432	=item on_line_update $term, $row	629	=item on_line_update $term, $row
433		630
434	Called whenever a line was updated or changed. Can be used to filter	631	Called whenever a line was updated or changed. Can be used to filter
435	screen output (e.g. underline urls or other useless stuff). Only lines	632	screen output (e.g. underline urls or other useless stuff). Only lines
436	that are being shown will be filtered, and, due to performance reasons,	633	that are being shown will be filtered, and, due to performance reasons,
…		…
443	later with the already-modified line (e.g. if unrelated parts change), so	640	later with the already-modified line (e.g. if unrelated parts change), so
444	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
445		642
446	=item on_refresh_begin $term	643	=item on_refresh_begin $term
447		644
448	Called just before the screen gets redrawn. Can be used for overlay	645	Called just before the screen gets redrawn. Can be used for overlay or
449	or similar effects by modify terminal contents in refresh_begin, and	646	similar effects by modifying the terminal contents in refresh_begin, and
450	restoring them in refresh_end. The built-in overlay and selection display	647	restoring them in refresh_end. The built-in overlay and selection display
451	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
452		649
453	=item on_refresh_end $term	650	=item on_refresh_end $term
454		651
455	Called just after the screen gets redrawn. See C<on_refresh_begin>.	652	Called just after the screen gets redrawn. See C<on_refresh_begin>.
456		653
457	=item on_keyboard_command $term, $string	654	=item on_user_command $term, $string
458		655
459	Called whenever the user presses a key combination that has a	656	Called whenever a user-configured event is being activated (e.g. via
460	C<perl:string> action bound to it (see description of the B<keysym>	657	a C<perl:string> action bound to a key, see description of the B<keysym>
461	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
		659
		660	The event is simply the action string. This interface is assumed to change
		661	slightly in the future.
		662
		663	=item on_resize_all_windows $term, $new_width, $new_height
		664
		665	Called just after the new window size has been calculated, but before
		666	windows are actually being resized or hints are being set. If this hook
		667	returns TRUE, setting of the window hints is being skipped.
462		668
463	=item on_x_event $term, $event	669	=item on_x_event $term, $event
464		670
465	Called on every X event received on the vt window (and possibly other	671	Called on every X event received on the vt window (and possibly other
466	windows). Should only be used as a last resort. Most event structure	672	windows). Should only be used as a last resort. Most event structure
467	members are not passed.	673	members are not passed.
468		674
		675	=item on_root_event $term, $event
		676
		677	Like C<on_x_event>, but is called for events on the root window.
		678
469	=item on_focus_in $term	679	=item on_focus_in $term
470		680
471	Called whenever the window gets the keyboard focus, before rxvt-unicode	681	Called whenever the window gets the keyboard focus, before rxvt-unicode
472	does focus in processing.	682	does focus in processing.
473		683
474	=item on_focus_out $term	684	=item on_focus_out $term
475		685
476	Called wheneever the window loses keyboard focus, before rxvt-unicode does	686	Called whenever the window loses keyboard focus, before rxvt-unicode does
477	focus out processing.	687	focus out processing.
478		688
479	=item on_configure_notify $term, $event	689	=item on_configure_notify $term, $event
480		690
481	=item on_property_notify $term, $event	691	=item on_property_notify $term, $event
…		…
492		702
493	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
494		704
495	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
496		706
497	Called whenever the corresponding X event is received for the terminal If	707	Called whenever the corresponding X event is received for the terminal. If
498	the hook returns true, then the even will be ignored by rxvt-unicode.	708	the hook returns true, then the event will be ignored by rxvt-unicode.
499		709
500	The event is a hash with most values as named by Xlib (see the XEvent	710	The event is a hash with most values as named by Xlib (see the XEvent
501	manpage), with the additional members C<row> and C<col>, which are the	711	manpage), with the additional members C<row> and C<col>, which are the
502	(real, not screen-based) row and column under the mouse cursor.	712	(real, not screen-based) row and column under the mouse cursor.
503		713
…		…
512		722
513	=item on_wm_delete_window $term, $event	723	=item on_wm_delete_window $term, $event
514		724
515	Called when various types of ClientMessage events are received (all with	725	Called when various types of ClientMessage events are received (all with
516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	726	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		727
		728	=item on_bell $term
		729
		730	Called on receipt of a bell character.
517		731
518	=back	732	=back
519		733
520	=cut	734	=cut
521		735
…		…
538	our $LIBDIR;	752	our $LIBDIR;
539	our $RESNAME;	753	our $RESNAME;
540	our $RESCLASS;	754	our $RESCLASS;
541	our $RXVTNAME;	755	our $RXVTNAME;
542		756
		757	our $NOCHAR = chr 0xffff;
		758
543	=head2 Variables in the C<urxvt> Package	759	=head2 Variables in the C<urxvt> Package
544		760
545	=over 4	761	=over 4
546		762
547	=item $urxvt::LIBDIR	763	=item $urxvt::LIBDIR
…		…
562	The current terminal. This variable stores the current C<urxvt::term>	778	The current terminal. This variable stores the current C<urxvt::term>
563	object, whenever a callback/hook is executing.	779	object, whenever a callback/hook is executing.
564		780
565	=item @urxvt::TERM_INIT	781	=item @urxvt::TERM_INIT
566		782
567	All coderefs in this array will be called as methods of the next newly	783	All code references in this array will be called as methods of the next newly
568	created C<urxvt::term> object (during the C<on_init> phase). The array	784	created C<urxvt::term> object (during the C<on_init> phase). The array
569	gets cleared before the codereferences that were in it are being executed,	785	gets cleared before the code references that were in it are being executed,
570	so coderefs can push themselves onto it again if they so desire.	786	so references can push themselves onto it again if they so desire.
571		787
572	This complements to the perl-eval commandline option, but gets executed	788	This complements to the perl-eval command line option, but gets executed
573	first.	789	first.
574		790
575	=item @urxvt::TERM_EXT	791	=item @urxvt::TERM_EXT
576		792
577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	793	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
584		800
585	=over 4	801	=over 4
586		802
587	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
588		804
589	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
590	costs! The only time this is acceptable is when the terminal process	806	include a trailing newline). Avoid at all costs! The only time this
591	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
592		809
593	=item urxvt::warn $string	810	=item urxvt::warn $string
594		811
595	Calls C<rxvt_warn> with the given string which should not include a	812	Calls C<rxvt_warn> with the given string which should include a trailing
596	newline. The module also overwrites the C<warn> builtin with a function	813	newline. The module also overwrites the C<warn> builtin with a function
597	that calls this function.	814	that calls this function.
598		815
599	Using this function has the advantage that its output ends up in the	816	Using this function has the advantage that its output ends up in the
600	correct place, e.g. on stderr of the connecting urxvtc client.	817	correct place, e.g. on stderr of the connecting urxvtc client.
601		818
602	Messages have a size limit of 1023 bytes currently.	819	Messages have a size limit of 1023 bytes currently.
		820
		821	=item @terms = urxvt::termlist
		822
		823	Returns all urxvt::term objects that exist in this process, regardless of
		824	whether they are started, being destroyed etc., so be careful. Only term
		825	objects that have perl extensions attached will be returned (because there
		826	is no urxvt::term object associated with others).
603		827
604	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
605		829
606	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
607		831
…		…
650		874
651	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
652		876
653	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
654		878
655	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	879	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		880	urxvt::RS_RVid, urxvt::RS_Uline
656		881
657	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
658	underline, respectively. To enable such a style, just logically OR it into	883	underline, respectively. To enable such a style, just logically OR it into
659	the bitset.	884	the bitset.
660		885
…		…
665	Return the foreground/background colour index, respectively.	890	Return the foreground/background colour index, respectively.
666		891
667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
668		893
669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	894	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		895
		896	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
670		897
671	Replace the foreground/background colour in the rendition mask with the	898	Replace the foreground/background colour in the rendition mask with the
672	specified one.	899	specified one.
673		900
674	=item $value = urxvt::GET_CUSTOM $rend	901	=item $value = urxvt::GET_CUSTOM $rend
…		…
693	unless $msg =~ /\n$/;	920	unless $msg =~ /\n$/;
694	urxvt::warn ($msg);	921	urxvt::warn ($msg);
695	};	922	};
696	}	923	}
697		924
		925	no warnings 'utf8';
		926
698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	927	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
699		928
700	sub verbose {	929	sub verbose {
701	my ($level, $msg) = @_;	930	my ($level, $msg) = @_;
702	warn "$msg\n" if $level <= $verbosity;	931	warn "$msg\n" if $level <= $verbosity;
…		…
718		947
719	open my $fh, "<:raw", $path	948	open my $fh, "<:raw", $path
720	or die "$path: $!";	949	or die "$path: $!";
721		950
722	my $source =	951	my $source =
723	"package $pkg; use strict; use utf8;\n"	952	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
724	. "#line 1 \"$path\"\n{\n"	953	. "#line 1 \"$path\"\n{\n"
725	. (do { local $/; <$fh> })	954	. (do { local $/; <$fh> })
726	. "\n};\n1";	955	. "\n};\n1";
727		956
728	eval $source	957	eval $source
…		…
739	local $TERM = shift;	968	local $TERM = shift;
740	my $htype = shift;	969	my $htype = shift;
741		970
742	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
744		973
745	my %ext_arg;	974	my %ext_arg;
746		975
747	{	976	{
748	my @init = @TERM_INIT;	977	my @init = @TERM_INIT;
749	@TERM_INIT = ();	978	@TERM_INIT = ();
…		…
753	$TERM->register_package ($_) for @pkg;	982	$TERM->register_package ($_) for @pkg;
754	}	983	}
755		984
756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	985	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
757	if ($_ eq "default") {	986	if ($_ eq "default") {
758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	987	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
759	} elsif (/^-(.*)$/) {	988	} elsif (/^-(.*)$/) {
760	delete $ext_arg{$1};	989	delete $ext_arg{$1};
761	} elsif (/^([^<]+)<(.*)>$/) {	990	} elsif (/^([^<]+)<(.*)>$/) {
762	push @{ $ext_arg{$1} }, $2;	991	push @{ $ext_arg{$1} }, $2;
763	} else {	992	} else {
764	$ext_arg{$_} \|\|= [];	993	$ext_arg{$_} \|\|= [];
765	}	994	}
766	}	995	}
767		996
768	while (my ($ext, $argv) = each %ext_arg) {	997	for my $ext (sort keys %ext_arg) {
769	my @files = grep -f $_, map "$_/$ext", @dirs;	998	my @files = grep -f $_, map "$_/$ext", @dirs;
770		999
771	if (@files) {	1000	if (@files) {
772	$TERM->register_package (extension_package $files[0], $argv);	1001	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
773	} else {	1002	} else {
774	warn "perl extension '$ext' not found in perl library search path\n";	1003	warn "perl extension '$ext' not found in perl library search path\n";
775	}	1004	}
776	}	1005	}
777		1006
…		…
783		1012
784	if (my $cb = $TERM->{_hook}[$htype]) {	1013	if (my $cb = $TERM->{_hook}[$htype]) {
785	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1014	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
786	if $verbosity >= 10;	1015	if $verbosity >= 10;
787		1016
788	keys %$cb;	1017	for my $pkg (keys %$cb) {
789
790	while (my ($pkg, $cb) = each %$cb) {
791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1018	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
792	$retval \|\|= $retval_;	1019	$retval \|\|= $retval_;
793		1020
794	if ($@) {	1021	if ($@) {
795	$TERM->ungrab; # better to lose the grab than the session	1022	$TERM->ungrab; # better to lose the grab than the session
796	warn $@;	1023	warn $@;
…		…
808	# clear package	1035	# clear package
809	%$TERM = ();	1036	%$TERM = ();
810	}	1037	}
811		1038
812	$retval	1039	$retval
		1040	}
		1041
		1042	sub SET_COLOR($$$) {
		1043	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1044	}
		1045
		1046	sub rend2mask {
		1047	no strict 'refs';
		1048	my ($str, $mask) = (@_, 0);
		1049	my %color = ( fg => undef, bg => undef );
		1050	my @failed;
		1051	for my $spec ( split /\s+/, $str ) {
		1052	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1053	$color{lc($1)} = $2;
		1054	} else {
		1055	my $neg = $spec =~ s/^[-^]//;
		1056	unless ( exists &{"RS_$spec"} ) {
		1057	push @failed, $spec;
		1058	next;
		1059	}
		1060	my $cur = &{"RS_$spec"};
		1061	if ( $neg ) {
		1062	$mask &= ~$cur;
		1063	} else {
		1064	$mask \|= $cur;
		1065	}
		1066	}
		1067	}
		1068	($mask, @color{qw(fg bg)}, \@failed)
813	}	1069	}
814		1070
815	# urxvt::term::extension	1071	# urxvt::term::extension
816		1072
817	package urxvt::term::extension;	1073	package urxvt::term::extension;
…		…
888	is that you cannot use blocking APIs, but the non-blocking variant should	1144	is that you cannot use blocking APIs, but the non-blocking variant should
889	work.	1145	work.
890		1146
891	=cut	1147	=cut
892		1148
893	our $VERSION = 1;	1149	our $VERSION = '5.23';
894		1150
895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
897		1153
898	sub timer {	1154	sub timer {
…		…
900		1156
901	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
902		1158
903	urxvt::timer	1159	urxvt::timer
904	->new	1160	->new
905	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
906	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
907	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
908	$cb->();	1164	$cb->();
909	})	1165	})
910	}	1166	}
911		1167
912	sub io {	1168	sub io {
913	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
914		1170
915	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
916		1174
917	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
918	->new	1176	->new
919	->fd (fileno $arg{fh})	1177	->fd ($fd)
920	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
921	\| ($arg{poll} =~ /w/ ? 2 : 0))	1179	\| ($arg{poll} =~ /w/ ? 2 : 0))
922	->start	1180	->start
923	->cb (sub {	1181	->cb ($cb)
924	$cb->(($_[1] & 1 ? 'r' : '')
925	. ($_[1] & 2 ? 'w' : ''));
926	})],
927	urxvt::anyevent::	1182	], urxvt::anyevent::
		1183	}
		1184
		1185	sub idle {
		1186	my ($class, %arg) = @_;
		1187
		1188	my $cb = $arg{cb};
		1189
		1190	urxvt::iw
		1191	->new
		1192	->start
		1193	->cb ($cb)
		1194	}
		1195
		1196	sub child {
		1197	my ($class, %arg) = @_;
		1198
		1199	my $cb = $arg{cb};
		1200
		1201	urxvt::pw
		1202	->new
		1203	->start ($arg{pid})
		1204	->cb (sub {
		1205	$_[0]->stop; # need to cancel manually
		1206	$cb->($_[0]->rpid, $_[0]->rstatus);
		1207	})
928	}	1208	}
929		1209
930	sub DESTROY {	1210	sub DESTROY {
931	$_[0][1]->stop;	1211	$_[0][1]->stop;
932	}	1212	}
933		1213
934	sub condvar {	1214	# only needed for AnyEvent < 6 compatibility
935	bless \my $flag, urxvt::anyevent::condvar::	1215	sub one_event {
936	}
937
938	sub urxvt::anyevent::condvar::broadcast {
939	${$_[0]}++;
940	}
941
942	sub urxvt::anyevent::condvar::wait {
943	unless (${$_[0]}) {
944	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1216	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
945	}
946	}	1217	}
947		1218
948	package urxvt::term;	1219	package urxvt::term;
949		1220
950	=head2 The C<urxvt::term> Class	1221	=head2 The C<urxvt::term> Class
…		…
986	hash which defines the environment of the new terminal.	1257	hash which defines the environment of the new terminal.
987		1258
988	Croaks (and probably outputs an error message) if the new instance	1259	Croaks (and probably outputs an error message) if the new instance
989	couldn't be created. Returns C<undef> if the new instance didn't	1260	couldn't be created. Returns C<undef> if the new instance didn't
990	initialise perl, and the terminal object otherwise. The C<init> and	1261	initialise perl, and the terminal object otherwise. The C<init> and
991	C<start> hooks will be called during this call.	1262	C<start> hooks will be called before this call returns, and are free to
		1263	refer to global data (which is race free).
992		1264
993	=cut	1265	=cut
994		1266
995	sub new {	1267	sub new {
996	my ($class, $env, @args) = @_;	1268	my ($class, $env, @args) = @_;
997		1269
		1270	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1271	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1272
998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1273	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
999	}	1274	}
1000		1275
1001	=item $term->destroy	1276	=item $term->destroy
1002		1277
1003	Destroy the terminal object (close the window, free resources	1278	Destroy the terminal object (close the window, free resources
…		…
1033		1308
1034	Returns true if the option specified by C<$optval> is enabled, and	1309	Returns true if the option specified by C<$optval> is enabled, and
1035	optionally change it. All option values are stored by name in the hash	1310	optionally change it. All option values are stored by name in the hash
1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1311	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1037		1312
1038	Here is a a likely non-exhaustive list of option names, please see the	1313	Here is a likely non-exhaustive list of option names, please see the
1039	source file F</src/optinc.h> to see the actual list:	1314	source file F</src/optinc.h> to see the actual list:
1040		1315
1041	borderLess console cursorBlink cursorUnderline hold iconic insecure	1316	borderLess buffered console cursorBlink cursorUnderline hold iconic
1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1317	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1318	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1319	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1320	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1046	transparent tripleclickwords utmpInhibit visualBell	1321	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1322	urgentOnBell utmpInhibit visualBell
1047		1323
1048	=item $value = $term->resource ($name[, $newval])	1324	=item $value = $term->resource ($name[, $newval])
1049		1325
1050	Returns the current resource value associated with a given name and	1326	Returns the current resource value associated with a given name and
1051	optionally sets a new value. Setting values is most useful in the C<init>	1327	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1060	likely change).	1336	likely change).
1061		1337
1062	Please note that resource strings will currently only be freed when the	1338	Please note that resource strings will currently only be freed when the
1063	terminal is destroyed, so changing options frequently will eat memory.	1339	terminal is destroyed, so changing options frequently will eat memory.
1064		1340
1065	Here is a a likely non-exhaustive list of resource names, not all of which	1341	Here is a likely non-exhaustive list of resource names, not all of which
1066	are supported in every build, please see the source file F</src/rsinc.h>	1342	are supported in every build, please see the source file F</src/rsinc.h>
1067	to see the actual list:	1343	to see the actual list:
1068		1344
1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1345	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1070	borderLess color cursorBlink cursorUnderline cutchars delete_key	1346	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1071	display_name embed ext_bwidth fade font geometry hold iconName	1347	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1348	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1349	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1350	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1351	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1352	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1353	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1354	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1355	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1079	secondaryScreen secondaryScroll selectstyle shade term_name title	1356	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1080	transient_for transparent transparent_all tripleclickwords utmpInhibit	1357	term_name title transient_for transparent tripleclickwords urgentOnBell
1081	visualBell	1358	utmpInhibit visualBell
1082		1359
1083	=cut	1360	=cut
1084		1361
1085	sub resource($$;$) {	1362	sub resource($$;$) {
1086	my ($self, $name) = (shift, shift);	1363	my ($self, $name) = (shift, shift);
1087	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1364	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1088	&urxvt::term::_resource	1365	goto &urxvt::term::_resource
1089	}	1366	}
1090		1367
1091	=item $value = $term->x_resource ($pattern)	1368	=item $value = $term->x_resource ($pattern)
1092		1369
1093	Returns the X-Resource for the given pattern, excluding the program or	1370	Returns the X-Resource for the given pattern, excluding the program or
…		…
1118		1395
1119	=item ($row, $col) = $term->selection_beg ([$row, $col])	1396	=item ($row, $col) = $term->selection_beg ([$row, $col])
1120		1397
1121	=item ($row, $col) = $term->selection_end ([$row, $col])	1398	=item ($row, $col) = $term->selection_end ([$row, $col])
1122		1399
1123	Return the current values of the selection mark, begin or end positions,	1400	Return the current values of the selection mark, begin or end positions.
1124	and optionally set them to new values.	1401
		1402	When arguments are given, then the selection coordinates are set to
		1403	C<$row> and C<$col>, and the selection screen is set to the current
		1404	screen.
		1405
		1406	=item $screen = $term->selection_screen ([$screen])
		1407
		1408	Returns the current selection screen, and then optionally sets it.
1125		1409
1126	=item $term->selection_make ($eventtime[, $rectangular])	1410	=item $term->selection_make ($eventtime[, $rectangular])
1127		1411
1128	Tries to make a selection as set by C<selection_beg> and	1412	Tries to make a selection as set by C<selection_beg> and
1129	C<selection_end>. If C<$rectangular> is true (default: false), a	1413	C<selection_end>. If C<$rectangular> is true (default: false), a
1130	rectangular selection will be made. This is the prefered function to make	1414	rectangular selection will be made. This is the preferred function to make
1131	a selection.	1415	a selection.
1132		1416
1133	=item $success = $term->selection_grab ($eventtime)	1417	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1134		1418
1135	Try to request the primary selection text from the server (for example, as	1419	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1420	true) selection from the server. The corresponding text can be set
1136	set by the next method). No visual feedback will be given. This function	1421	with the next method. No visual feedback will be given. This function
1137	is mostly useful from within C<on_sel_grab> hooks.	1422	is mostly useful from within C<on_sel_grab> hooks.
1138		1423
1139	=item $oldtext = $term->selection ([$newtext])	1424	=item $oldtext = $term->selection ([$newtext, $clipboard])
1140		1425
1141	Return the current selection text and optionally replace it by C<$newtext>.	1426	Return the current selection (clipboard if C<$clipboard> is true) text
		1427	and optionally replace it by C<$newtext>.
		1428
		1429	=item $term->selection_clear ([$clipboard])
		1430
		1431	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1142		1432
1143	=item $term->overlay_simple ($x, $y, $text)	1433	=item $term->overlay_simple ($x, $y, $text)
1144		1434
1145	Create a simple multi-line overlay box. See the next method for details.	1435	Create a simple multi-line overlay box. See the next method for details.
1146		1436
…		…
1176		1466
1177	The methods currently supported on C<urxvt::overlay> objects are:	1467	The methods currently supported on C<urxvt::overlay> objects are:
1178		1468
1179	=over 4	1469	=over 4
1180		1470
1181	=item $overlay->set ($x, $y, $text, $rend)	1471	=item $overlay->set ($x, $y, $text[, $rend])
1182		1472
1183	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1473	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1184	text in rxvt-unicode's special encoding and an array of rendition values	1474	text in rxvt-unicode's special encoding and an array of rendition values
1185	at a specific position inside the overlay.	1475	at a specific position inside the overlay.
		1476
		1477	If C<$rend> is missing, then the rendition will not be changed.
1186		1478
1187	=item $overlay->hide	1479	=item $overlay->hide
1188		1480
1189	If visible, hide the overlay, but do not destroy it.	1481	If visible, hide the overlay, but do not destroy it.
1190		1482
…		…
1260		1552
1261	Normally its not a good idea to use this function, as programs might be	1553	Normally its not a good idea to use this function, as programs might be
1262	confused by changes in cursor position or scrolling. Its useful inside a	1554	confused by changes in cursor position or scrolling. Its useful inside a
1263	C<on_add_lines> hook, though.	1555	C<on_add_lines> hook, though.
1264		1556
		1557	=item $term->scr_change_screen ($screen)
		1558
		1559	Switch to given screen - 0 primary, 1 secondary.
		1560
1265	=item $term->cmd_parse ($octets)	1561	=item $term->cmd_parse ($octets)
1266		1562
1267	Similar to C<scr_add_lines>, but the argument must be in the	1563	Similar to C<scr_add_lines>, but the argument must be in the
1268	locale-specific encoding of the terminal and can contain command sequences	1564	locale-specific encoding of the terminal and can contain command sequences
1269	(escape codes) that will be interpreted.	1565	(escape codes) that will be interpreted.
1270		1566
1271	=item $term->tt_write ($octets)	1567	=item $term->tt_write ($octets)
1272		1568
1273	Write the octets given in C<$data> to the tty (i.e. as program input). To	1569	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1274	pass characters instead of octets, you should convert your strings first	1570	pass characters instead of octets, you should convert your strings first
1275	to the locale-specific encoding using C<< $term->locale_encode >>.	1571	to the locale-specific encoding using C<< $term->locale_encode >>.
		1572
		1573	=item $term->tt_paste ($octets)
		1574
		1575	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1576	CR and bracketing the data with control sequences if bracketed paste mode
		1577	is set.
1276		1578
1277	=item $old_events = $term->pty_ev_events ([$new_events])	1579	=item $old_events = $term->pty_ev_events ([$new_events])
1278		1580
1279	Replaces the event mask of the pty watcher by the given event mask. Can	1581	Replaces the event mask of the pty watcher by the given event mask. Can
1280	be used to suppress input and output handling to the pty/tty. See the	1582	be used to suppress input and output handling to the pty/tty. See the
1281	description of C<< urxvt::timer->events >>. Make sure to always restore	1583	description of C<< urxvt::timer->events >>. Make sure to always restore
1282	the previous value.	1584	the previous value.
1283		1585
		1586	=item $fd = $term->pty_fd
		1587
		1588	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1589	is used.
		1590
1284	=item $windowid = $term->parent	1591	=item $windowid = $term->parent
1285		1592
1286	Return the window id of the toplevel window.	1593	Return the window id of the toplevel window.
1287		1594
1288	=item $windowid = $term->vt	1595	=item $windowid = $term->vt
…		…
1294	Adds the specified events to the vt event mask. Useful e.g. when you want	1601	Adds the specified events to the vt event mask. Useful e.g. when you want
1295	to receive pointer events all the times:	1602	to receive pointer events all the times:
1296		1603
1297	$term->vt_emask_add (urxvt::PointerMotionMask);	1604	$term->vt_emask_add (urxvt::PointerMotionMask);
1298		1605
		1606	=item $term->focus_in
		1607
		1608	=item $term->focus_out
		1609
		1610	=item $term->key_press ($state, $keycode[, $time])
		1611
		1612	=item $term->key_release ($state, $keycode[, $time])
		1613
		1614	Deliver various fake events to to terminal.
		1615
1299	=item $window_width = $term->width	1616	=item $window_width = $term->width
1300		1617
1301	=item $window_height = $term->height	1618	=item $window_height = $term->height
1302		1619
1303	=item $font_width = $term->fwidth	1620	=item $font_width = $term->fwidth
…		…
1333	=item $env = $term->env	1650	=item $env = $term->env
1334		1651
1335	Returns a copy of the environment in effect for the terminal as a hashref	1652	Returns a copy of the environment in effect for the terminal as a hashref
1336	similar to C<\%ENV>.	1653	similar to C<\%ENV>.
1337		1654
		1655	=item @envv = $term->envv
		1656
		1657	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1658
		1659	=item @argv = $term->argv
		1660
		1661	Return the argument vector as this terminal, similar to @ARGV, but
		1662	includes the program name as first element.
		1663
1338	=cut	1664	=cut
1339		1665
1340	sub env {	1666	sub env {
1341	if (my $env = $_[0]->_env) {
1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1667	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1343	} else {
1344	+{ %ENV }
1345	}
1346	}	1668	}
1347		1669
1348	=item $modifiermask = $term->ModLevel3Mask	1670	=item $modifiermask = $term->ModLevel3Mask
1349		1671
1350	=item $modifiermask = $term->ModMetaMask	1672	=item $modifiermask = $term->ModMetaMask
1351		1673
1352	=item $modifiermask = $term->ModNumLockMask	1674	=item $modifiermask = $term->ModNumLockMask
1353		1675
1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1676	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1677	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1678
		1679	=item $screen = $term->current_screen
		1680
		1681	Returns the currently displayed screen (0 primary, 1 secondary).
		1682
		1683	=item $cursor_is_hidden = $term->hidden_cursor
		1684
		1685	Returns whether the cursor is currently hidden or not.
1356		1686
1357	=item $view_start = $term->view_start ([$newvalue])	1687	=item $view_start = $term->view_start ([$newvalue])
1358		1688
1359	Returns the row number of the topmost displayed line. Maximum value is	1689	Returns the row number of the topmost displayed line. Maximum value is
1360	C<0>, which displays the normal terminal contents. Lower values scroll	1690	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1368		1698
1369	Used after changing terminal contents to display them.	1699	Used after changing terminal contents to display them.
1370		1700
1371	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1701	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1372		1702
1373	Returns the text of the entire row with number C<$row_number>. Row C<0>	1703	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1374	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1704	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1375	terminal line. The scrollback buffer starts at line C<-1> and extends to
1376	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1705	terminal line. Nothing will be returned if a nonexistent line
1377	is requested.	1706	is requested.
1378		1707
1379	If C<$new_text> is specified, it will replace characters in the current	1708	If C<$new_text> is specified, it will replace characters in the current
1380	line, starting at column C<$start_col> (default C<0>), which is useful	1709	line, starting at column C<$start_col> (default C<0>), which is useful
1381	to replace only parts of a line. The font index in the rendition will	1710	to replace only parts of a line. The font index in the rendition will
1382	automatically be updated.	1711	automatically be updated.
1383		1712
1384	C<$text> is in a special encoding: tabs and wide characters that use more	1713	C<$text> is in a special encoding: tabs and wide characters that use more
1385	than one cell when displayed are padded with urxvt::NOCHAR characters	1714	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1386	(C<chr 65535>). Characters with combining characters and other characters	1715	characters. Characters with combining characters and other characters that
1387	that do not fit into the normal tetx encoding will be replaced with	1716	do not fit into the normal text encoding will be replaced with characters
1388	characters in the private use area.	1717	in the private use area.
1389		1718
1390	You have to obey this encoding when changing text. The advantage is	1719	You have to obey this encoding when changing text. The advantage is
1391	that C<substr> and similar functions work on screen cells and not on	1720	that C<substr> and similar functions work on screen cells and not on
1392	characters.	1721	characters.
1393		1722
…		…
1537	where one character corresponds to one screen cell. See	1866	where one character corresponds to one screen cell. See
1538	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1539		1868
1540	=item $string = $term->special_decode $text	1869	=item $string = $term->special_decode $text
1541		1870
1542	Converts rxvt-unicodes text reprsentation into a perl string. See	1871	Converts rxvt-unicodes text representation into a perl string. See
1543	C<< $term->ROW_t >> for details.	1872	C<< $term->ROW_t >> for details.
1544		1873
1545	=item $success = $term->grab_button ($button, $modifiermask)	1874	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1546		1875
		1876	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1877
1547	Registers a synchronous button grab. See the XGrabButton manpage.	1878	Register/unregister a synchronous button grab. See the XGrabButton
		1879	manpage.
1548		1880
1549	=item $success = $term->grab ($eventtime[, $sync])	1881	=item $success = $term->grab ($eventtime[, $sync])
1550		1882
1551	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1883	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1552	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1884	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1553		1885
1554	=item $term->allow_events_async	1886	=item $term->allow_events_async
1555		1887
1556	Calls XAllowEvents with AsyncBoth for the most recent grab.	1888	Calls XAllowEvents with AsyncBoth for the most recent grab.
1557		1889
…		…
1564	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1896	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1565	recent grab.	1897	recent grab.
1566		1898
1567	=item $term->ungrab	1899	=item $term->ungrab
1568		1900
1569	Calls XUngrab for the most recent grab. Is called automatically on	1901	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1570	evaluation errors, as it is better to lose the grab in the error case as	1902	evaluation errors, as it is better to lose the grab in the error case as
1571	the session.	1903	the session.
1572		1904
1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1905	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1574		1906
…		…
1576		1908
1577	=item @atoms = $term->XListProperties ($window)	1909	=item @atoms = $term->XListProperties ($window)
1578		1910
1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1911	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1580		1912
1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1913	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1582		1914
1583	=item $term->XDeleteProperty ($window, $property)	1915	=item $term->XDeleteProperty ($window, $property)
1584		1916
1585	=item $window = $term->DefaultRootWindow	1917	=item $window = $term->DefaultRootWindow
1586		1918
…		…
1596		1928
1597	=item $term->XChangeInput ($window, $add_events[, $del_events])	1929	=item $term->XChangeInput ($window, $add_events[, $del_events])
1598		1930
1599	Various X or X-related functions. The C<$term> object only serves as	1931	Various X or X-related functions. The C<$term> object only serves as
1600	the source of the display, otherwise those functions map more-or-less	1932	the source of the display, otherwise those functions map more-or-less
1601	directory onto the X functions of the same name.	1933	directly onto the X functions of the same name.
1602		1934
1603	=back	1935	=back
1604		1936
1605	=cut	1937	=cut
1606		1938
…		…
1670	my ($self, $text, $cb) = @_;	2002	my ($self, $text, $cb) = @_;
1671		2003
1672	$self->add_item ({ type => "button", text => $text, activate => $cb});	2004	$self->add_item ({ type => "button", text => $text, activate => $cb});
1673	}	2005	}
1674		2006
1675	=item $popup->add_toggle ($text, $cb, $initial_value)	2007	=item $popup->add_toggle ($text, $initial_value, $cb)
1676		2008
1677	Adds a toggle/checkbox item to the popup. Teh callback gets called	2009	Adds a toggle/checkbox item to the popup. The callback gets called
1678	whenever it gets toggled, with a boolean indicating its value as its first	2010	whenever it gets toggled, with a boolean indicating its new value as its
1679	argument.	2011	first argument.
1680		2012
1681	=cut	2013	=cut
1682		2014
1683	sub add_toggle {	2015	sub add_toggle {
1684	my ($self, $text, $cb, $value) = @_;	2016	my ($self, $text, $value, $cb) = @_;
1685		2017
1686	my $item; $item = {	2018	my $item; $item = {
1687	type => "button",	2019	type => "button",
1688	text => " $text",	2020	text => " $text",
1689	value => $value,	2021	value => $value,
…		…
1708	my $env = $self->{term}->env;	2040	my $env = $self->{term}->env;
1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2041	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1710	delete $env->{LC_ALL};	2042	delete $env->{LC_ALL};
1711	$env->{LC_CTYPE} = $self->{term}->locale;	2043	$env->{LC_CTYPE} = $self->{term}->locale;
1712		2044
1713	urxvt::term->new ($env, "popup",	2045	my $term = urxvt::term->new (
		2046	$env, "popup",
1714	"--perl-lib" => "", "--perl-ext-common" => "",	2047	"--perl-lib" => "", "--perl-ext-common" => "",
1715	"-pty-fd" => -1, "-sl" => 0,	2048	"-pty-fd" => -1, "-sl" => 0,
1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2049	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1717	"--transient-for" => $self->{term}->parent,	2050	"--transient-for" => $self->{term}->parent,
1718	"-display" => $self->{term}->display_id,	2051	"-display" => $self->{term}->display_id,
1719	"-pe" => "urxvt-popup")	2052	"-pe" => "urxvt-popup",
1720	or die "unable to create popup window\n";	2053	) or die "unable to create popup window\n";
		2054
		2055	unless (delete $term->{urxvt_popup_init_done}) {
		2056	$term->ungrab;
		2057	$term->destroy;
		2058	die "unable to initialise popup window\n";
		2059	}
1721	}	2060	}
1722		2061
1723	sub DESTROY {	2062	sub DESTROY {
1724	my ($self) = @_;	2063	my ($self) = @_;
1725		2064
…		…
1730	=back	2069	=back
1731		2070
1732	=cut	2071	=cut
1733		2072
1734	package urxvt::watcher;	2073	package urxvt::watcher;
1735
1736	@urxvt::timer::ISA = __PACKAGE__;
1737	@urxvt::iow::ISA = __PACKAGE__;
1738	@urxvt::pw::ISA = __PACKAGE__;
1739	@urxvt::iw::ISA = __PACKAGE__;
1740		2074
1741	=head2 The C<urxvt::timer> Class	2075	=head2 The C<urxvt::timer> Class
1742		2076
1743	This class implements timer watchers/events. Time is represented as a	2077	This class implements timer watchers/events. Time is represented as a
1744	fractional number of seconds since the epoch. Example:	2078	fractional number of seconds since the epoch. Example:
…		…
1748	->new	2082	->new
1749	->interval (1)	2083	->interval (1)
1750	->cb (sub {	2084	->cb (sub {
1751	$term->{overlay}->set (0, 0,	2085	$term->{overlay}->set (0, 0,
1752	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2086	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1753	});	2087	});
1754		2088
1755	=over 4	2089	=over 4
1756		2090
1757	=item $timer = new urxvt::timer	2091	=item $timer = new urxvt::timer
1758		2092
…		…
1761		2095
1762	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2096	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1763		2097
1764	Set the callback to be called when the timer triggers.	2098	Set the callback to be called when the timer triggers.
1765		2099
1766	=item $tstamp = $timer->at
1767
1768	Return the time this watcher will fire next.
1769
1770	=item $timer = $timer->set ($tstamp)	2100	=item $timer = $timer->set ($tstamp[, $interval])
1771		2101
1772	Set the time the event is generated to $tstamp.	2102	Set the time the event is generated to $tstamp (and optionally specifies a
		2103	new $interval).
1773		2104
1774	=item $timer = $timer->interval ($interval)	2105	=item $timer = $timer->interval ($interval)
1775		2106
1776	Normally (and when C<$interval> is C<0>), the timer will automatically	2107	By default (and when C<$interval> is C<0>), the timer will automatically
1777	stop after it has fired once. If C<$interval> is non-zero, then the timer	2108	stop after it has fired once. If C<$interval> is non-zero, then the timer
1778	is automatically rescheduled at the given intervals.	2109	is automatically rescheduled at the given intervals.
1779		2110
1780	=item $timer = $timer->start	2111	=item $timer = $timer->start
1781		2112
1782	Start the timer.	2113	Start the timer.
1783		2114
1784	=item $timer = $timer->start ($tstamp)	2115	=item $timer = $timer->start ($tstamp[, $interval])
1785		2116
1786	Set the event trigger time to C<$tstamp> and start the timer.	2117	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2118	also replaces the interval.
1787		2119
1788	=item $timer = $timer->after ($delay)	2120	=item $timer = $timer->after ($delay[, $interval])
1789		2121
1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2122	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1791		2123
1792	=item $timer = $timer->stop	2124	=item $timer = $timer->stop
1793		2125
…		…
1801		2133
1802	$term->{socket} = ...	2134	$term->{socket} = ...
1803	$term->{iow} = urxvt::iow	2135	$term->{iow} = urxvt::iow
1804	->new	2136	->new
1805	->fd (fileno $term->{socket})	2137	->fd (fileno $term->{socket})
1806	->events (urxvt::EVENT_READ)	2138	->events (urxvt::EV_READ)
1807	->start	2139	->start
1808	->cb (sub {	2140	->cb (sub {
1809	my ($iow, $revents) = @_;	2141	my ($iow, $revents) = @_;
1810	# $revents must be 1 here, no need to check	2142	# $revents must be 1 here, no need to check
1811	sysread $term->{socket}, my $buf, 8192	2143	sysread $term->{socket}, my $buf, 8192
…		…
1824	Set the callback to be called when io events are triggered. C<$reventmask>	2156	Set the callback to be called when io events are triggered. C<$reventmask>
1825	is a bitset as described in the C<events> method.	2157	is a bitset as described in the C<events> method.
1826		2158
1827	=item $iow = $iow->fd ($fd)	2159	=item $iow = $iow->fd ($fd)
1828		2160
1829	Set the filedescriptor (not handle) to watch.	2161	Set the file descriptor (not handle) to watch.
1830		2162
1831	=item $iow = $iow->events ($eventmask)	2163	=item $iow = $iow->events ($eventmask)
1832		2164
1833	Set the event mask to watch. The only allowed values are	2165	Set the event mask to watch. The only allowed values are
1834	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2166	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1835	together, or C<urxvt::EVENT_NONE>.	2167	together, or C<urxvt::EV_NONE>.
1836		2168
1837	=item $iow = $iow->start	2169	=item $iow = $iow->start
1838		2170
1839	Start watching for requested events on the given handle.	2171	Start watching for requested events on the given handle.
1840		2172
1841	=item $iow = $iow->stop	2173	=item $iow = $iow->stop
1842		2174
1843	Stop watching for events on the given filehandle.	2175	Stop watching for events on the given file handle.
1844		2176
1845	=back	2177	=back
1846		2178
1847	=head2 The C<urxvt::iw> Class	2179	=head2 The C<urxvt::iw> Class
1848		2180
…		…
1881	->new	2213	->new
1882	->start ($pid)	2214	->start ($pid)
1883	->cb (sub {	2215	->cb (sub {
1884	my ($pw, $exit_status) = @_;	2216	my ($pw, $exit_status) = @_;
1885	...	2217	...
1886	});	2218	});
1887		2219
1888	=over 4	2220	=over 4
1889		2221
1890	=item $pw = new urxvt::pw	2222	=item $pw = new urxvt::pw
1891		2223
…		…
1895		2227
1896	Set the callback to be called when the timer triggers.	2228	Set the callback to be called when the timer triggers.
1897		2229
1898	=item $pw = $timer->start ($pid)	2230	=item $pw = $timer->start ($pid)
1899		2231
1900	Tells the wqtcher to start watching for process C<$pid>.	2232	Tells the watcher to start watching for process C<$pid>.
1901		2233
1902	=item $pw = $pw->stop	2234	=item $pw = $pw->stop
1903		2235
1904	Stop the watcher.	2236	Stop the watcher.
1905		2237
…		…
1918		2250
1919	=item >= 3 - script loading and management	2251	=item >= 3 - script loading and management
1920		2252
1921	=item >=10 - all called hooks	2253	=item >=10 - all called hooks
1922		2254
1923	=item >=11 - hook reutrn values	2255	=item >=11 - hook return values
1924		2256
1925	=back	2257	=back
1926		2258
1927	=head1 AUTHOR	2259	=head1 AUTHOR
1928		2260
1929	Marc Lehmann <pcg@goof.com>	2261	Marc Lehmann <schmorp@schmorp.de>
1930	http://software.schmorp.de/pkg/rxvt-unicode	2262	http://software.schmorp.de/pkg/rxvt-unicode
1931		2263
1932	=cut	2264	=cut
1933		2265
1934	1	2266	1
		2267
		2268	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC vs. Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC