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.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 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	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. 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
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
49	It also offers the following bindable event:	57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		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: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
		85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	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
64	runtime.	100	runtime.
65		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
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	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
69	text into various other formats/action.	122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
70		143
71	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
72		145
73	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
76		150
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79	history, C<enter> leaves search mode at the current position and C<escape>	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
81		158
82	=item digital-clock	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.
83		162
84	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
85		164
86	=item mark-urls	165	=item readline (enabled by default)
87		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.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	250	Uses per-line display filtering (C<on_line_update>) to underline text
		251	matching a certain pattern and make it clickable. When clicked with the
		252	mouse button specified in the C<matcher.button> resource (default 2, or
		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.
		258
		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.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		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.
89		313
90	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
91		315
92	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
93	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
94	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		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.
95		391
96	=item example-refresh-hooks	392	=item example-refresh-hooks
97		393
98	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
99	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	396	overlays or changes.
101		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
		402
102	=back	403	=back
		404
		405	=head1 API DOCUMENTATION
103		406
104	=head2 General API Considerations	407	=head2 General API Considerations
105		408
106	All objects (such as terminals, time watchers etc.) are typical	409	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	410	reference-to-hash objects. The hash can be used to store anything you
…		…
119		422
120	=over 4	423	=over 4
121		424
122	=item $text	425	=item $text
123		426
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
125	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.
126		429
127	=item $string	430	=item $string
128		431
129	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
130	characters and is to be distinguished with text encoded in a specific	433	characters and is to be distinguished with text encoded in a specific
…		…
137		440
138	=back	441	=back
139		442
140	=head2 Extension Objects	443	=head2 Extension Objects
141		444
142	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
143	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 extension objects,
144	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
145	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
146	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
147	use.	451	internal use.
148		452
149	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
150	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
151		455
152	It has the following methods and data members:	456	It has the following methods and data members:
…		…
173	=head2 Hooks	477	=head2 Hooks
174		478
175	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
176	called whenever the relevant event happens.	480	called whenever the relevant event happens.
177		481
178	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
179	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
180		484
181	B<All> of these hooks must return a boolean value. If it is true, then the	485	B<All> of these hooks must return a boolean value. If any of the called
182	event counts as being I<consumed>, and the invocation of other hooks is	486	hooks returns true, then the event counts as being I<consumed>, and the
183	skipped, and the relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
184		488
185	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
186		490
187	=over 4	491	=over 4
188		492
189	=item on_init $term	493	=item on_init $term
190		494
191	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
192	windows are created or the command gets run. Most methods are unsafe to	496	windows are created or the command gets run. Most methods are unsafe to
193	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	498	have not yet been determined. You can safely query and change resources
195	though.	499	and options, though. For many purposes the C<on_start> hook is a better
		500	place.
		501
		502	=item on_start $term
		503
		504	Called at the very end of initialisation of a new terminal, just before
		505	trying to map (display) the toplevel and returning to the main loop.
		506
		507	=item on_destroy $term
		508
		509	Called whenever something tries to destroy terminal, when the terminal is
		510	still fully functional (not for long, though).
196		511
197	=item on_reset $term	512	=item on_reset $term
198		513
199	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
200	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
201	variables.	516	variables.
202		517
203	=item on_start $term	518	=item on_child_start $term, $pid
204		519
205	Called at the very end of initialisation of a new terminal, just before	520	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	521
		522	=item on_child_exit $term, $status
		523
		524	Called just after the child process has exited. C<$status> is the status
		525	from C<waitpid>.
207		526
208	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
209		528
210	Called whenever a selection has been made by the user, but before the	529	Called whenever a selection has been made by the user, but before the
211	selection text is copied, so changes to the beginning, end or type of the	530	selection text is copied, so changes to the beginning, end or type of the
…		…
218		537
219	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
220	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
221	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
222		541
223	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.
224		543
225	=item on_sel_extend $term	544	=item on_sel_extend $term
226		545
227	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
228	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
229	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
230	processing.	549	processing. This can happen multiple times, as long as the callback
		550	returns true, it will be called on every further click by the user and is
		551	supposed to enlarge the selection more and more, if possible.
231		552
232	See the F<selection> example extension.	553	See the F<selection> example extension.
233		554
234	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
235		556
236	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
237	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
238	show this many lines of scrollback.	559	show this many lines of scrollback.
239		560
240	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
241		562
…		…
245		566
246	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,
247	$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
248	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
249		570
250	=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
251		582
252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
253	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
254	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
255	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,
256	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
257	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	}
258		599
259	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,
260	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
261	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.
262		606
263	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
264		608
265	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
266	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
…		…
271	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
272		616
273	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
274	suppress or filter tty input.	618	suppress or filter tty input.
275		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
276	=item on_line_update $term, $row	627	=item on_line_update $term, $row
277		628
278	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
279	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
280	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,
…		…
287	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
288	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
289		640
290	=item on_refresh_begin $term	641	=item on_refresh_begin $term
291		642
292	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
293	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
294	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
295	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
296		647
297	=item on_refresh_end $term	648	=item on_refresh_end $term
298		649
299	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>.
300		651
301	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
302		653
303	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
304	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>
305	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.
		666
		667	=item on_x_event $term, $event
		668
		669	Called on every X event received on the vt window (and possibly other
		670	windows). Should only be used as a last resort. Most event structure
		671	members are not passed.
		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
