ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 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:
…		…
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.	100	runtime.
91		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
104	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
130	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
131		189
132	=item selection-autotransform	190	=item selection-autotransform
133		191
134	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.	193	whenever a selection is made.
…		…
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
		691	=item on_property_notify $term, $event
		692
481	=item on_key_press $term, $event, $keysym, $octets	693	=item on_key_press $term, $event, $keysym, $octets
482		694
483	=item on_key_release $term, $event, $keysym	695	=item on_key_release $term, $event, $keysym
484		696
485	=item on_button_press $term, $event	697	=item on_button_press $term, $event
…		…
490		702
491	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
492		704
493	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
494		706
495	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
496	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.
497		709
498	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
499	manpage), with the additional members C<row> and C<col>, which are the row	711	manpage), with the additional members C<row> and C<col>, which are the
500	and column under the mouse cursor.	712	(real, not screen-based) row and column under the mouse cursor.
501		713
502	C<on_key_press> additionally receives the string rxvt-unicode would	714	C<on_key_press> additionally receives the string rxvt-unicode would
503	output, if any, in locale-specific encoding.	715	output, if any, in locale-specific encoding.
504		716
505	subwindow.	717	subwindow.
…		…
510		722
511	=item on_wm_delete_window $term, $event	723	=item on_wm_delete_window $term, $event
512		724
513	Called when various types of ClientMessage events are received (all with	725	Called when various types of ClientMessage events are received (all with
514	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.
515		731
516	=back	732	=back
517		733
518	=cut	734	=cut
519		735
…		…
536	our $LIBDIR;	752	our $LIBDIR;
537	our $RESNAME;	753	our $RESNAME;
538	our $RESCLASS;	754	our $RESCLASS;
539	our $RXVTNAME;	755	our $RXVTNAME;
540		756
		757	our $NOCHAR = chr 0xffff;
		758
541	=head2 Variables in the C<urxvt> Package	759	=head2 Variables in the C<urxvt> Package
542		760
543	=over 4	761	=over 4
544		762
545	=item $urxvt::LIBDIR	763	=item $urxvt::LIBDIR
…		…
560	The current terminal. This variable stores the current C<urxvt::term>	778	The current terminal. This variable stores the current C<urxvt::term>
561	object, whenever a callback/hook is executing.	779	object, whenever a callback/hook is executing.
562		780
563	=item @urxvt::TERM_INIT	781	=item @urxvt::TERM_INIT
564		782
565	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
566	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
567	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,
568	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.
569		787
570	This complements to the perl-eval commandline option, but gets executed	788	This complements to the perl-eval command line option, but gets executed
571	first.	789	first.
572		790
573	=item @urxvt::TERM_EXT	791	=item @urxvt::TERM_EXT
574		792
575	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
…		…
582		800
583	=over 4	801	=over 4
584		802
585	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
586		804
587	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
588	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
589	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
590		809
591	=item urxvt::warn $string	810	=item urxvt::warn $string
592		811
593	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
594	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
595	that calls this function.	814	that calls this function.
596		815
597	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
598	correct place, e.g. on stderr of the connecting urxvtc client.	817	correct place, e.g. on stderr of the connecting urxvtc client.
599		818
600	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).
601		827
602	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
603		829
604	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
605		831
…		…
648		874
649	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
650		876
651	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
652		878
653	=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
654		881
655	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
656	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
657	the bitset.	884	the bitset.
658		885
…		…
663	Return the foreground/background colour index, respectively.	890	Return the foreground/background colour index, respectively.
664		891
665	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
666		893
667	=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
668		897
669	Replace the foreground/background colour in the rendition mask with the	898	Replace the foreground/background colour in the rendition mask with the
670	specified one.	899	specified one.
671		900
672	=item $value = urxvt::GET_CUSTOM $rend	901	=item $value = urxvt::GET_CUSTOM $rend
…		…
691	unless $msg =~ /\n$/;	920	unless $msg =~ /\n$/;
692	urxvt::warn ($msg);	921	urxvt::warn ($msg);
693	};	922	};
694	}	923	}
695		924
		925	no warnings 'utf8';
		926
696	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	927	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
697		928
698	sub verbose {	929	sub verbose {
699	my ($level, $msg) = @_;	930	my ($level, $msg) = @_;
700	warn "$msg\n" if $level <= $verbosity;	931	warn "$msg\n" if $level <= $verbosity;
…		…
716		947
717	open my $fh, "<:raw", $path	948	open my $fh, "<:raw", $path
718	or die "$path: $!";	949	or die "$path: $!";
719		950
720	my $source =	951	my $source =
721	"package $pkg; use strict; use utf8;\n"	952	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
722	. "#line 1 \"$path\"\n{\n"	953	. "#line 1 \"$path\"\n{\n"
723	. (do { local $/; <$fh> })	954	. (do { local $/; <$fh> })
724	. "\n};\n1";	955	. "\n};\n1";
725		956
726	eval $source	957	eval $source
…		…
737	local $TERM = shift;	968	local $TERM = shift;
738	my $htype = shift;	969	my $htype = shift;
739		970
740	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
741	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
742		973
743	my %ext_arg;	974	my %ext_arg;
744		975
745	{	976	{
746	my @init = @TERM_INIT;	977	my @init = @TERM_INIT;
747	@TERM_INIT = ();	978	@TERM_INIT = ();
…		…
751	$TERM->register_package ($_) for @pkg;	982	$TERM->register_package ($_) for @pkg;
752	}	983	}
753		984
754	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	985	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
755	if ($_ eq "default") {	986	if ($_ eq "default") {
756	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	987	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
757	} elsif (/^-(.*)$/) {	988	} elsif (/^-(.*)$/) {
758	delete $ext_arg{$1};	989	delete $ext_arg{$1};
759	} elsif (/^([^<]+)<(.*)>$/) {	990	} elsif (/^([^<]+)<(.*)>$/) {
760	push @{ $ext_arg{$1} }, $2;	991	push @{ $ext_arg{$1} }, $2;
761	} else {	992	} else {
762	$ext_arg{$_} ||= [];	993	$ext_arg{$_} ||= [];
763	}	994	}
764	}	995	}
765		996
766	while (my ($ext, $argv) = each %ext_arg) {	997	for my $ext (sort keys %ext_arg) {
767	my @files = grep -f $_, map "$_/$ext", @dirs;	998	my @files = grep -f $_, map "$_/$ext", @dirs;
768		999
769	if (@files) {	1000	if (@files) {
770	$TERM->register_package (extension_package $files[0], $argv);	1001	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
771	} else {	1002	} else {
772	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";
773	}	1004	}
774	}	1005	}
775		1006
…		…
781		1012
782	if (my $cb = $TERM->{_hook}[$htype]) {	1013	if (my $cb = $TERM->{_hook}[$htype]) {
783	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1014	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
784	if $verbosity >= 10;	1015	if $verbosity >= 10;
785		1016
786	keys %$cb;	1017	for my $pkg (keys %$cb) {
787
788	while (my ($pkg, $cb) = each %$cb) {
789	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1018	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
790	$retval ||= $retval_;	1019	$retval ||= $retval_;
791		1020
792	if ($@) {	1021	if ($@) {
793	$TERM->ungrab; # better to lose the grab than the session	1022	$TERM->ungrab; # better to lose the grab than the session
794	warn $@;	1023	warn $@;
…		…
806	# clear package	1035	# clear package
807	%$TERM = ();	1036	%$TERM = ();
808	}	1037	}
809		1038
810	$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)
811	}	1069	}
812		1070
813	# urxvt::term::extension	1071	# urxvt::term::extension
814		1072
815	package urxvt::term::extension;	1073	package urxvt::term::extension;
…		…
886	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
887	work.	1145	work.
888		1146
889	=cut	1147	=cut
890		1148
891	our $VERSION = 1;	1149	our $VERSION = '5.23';
892		1150
893	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
894	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
895		1153
896	sub timer {	1154	sub timer {
…		…
898		1156
899	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
900		1158
901	urxvt::timer	1159	urxvt::timer
902	->new	1160	->new
903	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
904	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
905	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
906	$cb->();	1164	$cb->();
907	})	1165	})
908	}	1166	}
909		1167
910	sub io {	1168	sub io {
911	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
912		1170
913	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
914		1174
915	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
916	->new	1176	->new
917	->fd (fileno $arg{fh})	1177	->fd ($fd)
918	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
919	| ($arg{poll} =~ /w/ ? 2 : 0))	1179	| ($arg{poll} =~ /w/ ? 2 : 0))
920	->start	1180	->start
921	->cb (sub {	1181	->cb ($cb)
922	$cb->(($_[1] & 1 ? 'r' : '')
923	. ($_[1] & 2 ? 'w' : ''));
924	})],
925	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	})
926	}	1208	}
927		1209
928	sub DESTROY {	1210	sub DESTROY {
929	$_[0][1]->stop;	1211	$_[0][1]->stop;
930	}	1212	}
931		1213
932	sub condvar {	1214	sub one_event {
933	bless \my $flag, urxvt::anyevent::condvar::
934	}
935
936	sub urxvt::anyevent::condvar::broadcast {
937	${$_[0]}++;
938	}
939
940	sub urxvt::anyevent::condvar::wait {
941	unless (${$_[0]}) {
942	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1215	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
943	}
944	}	1216	}
945		1217
946	package urxvt::term;	1218	package urxvt::term;
947		1219
948	=head2 The C<urxvt::term> Class	1220	=head2 The C<urxvt::term> Class
…		…
984	hash which defines the environment of the new terminal.	1256	hash which defines the environment of the new terminal.
985		1257
986	Croaks (and probably outputs an error message) if the new instance	1258	Croaks (and probably outputs an error message) if the new instance
987	couldn't be created. Returns C<undef> if the new instance didn't	1259	couldn't be created. Returns C<undef> if the new instance didn't
988	initialise perl, and the terminal object otherwise. The C<init> and	1260	initialise perl, and the terminal object otherwise. The C<init> and
989	C<start> hooks will be called during this call.	1261	C<start> hooks will be called before this call returns, and are free to
		1262	refer to global data (which is race free).
