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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC vs. Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC