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.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.191 by sf-exg, Fri Jan 7 21:55: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.
70		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	};
		143
71	=item searchable-scrollback (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
72		145
73	Adds regex search functionality to the scrollback buffer, triggered by a	146	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	148	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	149	screen.
77	current position and C<escape> returns to the original position.
78		150
79	=item digital-clock	151	Inputting characters appends them to the regex and continues incremental
		152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		158
81	Displays a digital clock using the built-in overlay.	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.
82		162
83	=item mark-urls	163	See L<perlre> for more info about perl regular expression syntax.
84		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		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
85	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.
86		313
87	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
88		315
89	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
90	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
91	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.
92		391
93	=item example-refresh-hooks	392	=item example-refresh-hooks
94		393
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	396	overlays or changes.
98		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
		402
99	=back	403	=back
		404
		405	=head1 API DOCUMENTATION
100		406
101	=head2 General API Considerations	407	=head2 General API Considerations
102		408
103	All objects (such as terminals, time watchers etc.) are typical	409	All objects (such as terminals, time watchers etc.) are typical
104	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
…		…
116		422
117	=over 4	423	=over 4
118		424
119	=item $text	425	=item $text
120		426
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
122	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.
123		429
124	=item $string	430	=item $string
125		431
126	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
127	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
…		…
134		440
135	=back	441	=back
136		442
137	=head2 Extension Objects	443	=head2 Extension Objects
138		444
139	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
140	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extenion objects,
141	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
142	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
143	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
144	use.	451	internal use.
145		452
146	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
147	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
148		455
149	It has the following methods and data members:	456	It has the following methods and data members:
…		…
170	=head2 Hooks	477	=head2 Hooks
171		478
172	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
173	called whenever the relevant event happens.	480	called whenever the relevant event happens.
174		481
175	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
176	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
177		484
178	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
179	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
180	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.
181		488
182	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
183		490
184	=over 4	491	=over 4
185		492
186	=item on_init $term	493	=item on_init $term
187		494
188	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
189	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
190	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
191	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
192	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).
193		511
194	=item on_reset $term	512	=item on_reset $term
195		513
196	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
197	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
198	variables.	516	variables.
199		517
200	=item on_start $term	518	=item on_child_start $term, $pid
201		519
202	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.
203	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>.
204		526
205	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
206		528
207	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
208	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
…		…
215		537
216	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
217	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
218	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
219		541
220	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.
221		543
222	=item on_sel_extend $term	544	=item on_sel_extend $term
223		545
224	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
225	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
226	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
227	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.
228		552
229	See the F<selection> example extension.	553	See the F<selection> example extension.
230		554
231	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
232		556
233	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
234	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
235	show this many lines of scrollback.	559	show this many lines of scrollback.
236		560
237	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
238		562
…		…
242		566
243	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,
244	$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
245	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
246		570
247	=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
248		582
249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
250	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
251	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
252	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,
253	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
254	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	}
255		599
256	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,
257	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
258	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.
259		606
260	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
261		608
262	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
263	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
…		…
268	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
269		616
270	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
271	suppress or filter tty input.	618	suppress or filter tty input.
272		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
273	=item on_line_update $term, $row	627	=item on_line_update $term, $row
274		628
275	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
276	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
277	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,
…		…
284	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
285	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
286		640
287	=item on_refresh_begin $term	641	=item on_refresh_begin $term
288		642
289	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
290	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
291	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
292	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
293		647
294	=item on_refresh_end $term	648	=item on_refresh_end $term
295		649
296	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>.
297		651
298	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
299		653
300	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
301	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>
302	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.
303		676
304	=item on_focus_in $term	677	=item on_focus_in $term
305		678
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	680	does focus in processing.
308		681
309	=item on_focus_out $term	682	=item on_focus_out $term
310		683
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	685	focus out processing.
313		686
		687	=item on_configure_notify $term, $event
		688
		689	=item on_property_notify $term, $event
		690