990		1263
991	=cut	1264	=cut
992		1265
993	sub new {	1266	sub new {
994	my ($class, $env, @args) = @_;	1267	my ($class, $env, @args) = @_;
995		1268
		1269	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1270	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1271
996	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1272	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
997	}	1273	}
998		1274
999	=item $term->destroy	1275	=item $term->destroy
1000		1276
1001	Destroy the terminal object (close the window, free resources	1277	Destroy the terminal object (close the window, free resources
…		…
1031		1307
1032	Returns true if the option specified by C<$optval> is enabled, and	1308	Returns true if the option specified by C<$optval> is enabled, and
1033	optionally change it. All option values are stored by name in the hash	1309	optionally change it. All option values are stored by name in the hash
1034	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1310	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1035		1311
1036	Here is a a likely non-exhaustive list of option names, please see the	1312	Here is a likely non-exhaustive list of option names, please see the
1037	source file F</src/optinc.h> to see the actual list:	1313	source file F</src/optinc.h> to see the actual list:
1038		1314
1039	borderLess console cursorBlink cursorUnderline hold iconic insecure	1315	borderLess buffered console cursorBlink cursorUnderline hold iconic
1040	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1316	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1041	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1317	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1042	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1318	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1043	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1319	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1044	transparent tripleclickwords utmpInhibit visualBell	1320	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1321	urgentOnBell utmpInhibit visualBell
1045		1322
1046	=item $value = $term->resource ($name[, $newval])	1323	=item $value = $term->resource ($name[, $newval])
1047		1324
1048	Returns the current resource value associated with a given name and	1325	Returns the current resource value associated with a given name and
1049	optionally sets a new value. Setting values is most useful in the C<init>	1326	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1058	likely change).	1335	likely change).
1059		1336
1060	Please note that resource strings will currently only be freed when the	1337	Please note that resource strings will currently only be freed when the
1061	terminal is destroyed, so changing options frequently will eat memory.	1338	terminal is destroyed, so changing options frequently will eat memory.
1062		1339
1063	Here is a a likely non-exhaustive list of resource names, not all of which	1340	Here is a likely non-exhaustive list of resource names, not all of which
1064	are supported in every build, please see the source file F</src/rsinc.h>	1341	are supported in every build, please see the source file F</src/rsinc.h>
1065	to see the actual list:	1342	to see the actual list:
1066		1343
1067	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1344	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1068	borderLess color cursorBlink cursorUnderline cutchars delete_key	1345	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1069	display_name embed ext_bwidth fade font geometry hold iconName	1346	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1070	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1347	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1348	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1071	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1349	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1072	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1350	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1073	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1351	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1074	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1352	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1075	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1353	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1076	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1354	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1077	secondaryScreen secondaryScroll selectstyle shade term_name title	1355	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1078	transient_for transparent transparent_all tripleclickwords utmpInhibit	1356	term_name title transient_for transparent tripleclickwords urgentOnBell
1079	visualBell	1357	utmpInhibit visualBell
1080		1358
1081	=cut	1359	=cut
1082		1360
1083	sub resource($$;$) {	1361	sub resource($$;$) {
1084	my ($self, $name) = (shift, shift);	1362	my ($self, $name) = (shift, shift);
1085	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1363	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1086	&urxvt::term::_resource	1364	goto &urxvt::term::_resource
1087	}	1365	}
1088		1366
1089	=item $value = $term->x_resource ($pattern)	1367	=item $value = $term->x_resource ($pattern)
1090		1368
1091	Returns the X-Resource for the given pattern, excluding the program or	1369	Returns the X-Resource for the given pattern, excluding the program or
…		…
1116		1394
1117	=item ($row, $col) = $term->selection_beg ([$row, $col])	1395	=item ($row, $col) = $term->selection_beg ([$row, $col])
1118		1396
1119	=item ($row, $col) = $term->selection_end ([$row, $col])	1397	=item ($row, $col) = $term->selection_end ([$row, $col])
1120		1398
1121	Return the current values of the selection mark, begin or end positions,	1399	Return the current values of the selection mark, begin or end positions.
1122	and optionally set them to new values.	1400
		1401	When arguments are given, then the selection coordinates are set to
		1402	C<$row> and C<$col>, and the selection screen is set to the current
		1403	screen.
		1404
		1405	=item $screen = $term->selection_screen ([$screen])
		1406
		1407	Returns the current selection screen, and then optionally sets it.