306		676
307	=item on_focus_in $term	677	=item on_focus_in $term
308		678
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	680	does focus in processing.
311		681
312	=item on_focus_out $term	682	=item on_focus_out $term
313		683
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	685	focus out processing.
316		686
		687	=item on_configure_notify $term, $event
		688
		689	=item on_property_notify $term, $event
		690
317	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
318		692
319	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
320		694
321	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
326		700
327	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
328		702
329	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
330		704
331	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
332	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.
333		707
334	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
335	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
336	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
337		711
338	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
340		714
341	subwindow.	715	subwindow.
342		716
343	=back	717	=item on_client_message $term, $event
344		718
345	=head2 Variables in the C<urxvt> Package	719	=item on_wm_protocols $term, $event
346		720
347	=over 4	721	=item on_wm_delete_window $term, $event
348		722
349	=item $urxvt::TERM	723	Called when various types of ClientMessage events are received (all with
		724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
350		725
351	The current terminal. This variable stores the current C<urxvt::term>	726	=item on_bell $term
352	object, whenever a callback/hook is executing.
353		727
354	=back	728	Called on receipt of a bell character.
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		729
453	=back	730	=back
454		731
455	=cut	732	=cut
456		733
…		…
462	use Scalar::Util ();	739	use Scalar::Util ();
463	use List::Util ();	740	use List::Util ();
464		741
465	our $VERSION = 1;	742	our $VERSION = 1;
466	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
467	our @HOOKNAME;	746	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	748	our %OPTION;
470		749
471	our $LIBDIR;	750	our $LIBDIR;
472	our $RESNAME;	751	our $RESNAME;
473	our $RESCLASS;	752	our $RESCLASS;
474	our $RXVTNAME;	753	our $RXVTNAME;
475		754
		755	our $NOCHAR = chr 0xffff;
		756
		757	=head2 Variables in the C<urxvt> Package
		758
		759	=over 4
		760
		761	=item $urxvt::LIBDIR
		762
		763	The rxvt-unicode library directory, where, among other things, the perl
		764	modules and scripts are stored.
		765
		766	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		767
		768	The resource class and name rxvt-unicode uses to look up X resources.
		769
		770	=item $urxvt::RXVTNAME
		771
		772	The basename of the installed binaries, usually C<urxvt>.
		773
		774	=item $urxvt::TERM
		775
		776	The current terminal. This variable stores the current C<urxvt::term>
		777	object, whenever a callback/hook is executing.
		778
		779	=item @urxvt::TERM_INIT
		780
		781	All code references in this array will be called as methods of the next newly
		782	created C<urxvt::term> object (during the C<on_init> phase). The array
		783	gets cleared before the code references that were in it are being executed,
		784	so references can push themselves onto it again if they so desire.
		785
		786	This complements to the perl-eval command line option, but gets executed
		787	first.
		788
		789	=item @urxvt::TERM_EXT
		790
		791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		792	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		793	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		794
		795	=back
		796
		797	=head2 Functions in the C<urxvt> Package
		798
		799	=over 4
		800
		801	=item urxvt::fatal $errormessage
		802
		803	Fatally aborts execution with the given error message (which should
		804	include a trailing newline). Avoid at all costs! The only time this
		805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
		807
		808	=item urxvt::warn $string
		809
		810	Calls C<rxvt_warn> with the given string which should include a trailing
		811	newline. The module also overwrites the C<warn> builtin with a function
		812	that calls this function.
		813
		814	Using this function has the advantage that its output ends up in the
		815	correct place, e.g. on stderr of the connecting urxvtc client.
		816
		817	Messages have a size limit of 1023 bytes currently.
		818
		819	=item @terms = urxvt::termlist
		820
		821	Returns all urxvt::term objects that exist in this process, regardless of
		822	whether they are started, being destroyed etc., so be careful. Only term
		823	objects that have perl extensions attached will be returned (because there
		824	is no urxvt::term object associated with others).
		825
		826	=item $time = urxvt::NOW
		827
		828	Returns the "current time" (as per the event loop).
		829
		830	=item urxvt::CurrentTime
		831
		832	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		833	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		834	Button4Mask, Button5Mask, AnyModifier
		835
		836	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		837	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		838	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		839	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		840	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		841	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		842	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		843
		844	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		845	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		846	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		847	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		848	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		849	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		850	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		851
		852	Various constants for use in X calls and event processing.
		853
		854	=back
		855
		856	=head2 RENDITION
		857
		858	Rendition bitsets contain information about colour, font, font styles and
		859	similar information for each screen cell.
		860
		861	The following "macros" deal with changes in rendition sets. You should
		862	never just create a bitset, you should always modify an existing one,
		863	as they contain important information required for correct operation of
		864	rxvt-unicode.
		865
		866	=over 4
		867
		868	=item $rend = urxvt::DEFAULT_RSTYLE
		869
		870	Returns the default rendition, as used when the terminal is starting up or
		871	being reset. Useful as a base to start when creating renditions.
		872
		873	=item $rend = urxvt::OVERLAY_RSTYLE
		874
		875	Return the rendition mask used for overlays by default.
		876
		877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
		879
		880	Return the bit that enabled bold, italic, blink, reverse-video and
		881	underline, respectively. To enable such a style, just logically OR it into
		882	the bitset.
		883
		884	=item $foreground = urxvt::GET_BASEFG $rend
		885
		886	=item $background = urxvt::GET_BASEBG $rend
		887
		888	Return the foreground/background colour index, respectively.
		889
		890	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		891
		892	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		893
		894	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		895
		896	Replace the foreground/background colour in the rendition mask with the
		897	specified one.
		898
		899	=item $value = urxvt::GET_CUSTOM $rend
		900
		901	Return the "custom" value: Every rendition has 5 bits for use by
		902	extensions. They can be set and changed as you like and are initially
		903	zero.
		904
		905	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		906
		907	Change the custom value.
		908
		909	=back
		910
		911	=cut
		912
476	BEGIN {	913	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	914	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	915	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	916	my $msg = join "", @_;
482	$msg .= "\n"	917	$msg .= "\n"
483	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	919	urxvt::warn ($msg);
485	};	920	};
486
487	delete $ENV{IFS};
488	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	921	}
492		922
493	my @hook_count;	923	no warnings 'utf8';
		924
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		926
496	sub verbose {	927	sub verbose {
497	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	929	warn "$msg\n" if $level <= $verbosity;
499	}	930	}
500		931
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	932	my %extension_pkg;
503		933
504	# load a single script into its own package, once only	934	# load a single script into its own package, once only
505	sub extension_package($) {	935	sub extension_package($) {
506	my ($path) = @_;	936	my ($path) = @_;
507		937
508	$extension_pkg{$path} ||= do {	938	$extension_pkg{$path} ||= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	939	$path =~ /([^\/\\]+)$/;
		940	my $pkg = $1;
		941	$pkg =~ s/[^[:word:]]/_/g;
		942	$pkg = "urxvt::ext::$pkg";
510		943
511	verbose 3, "loading extension '$path' into package '$pkg'";	944	verbose 3, "loading extension '$path' into package '$pkg'";
512		945
513	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
514	or die "$path: $!";	947	or die "$path: $!";
515		948
516	my $source = untaint	949	my $source =
517	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
521	. "\n};\n1";	953	. "\n};\n1";
522		954
523	eval $source	955	eval $source
…		…
534	local $TERM = shift;	966	local $TERM = shift;
535	my $htype = shift;	967	my $htype = shift;
536		968
537	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		971
540	my %ext_arg;	972	my %ext_arg;
541		973
		974	{
		975	my @init = @TERM_INIT;
		976	@TERM_INIT = ();
		977	$_->($TERM) for @init;
		978	my @pkg = @TERM_EXT;
		979	@TERM_EXT = ();
		980	$TERM->register_package ($_) for @pkg;
		981	}
		982
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	984	if ($_ eq "default") {
544	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
545	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	987	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
548	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
549	} else {	990	} else {
550	$ext_arg{$_} ||= [];	991	$ext_arg{$_} ||= [];
551	}	992	}
552	}	993	}
553		994
554	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
555	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
556		997
557	if (@files) {	998	if (@files) {
558	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
559	} else {	1000	} else {
560	warn "perl extension '$ext' not found in perl library search path\n";	1001	warn "perl extension '$ext' not found in perl library search path\n";
561	}	1002	}
562	}	1003	}
563		1004
…		…
569		1010
570	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
571	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
572	if $verbosity >= 10;	1013	if $verbosity >= 10;
573		1014
574	keys %$cb;	1015	for my $pkg (keys %$cb) {
575
576	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	1017	$retval ||= $retval_;
579		1018
580	if ($@) {	1019	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	1021	warn $@;
583	}	1022	}
584	}	1023	}
		1024
		1025	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1026	if $verbosity >= 11;