314	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
315		692
316	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
317		694
318	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
323		700
324	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
325		702
326	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
327		704
328	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
329	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.
330		707
331	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
332	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
333	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
334		711
335	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
337		714
338	subwindow.	715	subwindow.
339		716
340	=back	717	=item on_client_message $term, $event
341		718
342	=head2 Variables in the C<urxvt> Package	719	=item on_wm_protocols $term, $event
343		720
344	=over 4	721	=item on_wm_delete_window $term, $event
345		722
346	=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).
347		725
348	The current terminal. This variable stores the current C<urxvt::term>	726	=item on_bell $term
349	object, whenever a callback/hook is executing.
350		727
351	=back	728	Called on receipt of a bell character.
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		729
450	=back	730	=back
451		731
452	=cut	732	=cut
453		733
…		…
459	use Scalar::Util ();	739	use Scalar::Util ();
460	use List::Util ();	740	use List::Util ();
461		741
462	our $VERSION = 1;	742	our $VERSION = 1;
463	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
464	our @HOOKNAME;	746	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	748	our %OPTION;
467		749
468	our $LIBDIR;	750	our $LIBDIR;
469	our $RESNAME;	751	our $RESNAME;
470	our $RESCLASS;	752	our $RESCLASS;
471	our $RXVTNAME;	753	our $RXVTNAME;
472		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 objet 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
473	BEGIN {	913	BEGIN {
474	urxvt->bootstrap;
475
476	# overwrite perl's warn	914	# overwrite perl's warn
477	*CORE::GLOBAL::warn = sub {	915	*CORE::GLOBAL::warn = sub {
478	my $msg = join "", @_;	916	my $msg = join "", @_;
479	$msg .= "\n"	917	$msg .= "\n"
480	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	919	urxvt::warn ($msg);
482	};	920	};
483
484	delete $ENV{IFS};
485	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	921	}
489		922
490	my @hook_count;	923	no warnings 'utf8';
		924
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		926
493	sub verbose {	927	sub verbose {
494	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	929	warn "$msg\n" if $level <= $verbosity;
496	}	930	}
497		931
498	my $extension_pkg = "extension0000";
499	my %extension_pkg;	932	my %extension_pkg;
500		933
501	# load a single script into its own package, once only	934	# load a single script into its own package, once only
502	sub extension_package($) {	935	sub extension_package($) {
503	my ($path) = @_;	936	my ($path) = @_;
504		937
505	$extension_pkg{$path} ||= do {	938	$extension_pkg{$path} ||= do {
506	my $pkg = "urxvt::" . ($extension_pkg++);	939	$path =~ /([^\/\\]+)$/;
		940	my $pkg = $1;
		941	$pkg =~ s/[^[:word:]]/_/g;
		942	$pkg = "urxvt::ext::$pkg";
507		943
508	verbose 3, "loading extension '$path' into package '$pkg'";	944	verbose 3, "loading extension '$path' into package '$pkg'";
509		945
510	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
511	or die "$path: $!";	947	or die "$path: $!";
512		948
513	my $source = untaint	949	my $source =
514	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
515	. "use base urxvt::term::extension::;\n"
516	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
517	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
518	. "\n};\n1";	953	. "\n};\n1";
519		954
520	eval $source	955	eval $source
…		…
531	local $TERM = shift;	966	local $TERM = shift;
532	my $htype = shift;	967	my $htype = shift;
533		968
534	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
536		971
537	my %ext_arg;	972	my %ext_arg;
538		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
539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
540	if ($_ eq "default") {	984	if ($_ eq "default") {
541	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
542	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
543	delete $ext_arg{$1};	987	delete $ext_arg{$1};
544	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
545	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
546	} else {	990	} else {
547	$ext_arg{$_} ||= [];	991	$ext_arg{$_} ||= [];
548	}	992	}
549	}	993	}
550		994
551	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
552	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
553		997
554	if (@files) {	998	if (@files) {
555	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
556	} else {	1000	} else {
557	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";
558	}	1002	}
559	}	1003	}
560		1004
…		…
566		1010
567	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
568	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
569	if $verbosity >= 10;	1013	if $verbosity >= 10;
570		1014
571	keys %$cb;	1015	for my $pkg (keys %$cb) {
572
573	while (my ($pkg, $cb) = each %$cb) {
574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
575	and last;	1017	$retval ||= $retval_;
576		1018
577	if ($@) {	1019	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	1021	warn $@;
580	}	1022	}
581	}	1023	}
		1024
		1025	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1026	if $verbosity >= 11;