1123		1408
1124	=item $term->selection_make ($eventtime[, $rectangular])	1409	=item $term->selection_make ($eventtime[, $rectangular])
1125		1410
1126	Tries to make a selection as set by C<selection_beg> and	1411	Tries to make a selection as set by C<selection_beg> and
1127	C<selection_end>. If C<$rectangular> is true (default: false), a	1412	C<selection_end>. If C<$rectangular> is true (default: false), a
1128	rectangular selection will be made. This is the prefered function to make	1413	rectangular selection will be made. This is the preferred function to make
1129	a selection.	1414	a selection.
1130		1415
1131	=item $success = $term->selection_grab ($eventtime)	1416	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1132		1417
1133	Try to request the primary selection text from the server (for example, as	1418	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1419	true) selection from the server. The corresponding text can be set
1134	set by the next method). No visual feedback will be given. This function	1420	with the next method. No visual feedback will be given. This function
1135	is mostly useful from within C<on_sel_grab> hooks.	1421	is mostly useful from within C<on_sel_grab> hooks.
1136		1422
1137	=item $oldtext = $term->selection ([$newtext])	1423	=item $oldtext = $term->selection ([$newtext, $clipboard])
1138		1424
1139	Return the current selection text and optionally replace it by C<$newtext>.	1425	Return the current selection (clipboard if C<$clipboard> is true) text
		1426	and optionally replace it by C<$newtext>.
		1427
		1428	=item $term->selection_clear ([$clipboard])
		1429
		1430	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1140		1431
1141	=item $term->overlay_simple ($x, $y, $text)	1432	=item $term->overlay_simple ($x, $y, $text)
1142		1433
1143	Create a simple multi-line overlay box. See the next method for details.	1434	Create a simple multi-line overlay box. See the next method for details.
1144		1435
…		…
1174		1465
1175	The methods currently supported on C<urxvt::overlay> objects are:	1466	The methods currently supported on C<urxvt::overlay> objects are:
1176		1467
1177	=over 4	1468	=over 4
1178		1469
1179	=item $overlay->set ($x, $y, $text, $rend)	1470	=item $overlay->set ($x, $y, $text[, $rend])
1180		1471
1181	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1472	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1182	text in rxvt-unicode's special encoding and an array of rendition values	1473	text in rxvt-unicode's special encoding and an array of rendition values
1183	at a specific position inside the overlay.	1474	at a specific position inside the overlay.
		1475
		1476	If C<$rend> is missing, then the rendition will not be changed.
1184		1477
1185	=item $overlay->hide	1478	=item $overlay->hide
1186		1479
1187	If visible, hide the overlay, but do not destroy it.	1480	If visible, hide the overlay, but do not destroy it.
1188		1481
…		…
1258		1551
1259	Normally its not a good idea to use this function, as programs might be	1552	Normally its not a good idea to use this function, as programs might be
1260	confused by changes in cursor position or scrolling. Its useful inside a	1553	confused by changes in cursor position or scrolling. Its useful inside a
1261	C<on_add_lines> hook, though.	1554	C<on_add_lines> hook, though.
1262		1555
		1556	=item $term->scr_change_screen ($screen)
		1557
		1558	Switch to given screen - 0 primary, 1 secondary.
		1559