585	}	1027	}
586		1028
587	if ($htype == 1) { # DESTROY	1029	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	1030	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	1031	%$_ = () for values %{ $TERM->{_pkg} };
597		1032
598	# clear package	1033	# clear package
599	%$TERM = ();	1034	%$TERM = ();
600	}	1035	}
601		1036
602	$retval	1037	$retval
		1038	}
		1039
		1040	sub SET_COLOR($$$) {
		1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1042	}
		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask |= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
603	}	1067	}
604		1068
605	# urxvt::term::extension	1069	# urxvt::term::extension
606		1070
607	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	1077	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	1078	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	1079	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	1080	or Carp::croak "unsupported hook type '$name'";
617		1081
		1082	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1083	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		1084
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1085	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	1086	}
625	}	1087	}
626		1088
…		…
631	for my $name (@hook) {	1093	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	1094	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	1095	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	1096	or Carp::croak "unsupported hook type '$name'";
635		1097
		1098	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1099	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	1100	}
641	}	1101	}
642		1102
643	our $AUTOLOAD;	1103	our $AUTOLOAD;
644		1104
…		…
675		1135
676	=head2 The C<urxvt::anyevent> Class	1136	=head2 The C<urxvt::anyevent> Class
677		1137
678	The sole purpose of this class is to deliver an interface to the	1138	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	1139	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	1140	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	1141	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	1142	is that you cannot use blocking APIs, but the non-blocking variant should
		1143	work.