582	}	1027	}
583		1028
584	if ($htype == 1) { # DESTROY	1029	if ($htype == 1) { # DESTROY
585	if (my $hook = delete $TERM->{_hook}) {
586	for my $htype (0..$#$hook) {
587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
588	or set_should_invoke $htype, 0;
589	}
590	}
591
592	# clear package objects	1030	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	1031	%$_ = () for values %{ $TERM->{_pkg} };
594		1032
595	# clear package	1033	# clear package
596	%$TERM = ();	1034	%$TERM = ();
597	}	1035	}
598		1036
599	$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)
600	}	1067	}
601		1068
602	# urxvt::term::extension	1069	# urxvt::term::extension
603		1070
604	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
610	while (my ($name, $cb) = each %hook) {	1077	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	1078	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	1079	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	1080	or Carp::croak "unsupported hook type '$name'";
614		1081
		1082	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1083	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		1084
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1085	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	1086	}
622	}	1087	}
623		1088
…		…
628	for my $name (@hook) {	1093	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	1094	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	1095	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	1096	or Carp::croak "unsupported hook type '$name'";
632		1097
		1098	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1099	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	1100	}
638	}	1101	}
639		1102
640	our $AUTOLOAD;	1103	our $AUTOLOAD;
641		1104
…		…
672		1135
673	=head2 The C<urxvt::anyevent> Class	1136	=head2 The C<urxvt::anyevent> Class
674		1137
675	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
676	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
677	further work. The only exception is that you cannot wait on condition	1140	further programming. The only exception is that you cannot wait on
678	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
679	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.
680		1144
681	=cut	1145	=cut
682		1146
683	our $VERSION = 1;	1147	our $VERSION = '5.23';
684		1148
685	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
686	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
687		1151
688	sub timer {	1152	sub timer {
…		…
690		1154
691	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
692		1156
693	urxvt::timer	1157	urxvt::timer
694	->new	1158	->new
695	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
696	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
697	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
698	$cb->();	1162	$cb->();
699	})	1163	})
700	}	1164	}
701		1165
702	sub io {	1166	sub io {
703	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
704		1168
705	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
706		1172
707	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
708	->new	1174	->new
709	->fd (fileno $arg{fh})	1175	->fd ($fd)
710	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
711	| ($arg{poll} =~ /w/ ? 2 : 0))	1177	| ($arg{poll} =~ /w/ ? 2 : 0))
712	->start	1178	->start
713	->cb (sub {	1179	->cb ($cb)
714	$cb->(($_[1] & 1 ? 'r' : '')
715	. ($_[1] & 2 ? 'w' : ''));
716	})],
717	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	})
718	}	1206	}
719		1207
720	sub DESTROY {	1208	sub DESTROY {
721	$_[0][1]->stop;	1209	$_[0][1]->stop;
722	}	1210	}
723		1211
724	sub condvar {	1212	sub one_event {
725	bless \my $flag, urxvt::anyevent::condvar::
726	}
727
728	sub urxvt::anyevent::condvar::broadcast {
729	${$_[0]}++;
730	}
731
732	sub urxvt::anyevent::condvar::wait {
733	unless (${$_[0]}) {
734	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";
735	}
736	}	1214	}
737		1215
738	package urxvt::term;	1216	package urxvt::term;
739		1217
740	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
745		1223
746	# find on_xxx subs in the package and register them	1224	# find on_xxx subs in the package and register them
747	# as hooks	1225	# as hooks
748	sub register_package {	1226	sub register_package {
749	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::;
750		1234
751	my $proxy = bless {	1235	my $proxy = bless {
752	_pkg => $pkg,	1236	_pkg => $pkg,
753	argv => $argv,	1237	argv => $argv,
754	}, $pkg;	1238	}, $pkg;
…		…
761	$proxy->enable ($name => $ref);	1245	$proxy->enable ($name => $ref);
762	}	1246	}
763	}	1247	}
764	}	1248	}
765		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
766	=item $term->destroy	1273	=item $term->destroy
767		1274
768	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	}
769		1303
770	=item $isset = $term->option ($optval[, $set])	1304	=item $isset = $term->option ($optval[, $set])
771		1305
772	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
773	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
774	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.
775		1309
776	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
777	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
778		1312
779	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
780	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
781	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
782	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1316	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
783	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1317	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
784	tripleclickwords utmpInhibit visualBell	1318	transparent tripleclickwords utmpInhibit visualBell
785		1319
786	=item $value = $term->resource ($name[, $newval])	1320	=item $value = $term->resource ($name[, $newval])
787		1321
788	Returns the current resource value associated with a given name and	1322	Returns the current resource value associated with a given name and
789	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>
…		…
798	likely change).	1332	likely change).
799		1333
800	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
801	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
802		1336
803	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
804	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>
805	to see the actual list:	1339	to see the actual list:
806		1340
807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
808	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
809	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
810	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
811	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
812	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
813	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
814	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
815	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
816	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
817	shade term_name title transparent transparent_all tripleclickwords	1351	secondaryScreen secondaryScroll shade term_name title
818	utmpInhibit visualBell	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1353	visualBell
819		1354
820	=cut	1355	=cut
821		1356
822	sub resource($$;$) {	1357	sub resource($$;$) {
823	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
826	}	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.
827		1373
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1374	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		1375
830	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
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1377	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
…		…
844		1390
845	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
846		1392
847	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
848		1394
849	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.
850	and optionally set them to new values.
851		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
852	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
853		1413
854	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
855	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.
856		1418
857	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
858		1420
859	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.
860		1427
861	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
862		1429
863	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.
864		1431
…		…
894		1461
895	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
896		1463
897	=over 4	1464	=over 4
898		1465
899	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
900		1467
901	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
902	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
903	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.
904		1473
905	=item $overlay->hide	1474	=item $overlay->hide
906		1475
907	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
908		1477
…		…
953	Convert the given locale-encoded octets into a perl string.	1522	Convert the given locale-encoded octets into a perl string.
954		1523
955	=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])
956		1525
957	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
958	(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
959	to the selection.	1528	refresh hooks to provide effects similar to the selection.
960		1529
961	=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]])
962		1531
963	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
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1533	whitespace will additionally be xored with the C<$rstyle2>, which defaults
965	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
966	it instead.	1535	it instead. Both styles I<MUST NOT> contain font styles.
967		1536
968	=item $term->scr_bell	1537	=item $term->scr_bell
969		1538
970	Ring the bell!	1539	Ring the bell!
971		1540
…		…
978		1547
979	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
980	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
981	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
982		1551
		1552	=item $term->scr_change_screen ($screen)
		1553
		1554	Switch to given screen - 0 primary, 1 secondary.
		1555