1263	=item $term->cmd_parse ($octets)	1560	=item $term->cmd_parse ($octets)
1264		1561
1265	Similar to C<scr_add_lines>, but the argument must be in the	1562	Similar to C<scr_add_lines>, but the argument must be in the
1266	locale-specific encoding of the terminal and can contain command sequences	1563	locale-specific encoding of the terminal and can contain command sequences
1267	(escape codes) that will be interpreted.	1564	(escape codes) that will be interpreted.
1268		1565
1269	=item $term->tt_write ($octets)	1566	=item $term->tt_write ($octets)
1270		1567
1271	Write the octets given in C<$data> to the tty (i.e. as program input). To	1568	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1272	pass characters instead of octets, you should convert your strings first	1569	pass characters instead of octets, you should convert your strings first
1273	to the locale-specific encoding using C<< $term->locale_encode >>.	1570	to the locale-specific encoding using C<< $term->locale_encode >>.
		1571
		1572	=item $term->tt_paste ($octets)
		1573
		1574	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1575	CR and bracketing the data with control sequences if bracketed paste mode
		1576	is set.
1274		1577
1275	=item $old_events = $term->pty_ev_events ([$new_events])	1578	=item $old_events = $term->pty_ev_events ([$new_events])
1276		1579
1277	Replaces the event mask of the pty watcher by the given event mask. Can	1580	Replaces the event mask of the pty watcher by the given event mask. Can
1278	be used to suppress input and output handling to the pty/tty. See the	1581	be used to suppress input and output handling to the pty/tty. See the
1279	description of C<< urxvt::timer->events >>. Make sure to always restore	1582	description of C<< urxvt::timer->events >>. Make sure to always restore
1280	the previous value.	1583	the previous value.
1281		1584
		1585	=item $fd = $term->pty_fd
		1586
		1587	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1588	is used.
		1589
1282	=item $windowid = $term->parent	1590	=item $windowid = $term->parent
1283		1591
1284	Return the window id of the toplevel window.	1592	Return the window id of the toplevel window.
1285		1593
1286	=item $windowid = $term->vt	1594	=item $windowid = $term->vt
…		…
1292	Adds the specified events to the vt event mask. Useful e.g. when you want	1600	Adds the specified events to the vt event mask. Useful e.g. when you want
1293	to receive pointer events all the times:	1601	to receive pointer events all the times:
1294		1602
1295	$term->vt_emask_add (urxvt::PointerMotionMask);	1603	$term->vt_emask_add (urxvt::PointerMotionMask);
1296		1604
		1605	=item $term->focus_in
		1606
		1607	=item $term->focus_out
		1608
		1609	=item $term->key_press ($state, $keycode[, $time])
		1610
		1611	=item $term->key_release ($state, $keycode[, $time])
		1612
		1613	Deliver various fake events to to terminal.
		1614
1297	=item $window_width = $term->width	1615	=item $window_width = $term->width
1298		1616
1299	=item $window_height = $term->height	1617	=item $window_height = $term->height
1300		1618
1301	=item $font_width = $term->fwidth	1619	=item $font_width = $term->fwidth
…		…
1331	=item $env = $term->env	1649	=item $env = $term->env
1332		1650
1333	Returns a copy of the environment in effect for the terminal as a hashref	1651	Returns a copy of the environment in effect for the terminal as a hashref
1334	similar to C<\%ENV>.	1652	similar to C<\%ENV>.
1335		1653
		1654	=item @envv = $term->envv
		1655
		1656	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1657
		1658	=item @argv = $term->argv
		1659
		1660	Return the argument vector as this terminal, similar to @ARGV, but
		1661	includes the program name as first element.
		1662
1336	=cut	1663	=cut
1337		1664
1338	sub env {	1665	sub env {
1339	if (my $env = $_[0]->_env) {
1340	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1666	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1341	} else {
1342	+{ %ENV }
1343	}
1344	}	1667	}
1345		1668
1346	=item $modifiermask = $term->ModLevel3Mask	1669	=item $modifiermask = $term->ModLevel3Mask
1347		1670
1348	=item $modifiermask = $term->ModMetaMask	1671	=item $modifiermask = $term->ModMetaMask
1349		1672
1350	=item $modifiermask = $term->ModNumLockMask	1673	=item $modifiermask = $term->ModNumLockMask
1351		1674
1352	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1675	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1353	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1676	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1677
		1678	=item $screen = $term->current_screen
		1679
		1680	Returns the currently displayed screen (0 primary, 1 secondary).
		1681
		1682	=item $cursor_is_hidden = $term->hidden_cursor
		1683
		1684	Returns whether the cursor is currently hidden or not.