683		1144
684	=cut	1145	=cut
685		1146
686	our $VERSION = 1;	1147	our $VERSION = '5.23';
687		1148
688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
690		1151
691	sub timer {	1152	sub timer {
…		…
693		1154
694	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
695		1156
696	urxvt::timer	1157	urxvt::timer
697	->new	1158	->new
698	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
699	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
700	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
701	$cb->();	1162	$cb->();
702	})	1163	})
703	}	1164	}
704		1165
705	sub io {	1166	sub io {
706	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
707		1168
708	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
709		1172
710	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
711	->new	1174	->new
712	->fd (fileno $arg{fh})	1175	->fd ($fd)
713	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
714	| ($arg{poll} =~ /w/ ? 2 : 0))	1177	| ($arg{poll} =~ /w/ ? 2 : 0))
715	->start	1178	->start
716	->cb (sub {	1179	->cb ($cb)
717	$cb->(($_[1] & 1 ? 'r' : '')
718	. ($_[1] & 2 ? 'w' : ''));
719	})],
720	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
721	}	1206	}
722		1207
723	sub DESTROY {	1208	sub DESTROY {
724	$_[0][1]->stop;	1209	$_[0][1]->stop;
725	}	1210	}
726		1211
727	sub condvar {	1212	sub one_event {
728	bless \my $flag, urxvt::anyevent::condvar::
729	}
730
731	sub urxvt::anyevent::condvar::broadcast {
732	${$_[0]}++;
733	}
734
735	sub urxvt::anyevent::condvar::wait {
736	unless (${$_[0]}) {
737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
738	}
739	}	1214	}
740		1215
741	package urxvt::term;	1216	package urxvt::term;
742		1217
743	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
748		1223
749	# find on_xxx subs in the package and register them	1224	# find on_xxx subs in the package and register them
750	# as hooks	1225	# as hooks
751	sub register_package {	1226	sub register_package {
752	my ($self, $pkg, $argv) = @_;	1227	my ($self, $pkg, $argv) = @_;
		1228
		1229	no strict 'refs';
		1230
		1231	urxvt::verbose 6, "register package $pkg to $self";
		1232
		1233	@{"$pkg\::ISA"} = urxvt::term::extension::;
753		1234
754	my $proxy = bless {	1235	my $proxy = bless {
755	_pkg => $pkg,	1236	_pkg => $pkg,
756	argv => $argv,	1237	argv => $argv,
757	}, $pkg;	1238	}, $pkg;
…		…
764	$proxy->enable ($name => $ref);	1245	$proxy->enable ($name => $ref);
765	}	1246	}
766	}	1247	}
767	}	1248	}
768		1249
		1250	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1251
		1252	Creates a new terminal, very similar as if you had started it with system
		1253	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1254	hash which defines the environment of the new terminal.
		1255
		1256	Croaks (and probably outputs an error message) if the new instance
		1257	couldn't be created. Returns C<undef> if the new instance didn't
		1258	initialise perl, and the terminal object otherwise. The C<init> and
		1259	C<start> hooks will be called before this call returns, and are free to
		1260	refer to global data (which is race free).
		1261
		1262	=cut
		1263
		1264	sub new {
		1265	my ($class, $env, @args) = @_;
		1266
		1267	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1268	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1269
		1270	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1271	}
		1272
769	=item $term->destroy	1273	=item $term->destroy
770		1274
771	Destroy the terminal object (close the window, free resources etc.).	1275	Destroy the terminal object (close the window, free resources
		1276	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1277	watchers (timers, io watchers) are still active.
		1278
		1279	=item $term->exec_async ($cmd[, @args])
		1280
		1281	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1282	("starts") programs in the background. This function takes care of setting
		1283	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1284	be preferred over explicit calls to C<exec> or C<system>.
		1285
		1286	Returns the pid of the subprocess or C<undef> on error.
		1287
		1288	=cut
		1289
		1290	sub exec_async {
		1291	my $self = shift;
		1292
		1293	my $pid = fork;
		1294
		1295	return $pid
		1296	if !defined $pid or $pid;
		1297
		1298	%ENV = %{ $self->env };
		1299
		1300	exec @_;
		1301	urxvt::_exit 255;
		1302	}
772		1303
773	=item $isset = $term->option ($optval[, $set])	1304	=item $isset = $term->option ($optval[, $set])
774		1305
775	Returns true if the option specified by C<$optval> is enabled, and	1306	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	1307	optionally change it. All option values are stored by name in the hash
777	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
778		1309
779	Here is a a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
780	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
781		1312
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1316	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1317	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1318	transparent tripleclickwords utmpInhibit visualBell
788		1319
789	=item $value = $term->resource ($name[, $newval])	1320	=item $value = $term->resource ($name[, $newval])
790		1321
791	Returns the current resource value associated with a given name and	1322	Returns the current resource value associated with a given name and
792	optionally sets a new value. Setting values is most useful in the C<init>	1323	optionally sets a new value. Setting values is most useful in the C<init>
…		…
801	likely change).	1332	likely change).
802		1333
803	Please note that resource strings will currently only be freed when the	1334	Please note that resource strings will currently only be freed when the
804	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
805		1336
806	Here is a a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
807	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
808	to see the actual list:	1339	to see the actual list:
809		1340
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1351	secondaryScreen secondaryScroll shade term_name title
821	utmpInhibit visualBell	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1353	visualBell
822		1354
823	=cut	1355	=cut
824		1356
825	sub resource($$;$) {	1357	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
829	}	1361	}
		1362
		1363	=item $value = $term->x_resource ($pattern)
		1364
		1365	Returns the X-Resource for the given pattern, excluding the program or
		1366	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1367	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1368	resource with that pattern exists.
		1369
		1370	This method should only be called during the C<on_start> hook, as there is
		1371	only one resource database per display, and later invocations might return
		1372	the wrong resources.