983	=item $term->cmd_parse ($octets)	1556	=item $term->cmd_parse ($octets)
984		1557
985	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
986	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
987	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
988		1561
989	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
990		1563
991	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
992	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
993	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.
994		1573
995	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
996		1575
997	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
998	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
999	description of C<< urxvt::timer->events >>. Make sure to always restore	1578	description of C<< urxvt::timer->events >>. Make sure to always restore
1000	the previous value.	1579	the previous value.
1001		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
1002	=item $windowid = $term->parent	1586	=item $windowid = $term->parent
1003		1587
1004	Return the window id of the toplevel window.	1588	Return the window id of the toplevel window.
1005		1589
1006	=item $windowid = $term->vt	1590	=item $windowid = $term->vt
1007		1591
1008	Return the window id of the terminal window.	1592	Return the window id of the terminal window.
1009		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
1010	=item $window_width = $term->width	1611	=item $window_width = $term->width
1011		1612
1012	=item $window_height = $term->height	1613	=item $window_height = $term->height
1013		1614
1014	=item $font_width = $term->fwidth	1615	=item $font_width = $term->fwidth
…		…
1027		1628
1028	=item $max_scrollback = $term->saveLines	1629	=item $max_scrollback = $term->saveLines
1029		1630
1030	=item $nrow_plus_saveLines = $term->total_rows	1631	=item $nrow_plus_saveLines = $term->total_rows
1031		1632
1032	=item $lines_in_scrollback = $term->nsaved	1633	=item $topmost_scrollback_row = $term->top_row
1033		1634
1034	Return various integers describing terminal characteristics.	1635	Return various integers describing terminal characteristics.
1035		1636
		1637	=item $x_display = $term->display_id
		1638
		1639	Return the DISPLAY used by rxvt-unicode.
		1640