1354		1685
1355	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
1356		1687
1357	Returns the row number of the topmost displayed line. Maximum value is	1688	Returns the row number of the topmost displayed line. Maximum value is
1358	C<0>, which displays the normal terminal contents. Lower values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1366		1697
1367	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1368		1699
1369	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1370		1701
1371	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1372	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1703	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1373	terminal line. The scrollback buffer starts at line C<-1> and extends to
1374	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
1375	is requested.	1705	is requested.
1376		1706
1377	If C<$new_text> is specified, it will replace characters in the current	1707	If C<$new_text> is specified, it will replace characters in the current
1378	line, starting at column C<$start_col> (default C<0>), which is useful	1708	line, starting at column C<$start_col> (default C<0>), which is useful
1379	to replace only parts of a line. The font index in the rendition will	1709	to replace only parts of a line. The font index in the rendition will
1380	automatically be updated.	1710	automatically be updated.
1381		1711
1382	C<$text> is in a special encoding: tabs and wide characters that use more	1712	C<$text> is in a special encoding: tabs and wide characters that use more
1383	than one cell when displayed are padded with urxvt::NOCHAR characters	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1384	(C<chr 65535>). Characters with combining characters and other characters	1714	characters. Characters with combining characters and other characters that
1385	that do not fit into the normal tetx encoding will be replaced with	1715	do not fit into the normal text encoding will be replaced with characters
1386	characters in the private use area.	1716	in the private use area.
1387		1717
1388	You have to obey this encoding when changing text. The advantage is	1718	You have to obey this encoding when changing text. The advantage is
1389	that C<substr> and similar functions work on screen cells and not on	1719	that C<substr> and similar functions work on screen cells and not on
1390	characters.	1720	characters.
1391		1721
…		…
1535	where one character corresponds to one screen cell. See	1865	where one character corresponds to one screen cell. See
1536	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1537		1867
1538	=item $string = $term->special_decode $text	1868	=item $string = $term->special_decode $text
1539		1869
1540	Converts rxvt-unicodes text reprsentation into a perl string. See	1870	Converts rxvt-unicodes text representation into a perl string. See
1541	C<< $term->ROW_t >> for details.	1871	C<< $term->ROW_t >> for details.
1542		1872
1543	=item $success = $term->grab_button ($button, $modifiermask)	1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1544		1874
		1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1876
1545	Registers a synchronous button grab. See the XGrabButton manpage.	1877	Register/unregister a synchronous button grab. See the XGrabButton
		1878	manpage.
1546		1879
1547	=item $success = $term->grab ($eventtime[, $sync])	1880	=item $success = $term->grab ($eventtime[, $sync])
1548		1881
1549	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1550	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1551		1884
1552	=item $term->allow_events_async	1885	=item $term->allow_events_async
1553		1886
1554	Calls XAllowEvents with AsyncBoth for the most recent grab.	1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
1555		1888
…		…
1562	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1563	recent grab.	1896	recent grab.
1564		1897
1565	=item $term->ungrab	1898	=item $term->ungrab
1566		1899
1567	Calls XUngrab for the most recent grab. Is called automatically on	1900	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1568	evaluation errors, as it is better to lose the grab in the error case as	1901	evaluation errors, as it is better to lose the grab in the error case as
1569	the session.	1902	the session.
		1903
		1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1905
		1906	=item $atom_name = $term->XGetAtomName ($atom)
		1907
		1908	=item @atoms = $term->XListProperties ($window)
		1909
		1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1911
		1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1913
		1914	=item $term->XDeleteProperty ($window, $property)
		1915
		1916	=item $window = $term->DefaultRootWindow
		1917
		1918	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1919
		1920	=item $term->XMapWindow ($window)
		1921
		1922	=item $term->XUnmapWindow ($window)
		1923
		1924	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1925
		1926	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1927
		1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1929
		1930	Various X or X-related functions. The C<$term> object only serves as
		1931	the source of the display, otherwise those functions map more-or-less
		1932	directly onto the X functions of the same name.