830		1373
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1374	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1375
833	Adds a keymap translation exactly as specified via a resource. See the	1376	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1377	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
…		…
847		1390
848	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
849		1392
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1394
852	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
853	and optionally set them to new values.
854		1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
		1404
		1405	=item $term->selection_make ($eventtime[, $rectangular])
		1406
		1407	Tries to make a selection as set by C<selection_beg> and
		1408	C<selection_end>. If C<$rectangular> is true (default: false), a
		1409	rectangular selection will be made. This is the preferred function to make
		1410	a selection.
		1411
855	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
856		1413
857	Try to request the primary selection from the server (for example, as set	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
858	by the next method).	1415	true) selection from the server. The corresponding text can be set
		1416	with the next method. No visual feedback will be given. This function
		1417	is mostly useful from within C<on_sel_grab> hooks.
859		1418
860	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
861		1420
862	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
863		1427
864	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
865		1429
866	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
867		1431
…		…
897		1461
898	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
899		1463
900	=over 4	1464	=over 4
901		1465
902	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
903		1467
904	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1468	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
905	text in rxvt-unicode's special encoding and an array of rendition values	1469	text in rxvt-unicode's special encoding and an array of rendition values
906	at a specific position inside the overlay.	1470	at a specific position inside the overlay.
		1471
		1472	If C<$rend> is missing, then the rendition will not be changed.
907		1473
908	=item $overlay->hide	1474	=item $overlay->hide
909		1475
910	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
911		1477
…		…
956	Convert the given locale-encoded octets into a perl string.	1522	Convert the given locale-encoded octets into a perl string.
957		1523
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1524	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1525
960	XORs the rendition values in the given span with the provided value	1526	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1527	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1528	refresh hooks to provide effects similar to the selection.
963		1529
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1530	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1531
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1532	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1533	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1534	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969	it instead.	1535	it instead. Both styles I<MUST NOT> contain font styles.
970		1536
971	=item $term->scr_bell	1537	=item $term->scr_bell
972		1538
973	Ring the bell!	1539	Ring the bell!
974		1540
…		…
981		1547
982	Normally its not a good idea to use this function, as programs might be	1548	Normally its not a good idea to use this function, as programs might be
983	confused by changes in cursor position or scrolling. Its useful inside a	1549	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
985		1551
		1552	=item $term->scr_change_screen ($screen)
		1553
		1554	Switch to given screen - 0 primary, 1 secondary.
		1555
986	=item $term->cmd_parse ($octets)	1556	=item $term->cmd_parse ($octets)
987		1557
988	Similar to C<scr_add_lines>, but the argument must be in the	1558	Similar to C<scr_add_lines>, but the argument must be in the
989	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
991		1561
992	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
993		1563
994	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
995	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
996	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
997		1573
998	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
999		1575
1000	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1001	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
1002	description of C<< urxvt::timer->events >>. Make sure to always restore	1578	description of C<< urxvt::timer->events >>. Make sure to always restore
1003	the previous value.	1579	the previous value.
1004		1580
		1581	=item $fd = $term->pty_fd
		1582
		1583	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1584	is used.
		1585
1005	=item $windowid = $term->parent	1586	=item $windowid = $term->parent
1006		1587
1007	Return the window id of the toplevel window.	1588	Return the window id of the toplevel window.
1008		1589
1009	=item $windowid = $term->vt	1590	=item $windowid = $term->vt
1010		1591
1011	Return the window id of the terminal window.	1592	Return the window id of the terminal window.
1012		1593
		1594	=item $term->vt_emask_add ($x_event_mask)
		1595
		1596	Adds the specified events to the vt event mask. Useful e.g. when you want
		1597	to receive pointer events all the times:
		1598
		1599	$term->vt_emask_add (urxvt::PointerMotionMask);
		1600
		1601	=item $term->focus_in
		1602
		1603	=item $term->focus_out
		1604
		1605	=item $term->key_press ($state, $keycode[, $time])
		1606
		1607	=item $term->key_release ($state, $keycode[, $time])
		1608
		1609	Deliver various fake events to to terminal.
		1610