1036	=item $lc_ctype = $term->locale	1641	=item $lc_ctype = $term->locale
1037		1642
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1643	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1644
1040	=item $x_display = $term->display_id	1645	=item $env = $term->env
1041		1646
1042	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	}
1043		1664
1044	=item $modifiermask = $term->ModLevel3Mask	1665	=item $modifiermask = $term->ModLevel3Mask
1045		1666
1046	=item $modifiermask = $term->ModMetaMask	1667	=item $modifiermask = $term->ModMetaMask
1047		1668
1048	=item $modifiermask = $term->ModNumLockMask	1669	=item $modifiermask = $term->ModNumLockMask
1049		1670
1050	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
1051	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.
1052		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
1053	=item $view_start = $term->view_start ([$newvalue])	1682	=item $view_start = $term->view_start ([$newvalue])
1054		1683
1055	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
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1685	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1686	this many lines into the scrollback buffer.
1058		1687
1059	=item $term->want_refresh	1688	=item $term->want_refresh
1060		1689
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1690	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1064		1693
1065	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1066		1695
1067	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1068		1697
1069	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 >>
1070	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
1071	terminal line. The scrollback buffer starts at line C<-1> and extends to
1072	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1073	is requested.	1701	is requested.
1074		1702
1075	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
1076	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
1077	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
1078	automatically be updated.	1706	automatically be updated.
1079		1707
1080	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
1081	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)
1082	(C<chr 65535>). Characters with combining characters and other characters	1710	characters. Characters with combining characters and other characters that
1083	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
1084	characters in the private use area.	1712	in the private use area.
1085		1713
1086	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
1087	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
1088	characters.	1716	characters.
1089		1717
…		…
1140	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.
1141		1769
1142	=item $offset = $line->offset_of ($row, $col)	1770	=item $offset = $line->offset_of ($row, $col)
1143		1771
1144	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
1145	line.	1773	line. Works for rows outside the line, too, and returns corresponding
		1774	offsets outside the string.
1146		1775
1147	=item ($row, $col) = $line->coord_of ($offset)	1776	=item ($row, $col) = $line->coord_of ($offset)
1148		1777
1149	Translates a string offset into terminal coordinates again.	1778	Translates a string offset into terminal coordinates again.
1150		1779
…		…
1232	where one character corresponds to one screen cell. See	1861	where one character corresponds to one screen cell. See
1233	C<< $term->ROW_t >> for details.	1862	C<< $term->ROW_t >> for details.
1234		1863
1235	=item $string = $term->special_decode $text	1864	=item $string = $term->special_decode $text
1236		1865
1237	Converts rxvt-unicodes text reprsentation into a perl string. See	1866	Converts rxvt-unicodes text representation into a perl string. See
1238	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1239		1868
1240	=item $success = $term->grab_button ($button, $modifiermask)	1869	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1241		1870
		1871	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1872
1242	Registers a synchronous button grab. See the XGrabButton manpage.	1873	Register/unregister a synchronous button grab. See the XGrabButton
		1874	manpage.
1243		1875
1244	=item $success = $term->grab ($eventtime[, $sync])	1876	=item $success = $term->grab ($eventtime[, $sync])
1245		1877
1246	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1878	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1247	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1879	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1248		1880
1249	=item $term->allow_events_async	1881	=item $term->allow_events_async
1250		1882
1251	Calls XAllowEvents with AsyncBoth for the most recent grab.	1883	Calls XAllowEvents with AsyncBoth for the most recent grab.
1252		1884
…		…
1259	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1260	recent grab.	1892	recent grab.
1261		1893
1262	=item $term->ungrab	1894	=item $term->ungrab
1263		1895
1264	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
1265	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
1266	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.
1267		1929
1268	=back	1930	=back
1269		1931
1270	=cut	1932	=cut
1271		1933
…		…
1286		1948
1287	$item->{render} ||= sub { $_[0]{text} };	1949	$item->{render} ||= sub { $_[0]{text} };
1288		1950
1289	push @{ $self->{item} }, $item;	1951	push @{ $self->{item} }, $item;
1290	}	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
1291		1975
1292	sub add_separator {	1976	sub add_separator {
1293	my ($self, $sep) = @_;	1977	my ($self, $sep) = @_;
1294		1978
1295	$sep ||= "=";	1979	$sep ||= "=";
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1984	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1985	activate => sub { },
1302	});	1986	});
1303	}	1987	}
1304		1988
1305	sub add_title {	1989	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1990
1308	$self->add_item ({	1991	Adds a clickable button to the popup. C<$cb> is called whenever it is
1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1992	selected.
1310	text => $title,	1993
1311	activate => sub { },	1994	=cut
1312	});
1313	}
1314		1995
1315	sub add_button {	1996	sub add_button {
1316	my ($self, $text, $cb) = @_;	1997	my ($self, $text, $cb) = @_;
1317		1998
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1999	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	2000	}
1320		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
1321	sub add_toggle {	2010	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	2011	my ($self, $text, $value, $cb) = @_;
1323		2012
1324	my $item; $item = {	2013	my $item; $item = {
1325	type => "button",	2014	type => "button",
1326	text => " $text",	2015	text => " $text",
1327	value => $value,	2016	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	2017	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	2018	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	2019	};
1331		2020
1332	$self->add_item ($item);	2021	$self->add_item ($item);
1333	}	2022	}
		2023
		2024	=item $popup->show
		2025
		2026	Displays the popup (which is initially hidden).
		2027
		2028	=cut
1334		2029
1335	sub show {	2030	sub show {
1336	my ($self) = @_;	2031	my ($self) = @_;
1337		2032
1338	local $urxvt::popup::self = $self;	2033	local $urxvt::popup::self = $self;
1339		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};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1341		2039
1342	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",
1343	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1346	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	}
1347	}	2055	}
1348		2056
1349	sub DESTROY {	2057	sub DESTROY {
1350	my ($self) = @_;	2058	my ($self) = @_;
1351		2059
1352	delete $self->{term}{_destroy}{$self};	2060	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	2061	$self->{term}->ungrab;
1354	}	2062	}
		2063
		2064	=back
		2065
		2066	=cut
		2067
		2068	package urxvt::watcher;