1570		1933
1571	=back	1934	=back
1572		1935
1573	=cut	1936	=cut
1574		1937
…		…
1638	my ($self, $text, $cb) = @_;	2001	my ($self, $text, $cb) = @_;
1639		2002
1640	$self->add_item ({ type => "button", text => $text, activate => $cb});	2003	$self->add_item ({ type => "button", text => $text, activate => $cb});
1641	}	2004	}
1642		2005
1643	=item $popup->add_toggle ($text, $cb, $initial_value)	2006	=item $popup->add_toggle ($text, $initial_value, $cb)
1644		2007
1645	Adds a toggle/checkbox item to the popup. Teh callback gets called	2008	Adds a toggle/checkbox item to the popup. The callback gets called
1646	whenever it gets toggled, with a boolean indicating its value as its first	2009	whenever it gets toggled, with a boolean indicating its new value as its
1647	argument.	2010	first argument.
1648		2011
1649	=cut	2012	=cut
1650		2013
1651	sub add_toggle {	2014	sub add_toggle {
1652	my ($self, $text, $cb, $value) = @_;	2015	my ($self, $text, $value, $cb) = @_;
1653		2016
1654	my $item; $item = {	2017	my $item; $item = {
1655	type => "button",	2018	type => "button",
1656	text => " $text",	2019	text => " $text",
1657	value => $value,	2020	value => $value,
…		…
1676	my $env = $self->{term}->env;	2039	my $env = $self->{term}->env;
1677	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2040	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1678	delete $env->{LC_ALL};	2041	delete $env->{LC_ALL};
1679	$env->{LC_CTYPE} = $self->{term}->locale;	2042	$env->{LC_CTYPE} = $self->{term}->locale;
1680		2043
1681	urxvt::term->new ($env, "popup",	2044	my $term = urxvt::term->new (
		2045	$env, "popup",
1682	"--perl-lib" => "", "--perl-ext-common" => "",	2046	"--perl-lib" => "", "--perl-ext-common" => "",
1683	"-pty-fd" => -1, "-sl" => 0,	2047	"-pty-fd" => -1, "-sl" => 0,
1684	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2048	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1685	"--transient-for" => $self->{term}->parent,	2049	"--transient-for" => $self->{term}->parent,
1686	"-display" => $self->{term}->display_id,	2050	"-display" => $self->{term}->display_id,
1687	"-pe" => "urxvt-popup")	2051	"-pe" => "urxvt-popup",
1688	or die "unable to create popup window\n";	2052	) or die "unable to create popup window\n";
		2053
		2054	unless (delete $term->{urxvt_popup_init_done}) {
		2055	$term->ungrab;
		2056	$term->destroy;
		2057	die "unable to initialise popup window\n";
		2058	}
1689	}	2059	}
1690		2060
1691	sub DESTROY {	2061	sub DESTROY {
1692	my ($self) = @_;	2062	my ($self) = @_;
1693		2063
…		…
1698	=back	2068	=back
1699		2069
1700	=cut	2070	=cut
1701		2071
1702	package urxvt::watcher;	2072	package urxvt::watcher;
1703
1704	@urxvt::timer::ISA = __PACKAGE__;
1705	@urxvt::iow::ISA = __PACKAGE__;
1706	@urxvt::pw::ISA = __PACKAGE__;
1707	@urxvt::iw::ISA = __PACKAGE__;
1708		2073
1709	=head2 The C<urxvt::timer> Class	2074	=head2 The C<urxvt::timer> Class
1710		2075
1711	This class implements timer watchers/events. Time is represented as a	2076	This class implements timer watchers/events. Time is represented as a
1712	fractional number of seconds since the epoch. Example:	2077	fractional number of seconds since the epoch. Example:
…		…
1716	->new	2081	->new
1717	->interval (1)	2082	->interval (1)
1718	->cb (sub {	2083	->cb (sub {
1719	$term->{overlay}->set (0, 0,	2084	$term->{overlay}->set (0, 0,
1720	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2085	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1721	});	2086	});
1722		2087
1723	=over 4	2088	=over 4
1724		2089
1725	=item $timer = new urxvt::timer	2090	=item $timer = new urxvt::timer
1726		2091
…		…
1729		2094
1730	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2095	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1731		2096
1732	Set the callback to be called when the timer triggers.	2097	Set the callback to be called when the timer triggers.
1733		2098
1734	=item $tstamp = $timer->at
1735
1736	Return the time this watcher will fire next.
1737
1738	=item $timer = $timer->set ($tstamp)	2099	=item $timer = $timer->set ($tstamp[, $interval])
1739		2100
1740	Set the time the event is generated to $tstamp.	2101	Set the time the event is generated to $tstamp (and optionally specifies a
		2102	new $interval).
1741		2103
1742	=item $timer = $timer->interval ($interval)	2104	=item $timer = $timer->interval ($interval)
1743		2105
1744	Normally (and when C<$interval> is C<0>), the timer will automatically	2106	By default (and when C<$interval> is C<0>), the timer will automatically
1745	stop after it has fired once. If C<$interval> is non-zero, then the timer	2107	stop after it has fired once. If C<$interval> is non-zero, then the timer
1746	is automatically rescheduled at the given intervals.	2108	is automatically rescheduled at the given intervals.
1747		2109
1748	=item $timer = $timer->start	2110	=item $timer = $timer->start
1749		2111
1750	Start the timer.	2112	Start the timer.
1751		2113
1752	=item $timer = $timer->start ($tstamp)	2114	=item $timer = $timer->start ($tstamp[, $interval])
1753		2115
1754	Set the event trigger time to C<$tstamp> and start the timer.	2116	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2117	also replaces the interval.
1755		2118
1756	=item $timer = $timer->after ($delay)	2119	=item $timer = $timer->after ($delay[, $interval])
1757		2120
1758	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2121	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1759		2122
1760	=item $timer = $timer->stop	2123	=item $timer = $timer->stop
1761		2124
…		…
1769		2132
1770	$term->{socket} = ...	2133	$term->{socket} = ...
1771	$term->{iow} = urxvt::iow	2134	$term->{iow} = urxvt::iow
1772	->new	2135	->new
1773	->fd (fileno $term->{socket})	2136	->fd (fileno $term->{socket})
1774	->events (urxvt::EVENT_READ)	2137	->events (urxvt::EV_READ)
1775	->start	2138	->start
1776	->cb (sub {	2139	->cb (sub {
1777	my ($iow, $revents) = @_;	2140	my ($iow, $revents) = @_;
1778	# $revents must be 1 here, no need to check	2141	# $revents must be 1 here, no need to check
1779	sysread $term->{socket}, my $buf, 8192	2142	sysread $term->{socket}, my $buf, 8192
…		…
1792	Set the callback to be called when io events are triggered. C<$reventmask>	2155	Set the callback to be called when io events are triggered. C<$reventmask>
1793	is a bitset as described in the C<events> method.	2156	is a bitset as described in the C<events> method.
1794		2157
1795	=item $iow = $iow->fd ($fd)	2158	=item $iow = $iow->fd ($fd)
1796		2159
1797	Set the filedescriptor (not handle) to watch.	2160	Set the file descriptor (not handle) to watch.
1798		2161
1799	=item $iow = $iow->events ($eventmask)	2162	=item $iow = $iow->events ($eventmask)
1800		2163
1801	Set the event mask to watch. The only allowed values are	2164	Set the event mask to watch. The only allowed values are
1802	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2165	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1803	together, or C<urxvt::EVENT_NONE>.	2166	together, or C<urxvt::EV_NONE>.
1804		2167
1805	=item $iow = $iow->start	2168	=item $iow = $iow->start
1806		2169
1807	Start watching for requested events on the given handle.	2170	Start watching for requested events on the given handle.
1808		2171
1809	=item $iow = $iow->stop	2172	=item $iow = $iow->stop
1810		2173
1811	Stop watching for events on the given filehandle.	2174	Stop watching for events on the given file handle.
1812		2175
1813	=back	2176	=back
1814		2177
1815	=head2 The C<urxvt::iw> Class	2178	=head2 The C<urxvt::iw> Class
1816		2179
…		…
1849	->new	2212	->new
1850	->start ($pid)	2213	->start ($pid)
1851	->cb (sub {	2214	->cb (sub {
1852	my ($pw, $exit_status) = @_;	2215	my ($pw, $exit_status) = @_;
1853	...	2216	...
1854	});	2217	});
1855		2218
1856	=over 4	2219	=over 4
1857		2220
1858	=item $pw = new urxvt::pw	2221	=item $pw = new urxvt::pw
1859		2222
…		…
1863		2226
1864	Set the callback to be called when the timer triggers.	2227	Set the callback to be called when the timer triggers.
1865		2228
1866	=item $pw = $timer->start ($pid)	2229	=item $pw = $timer->start ($pid)
1867		2230
1868	Tells the wqtcher to start watching for process C<$pid>.	2231	Tells the watcher to start watching for process C<$pid>.
1869		2232
1870	=item $pw = $pw->stop	2233	=item $pw = $pw->stop
1871		2234
1872	Stop the watcher.	2235	Stop the watcher.
1873		2236
…		…
1886		2249
1887	=item >= 3 - script loading and management	2250	=item >= 3 - script loading and management
1888		2251
1889	=item >=10 - all called hooks	2252	=item >=10 - all called hooks
1890		2253
1891	=item >=11 - hook reutrn values	2254	=item >=11 - hook return values
1892		2255
1893	=back	2256	=back
1894		2257
1895	=head1 AUTHOR	2258	=head1 AUTHOR
1896		2259
1897	Marc Lehmann <pcg@goof.com>	2260	Marc Lehmann <schmorp@schmorp.de>
1898	http://software.schmorp.de/pkg/rxvt-unicode	2261	http://software.schmorp.de/pkg/rxvt-unicode
1899		2262
1900	=cut	2263	=cut
1901		2264
1902	1	2265	1
		2266
		2267	# vim: sw=3:

Diff Legend

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