1013	=item $window_width = $term->width	1611	=item $window_width = $term->width
1014		1612
1015	=item $window_height = $term->height	1613	=item $window_height = $term->height
1016		1614
1017	=item $font_width = $term->fwidth	1615	=item $font_width = $term->fwidth
…		…
1030		1628
1031	=item $max_scrollback = $term->saveLines	1629	=item $max_scrollback = $term->saveLines
1032		1630
1033	=item $nrow_plus_saveLines = $term->total_rows	1631	=item $nrow_plus_saveLines = $term->total_rows
1034		1632
1035	=item $lines_in_scrollback = $term->nsaved	1633	=item $topmost_scrollback_row = $term->top_row
1036		1634
1037	Return various integers describing terminal characteristics.	1635	Return various integers describing terminal characteristics.
1038		1636
		1637	=item $x_display = $term->display_id
		1638
		1639	Return the DISPLAY used by rxvt-unicode.
		1640
1039	=item $lc_ctype = $term->locale	1641	=item $lc_ctype = $term->locale
1040		1642
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1643	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1644
1043	=item $x_display = $term->display_id	1645	=item $env = $term->env
1044		1646
1045	Return the DISPLAY used by rxvt-unicode.	1647	Returns a copy of the environment in effect for the terminal as a hashref
		1648	similar to C<\%ENV>.
		1649
		1650	=item @envv = $term->envv
		1651
		1652	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1653
		1654	=item @argv = $term->argv
		1655
		1656	Return the argument vector as this terminal, similar to @ARGV, but
		1657	includes the program name as first element.
		1658
		1659	=cut
		1660
		1661	sub env {
		1662	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1663	}
1046		1664
1047	=item $modifiermask = $term->ModLevel3Mask	1665	=item $modifiermask = $term->ModLevel3Mask
1048		1666
1049	=item $modifiermask = $term->ModMetaMask	1667	=item $modifiermask = $term->ModMetaMask
1050		1668
1051	=item $modifiermask = $term->ModNumLockMask	1669	=item $modifiermask = $term->ModNumLockMask
1052		1670
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1671	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1672	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1673
		1674	=item $screen = $term->current_screen
		1675
		1676	Returns the currently displayed screen (0 primary, 1 secondary).
		1677
		1678	=item $cursor_is_hidden = $term->hidden_cursor
		1679
		1680	Returns whether the cursor is currently hidden or not.
		1681
1056	=item $view_start = $term->view_start ([$newvalue])	1682	=item $view_start = $term->view_start ([$newvalue])
1057		1683
1058	Returns the negative row number of the topmost line. Minimum value is	1684	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1685	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1686	this many lines into the scrollback buffer.
1061		1687
1062	=item $term->want_refresh	1688	=item $term->want_refresh
1063		1689
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1690	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1067		1693
1068	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1069		1695
1070	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1071		1697
1072	Returns the text of the entire row with number C<$row_number>. Row C<0>	1698	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1073	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1699	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1074	terminal line. The scrollback buffer starts at line C<-1> and extends to
1075	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1076	is requested.	1701	is requested.
1077		1702
1078	If C<$new_text> is specified, it will replace characters in the current	1703	If C<$new_text> is specified, it will replace characters in the current
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1704	line, starting at column C<$start_col> (default C<0>), which is useful
1080	to replace only parts of a line. The font index in the rendition will	1705	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1706	automatically be updated.
1082		1707
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1708	C<$text> is in a special encoding: tabs and wide characters that use more
1084	than one cell when displayed are padded with urxvt::NOCHAR characters	1709	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1085	(C<chr 65535>). Characters with combining characters and other characters	1710	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1711	do not fit into the normal text encoding will be replaced with characters
1087	characters in the private use area.	1712	in the private use area.
1088		1713
1089	You have to obey this encoding when changing text. The advantage is	1714	You have to obey this encoding when changing text. The advantage is
1090	that C<substr> and similar functions work on screen cells and not on	1715	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1716	characters.
1092		1717
…		…
1143	Return the row number of the first/last row of the line, respectively.	1768	Return the row number of the first/last row of the line, respectively.
1144		1769
1145	=item $offset = $line->offset_of ($row, $col)	1770	=item $offset = $line->offset_of ($row, $col)
1146		1771
1147	Returns the character offset of the given row|col pair within the logical	1772	Returns the character offset of the given row|col pair within the logical
1148	line.	1773	line. Works for rows outside the line, too, and returns corresponding
		1774	offsets outside the string.
1149		1775
1150	=item ($row, $col) = $line->coord_of ($offset)	1776	=item ($row, $col) = $line->coord_of ($offset)
1151		1777
1152	Translates a string offset into terminal coordinates again.	1778	Translates a string offset into terminal coordinates again.
1153		1779
…		…
1235	where one character corresponds to one screen cell. See	1861	where one character corresponds to one screen cell. See
1236	C<< $term->ROW_t >> for details.	1862	C<< $term->ROW_t >> for details.
1237		1863
1238	=item $string = $term->special_decode $text	1864	=item $string = $term->special_decode $text
1239		1865
1240	Converts rxvt-unicodes text reprsentation into a perl string. See	1866	Converts rxvt-unicodes text representation into a perl string. See
1241	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1242		1868
1243	=item $success = $term->grab_button ($button, $modifiermask)	1869	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1244		1870
		1871	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1872