1355		2069
1356	=head2 The C<urxvt::timer> Class	2070	=head2 The C<urxvt::timer> Class
1357		2071
1358	This class implements timer watchers/events. Time is represented as a	2072	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	2073	fractional number of seconds since the epoch. Example:
…		…
1363	->new	2077	->new
1364	->interval (1)	2078	->interval (1)
1365	->cb (sub {	2079	->cb (sub {
1366	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1367	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1368	});	2082	});
1369		2083
1370	=over 4	2084	=over 4
1371		2085
1372	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
1373		2087
…		…
1376		2090
1377	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1378		2092
1379	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
1380		2094
1381	=item $tstamp = $timer->at
1382
1383	Return the time this watcher will fire next.
1384
1385	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
1386		2096
1387	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).
1388		2099
1389	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
1390		2101
1391	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
1392	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
1393	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
1394		2105
1395	=item $timer = $timer->start	2106	=item $timer = $timer->start
1396		2107
1397	Start the timer.	2108	Start the timer.
1398		2109
1399	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
1400		2111
1401	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>.
1402		2118
1403	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
1404		2120
1405	Stop the timer.	2121	Stop the timer.
1406		2122
…		…
1412		2128
1413	$term->{socket} = ...	2129	$term->{socket} = ...
1414	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
1415	->new	2131	->new
1416	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
1417	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
1418	->start	2134	->start
1419	->cb (sub {	2135	->cb (sub {
1420	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
1421	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
1422	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
1435	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>
1436	is a bitset as described in the C<events> method.	2152	is a bitset as described in the C<events> method.
1437		2153
1438	=item $iow = $iow->fd ($fd)	2154	=item $iow = $iow->fd ($fd)
1439		2155
1440	Set the filedescriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
1441		2157
1442	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
1443		2159
1444	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
1445	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
1446	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
1447		2163
1448	=item $iow = $iow->start	2164	=item $iow = $iow->start
1449		2165
1450	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
1451		2167
1452	=item $iow = $iow->stop	2168	=item $iow = $iow->stop
1453		2169
1454	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.
1455		2232
1456	=back	2233	=back
1457		2234
1458	=head1 ENVIRONMENT	2235	=head1 ENVIRONMENT
1459		2236
…		…
1466		2243
1467	=item == 0 - fatal messages	2244	=item == 0 - fatal messages
1468		2245
1469	=item >= 3 - script loading and management	2246	=item >= 3 - script loading and management
1470		2247
1471	=item >=10 - all events received	2248	=item >=10 - all called hooks
		2249
		2250	=item >=11 - hook return values
1472		2251
1473	=back	2252	=back
1474		2253
1475	=head1 AUTHOR	2254	=head1 AUTHOR
1476		2255
…		…
1478	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
1479		2258
1480	=cut	2259	=cut
1481		2260
1482	1	2261	1
		2262
		2263	# vim: sw=3:

Diff Legend

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