1245	Registers a synchronous button grab. See the XGrabButton manpage.	1873	Register/unregister a synchronous button grab. See the XGrabButton
		1874	manpage.
1246		1875
1247	=item $success = $term->grab ($eventtime[, $sync])	1876	=item $success = $term->grab ($eventtime[, $sync])
1248		1877
1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1878	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1879	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1251		1880
1252	=item $term->allow_events_async	1881	=item $term->allow_events_async
1253		1882
1254	Calls XAllowEvents with AsyncBoth for the most recent grab.	1883	Calls XAllowEvents with AsyncBoth for the most recent grab.
1255		1884
…		…
1262	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1263	recent grab.	1892	recent grab.
1264		1893
1265	=item $term->ungrab	1894	=item $term->ungrab
1266		1895
1267	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1268	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1898	the session.
		1899
		1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1901
		1902	=item $atom_name = $term->XGetAtomName ($atom)
		1903
		1904	=item @atoms = $term->XListProperties ($window)
		1905
		1906	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1907
		1908	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1909
		1910	=item $term->XDeleteProperty ($window, $property)
		1911
		1912	=item $window = $term->DefaultRootWindow
		1913
		1914	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1915
		1916	=item $term->XMapWindow ($window)
		1917
		1918	=item $term->XUnmapWindow ($window)
		1919
		1920	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1921
		1922	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1923
		1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1925
		1926	Various X or X-related functions. The C<$term> object only serves as
		1927	the source of the display, otherwise those functions map more-or-less
		1928	directly onto the X functions of the same name.
1270		1929
1271	=back	1930	=back
1272		1931
1273	=cut	1932	=cut
1274		1933
…		…
1289		1948
1290	$item->{render} ||= sub { $_[0]{text} };	1949	$item->{render} ||= sub { $_[0]{text} };
1291		1950
1292	push @{ $self->{item} }, $item;	1951	push @{ $self->{item} }, $item;
1293	}	1952	}
		1953
		1954	=item $popup->add_title ($title)
		1955
		1956	Adds a non-clickable title to the popup.
		1957
		1958	=cut
		1959
		1960	sub add_title {
		1961	my ($self, $title) = @_;
		1962
		1963	$self->add_item ({
		1964	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1965	text => $title,
		1966	activate => sub { },
		1967	});
		1968	}
		1969
		1970	=item $popup->add_separator ([$sepchr])
		1971
		1972	Creates a separator, optionally using the character given as C<$sepchr>.
		1973
		1974	=cut
1294		1975
1295	sub add_separator {	1976	sub add_separator {
1296	my ($self, $sep) = @_;	1977	my ($self, $sep) = @_;
1297		1978
1298	$sep ||= "=";	1979	$sep ||= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1984	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1985	activate => sub { },
1305	});	1986	});
1306	}	1987	}
1307		1988
1308	sub add_title {	1989	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1990
1311	$self->add_item ({	1991	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1992	selected.
1313	text => $title,	1993
1314	activate => sub { },	1994	=cut
1315	});
1316	}
1317		1995
1318	sub add_button {	1996	sub add_button {
1319	my ($self, $text, $cb) = @_;	1997	my ($self, $text, $cb) = @_;
1320		1998
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1999	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	2000	}
1323		2001
		2002	=item $popup->add_toggle ($text, $initial_value, $cb)
		2003
		2004	Adds a toggle/checkbox item to the popup. The callback gets called
		2005	whenever it gets toggled, with a boolean indicating its new value as its
		2006	first argument.
		2007
		2008	=cut
		2009
1324	sub add_toggle {	2010	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	2011	my ($self, $text, $value, $cb) = @_;
1326		2012
1327	my $item; $item = {	2013	my $item; $item = {
1328	type => "button",	2014	type => "button",
1329	text => " $text",	2015	text => " $text",
1330	value => $value,	2016	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	2017	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	2018	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	2019	};
1334		2020
1335	$self->add_item ($item);	2021	$self->add_item ($item);
1336	}	2022	}
		2023
		2024	=item $popup->show
		2025
		2026	Displays the popup (which is initially hidden).
		2027
		2028	=cut
1337		2029
1338	sub show {	2030	sub show {
1339	my ($self) = @_;	2031	my ($self) = @_;
1340		2032
1341	local $urxvt::popup::self = $self;	2033	local $urxvt::popup::self = $self;
1342		2034
		2035	my $env = $self->{term}->env;
		2036	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2037	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1344		2039
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2040	my $term = urxvt::term->new (
		2041	$env, "popup",
		2042	"--perl-lib" => "", "--perl-ext-common" => "",
		2043	"-pty-fd" => -1, "-sl" => 0,
		2044	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1349	or die "unable to create popup window\n";	2048	) or die "unable to create popup window\n";
		2049
		2050	unless (delete $term->{urxvt_popup_init_done}) {
		2051	$term->ungrab;
		2052	$term->destroy;
		2053	die "unable to initialise popup window\n";
		2054	}
1350	}	2055	}
1351		2056
1352	sub DESTROY {	2057	sub DESTROY {
1353	my ($self) = @_;	2058	my ($self) = @_;
1354		2059
1355	delete $self->{term}{_destroy}{$self};	2060	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	2061	$self->{term}->ungrab;
1357	}	2062	}
		2063
		2064	=back
		2065
		2066	=cut
		2067
		2068	package urxvt::watcher;
1358		2069
1359	=head2 The C<urxvt::timer> Class	2070	=head2 The C<urxvt::timer> Class
1360		2071
1361	This class implements timer watchers/events. Time is represented as a	2072	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	2073	fractional number of seconds since the epoch. Example:
…		…
1366	->new	2077	->new
1367	->interval (1)	2078	->interval (1)
1368	->cb (sub {	2079	->cb (sub {
1369	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1370	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1371	});	2082	});
1372		2083
1373	=over 4	2084	=over 4
1374		2085
1375	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
1376		2087
…		…
1379		2090
1380	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1381		2092
1382	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
1383		2094
1384	=item $tstamp = $timer->at
1385
1386	Return the time this watcher will fire next.
1387
1388	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
1389		2096
1390	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
1391		2099
1392	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
1393		2101
1394	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
1395	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
1396	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
1397		2105
1398	=item $timer = $timer->start	2106	=item $timer = $timer->start
1399		2107
1400	Start the timer.	2108	Start the timer.
1401		2109
1402	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
1403		2111
1404	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
		2114
		2115	=item $timer = $timer->after ($delay[, $interval])
		2116
		2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		2118
1406	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
1407		2120
1408	Stop the timer.	2121	Stop the timer.
1409		2122
…		…
1415		2128
1416	$term->{socket} = ...	2129	$term->{socket} = ...
1417	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
1418	->new	2131	->new
1419	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
1420	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
1421	->start	2134	->start
1422	->cb (sub {	2135	->cb (sub {
1423	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
1424	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
1425	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
1438	Set the callback to be called when io events are triggered. C<$reventmask>	2151	Set the callback to be called when io events are triggered. C<$reventmask>
1439	is a bitset as described in the C<events> method.	2152	is a bitset as described in the C<events> method.
1440		2153
1441	=item $iow = $iow->fd ($fd)	2154	=item $iow = $iow->fd ($fd)
1442		2155
1443	Set the filedescriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
1444		2157
1445	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
1446		2159
1447	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2161	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1449	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
1450		2163
1451	=item $iow = $iow->start	2164	=item $iow = $iow->start
1452		2165
1453	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
1454		2167
1455	=item $iow = $iow->stop	2168	=item $iow = $iow->stop
1456		2169
1457	Stop watching for events on the given filehandle.	2170	Stop watching for events on the given file handle.
		2171
		2172	=back
		2173
		2174	=head2 The C<urxvt::iw> Class
		2175
		2176	This class implements idle watchers, that get called automatically when
		2177	the process is idle. They should return as fast as possible, after doing
		2178	some useful work.
		2179
		2180	=over 4
		2181
		2182	=item $iw = new urxvt::iw
		2183
		2184	Create a new idle watcher object in stopped state.
		2185
		2186	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2187
		2188	Set the callback to be called when the watcher triggers.
		2189
		2190	=item $timer = $timer->start
		2191
		2192	Start the watcher.
		2193
		2194	=item $timer = $timer->stop
		2195
		2196	Stop the watcher.
		2197
		2198	=back
		2199
		2200	=head2 The C<urxvt::pw> Class
		2201
		2202	This class implements process watchers. They create an event whenever a
		2203	process exits, after which they stop automatically.
		2204
		2205	my $pid = fork;
		2206	...
		2207	$term->{pw} = urxvt::pw
		2208	->new
		2209	->start ($pid)
		2210	->cb (sub {
		2211	my ($pw, $exit_status) = @_;
		2212	...
		2213	});
		2214
		2215	=over 4
		2216
		2217	=item $pw = new urxvt::pw
		2218
		2219	Create a new process watcher in stopped state.
		2220
		2221	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2222
		2223	Set the callback to be called when the timer triggers.
		2224
		2225	=item $pw = $timer->start ($pid)
		2226
		2227	Tells the watcher to start watching for process C<$pid>.
		2228
		2229	=item $pw = $pw->stop
		2230
		2231	Stop the watcher.
1458		2232
1459	=back	2233	=back
1460		2234
1461	=head1 ENVIRONMENT	2235	=head1 ENVIRONMENT
1462		2236
…		…
1469		2243
1470	=item == 0 - fatal messages	2244	=item == 0 - fatal messages
1471		2245
1472	=item >= 3 - script loading and management	2246	=item >= 3 - script loading and management
1473		2247
1474	=item >=10 - all events received	2248	=item >=10 - all called hooks
		2249
		2250	=item >=11 - hook return values
1475		2251
1476	=back	2252	=back
1477		2253
1478	=head1 AUTHOR	2254	=head1 AUTHOR
1479		2255
1480	Marc Lehmann <pcg@goof.com>	2256	Marc Lehmann <schmorp@schmorp.de>
1481	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
1482		2258
1483	=cut	2259	=cut
1484		2260
1485	1	2261	1
		2262
		2263	# vim: sw=3:

Diff Legend

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