ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC

…		…
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	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\|([^|]+)\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
		82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
61	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
62		95
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	97	runtime.
65		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
66	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
67		117
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	119	text into various other formats/action (such as uri unescaping, perl
		120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide wether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
		131
		132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
70		140
71	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
72		142
73	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
76		147
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	148	Inputting characters appends them to the regex and continues incremental
78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79	history, C<enter> leaves search mode at the current position and C<escape>	150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	151	bottom. C<Escape> leaves search mode and returns to the point where search
		152	was started, while C<Enter> or C<Return> stay at the current position and
		153	additionally stores the first match in the current line into the primary
		154	selection.
81		155
82	=item digital-clock	156	=item readline (enabled by default)
83		157
84	Displays a digital clock using the built-in overlay.	158	A support package that tries to make editing with readline easier. At
		159	the moment, it reacts to clicking shift-left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
		181	=item selection-autotransform
		182
		183	This selection allows you to do automatic transforms on a selection
		184	whenever a selection is made.
		185
		186	It works by specifying perl snippets (most useful is a single C<s///>
		187	operator) that modify C<$_> as resources:
		188
		189	URxvt.selection-autotransform.0: transform
		190	URxvt.selection-autotransform.1: transform
		191	...
		192
		193	For example, the following will transform selections of the form
		194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		195	$word>:
		196
		197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		198
		199	And this example matches the same,but replaces it with vi-commands you can
		200	paste directly into your (vi :) editor:
		201
		202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		203
		204	Of course, this can be modified to suit your needs and your editor :)
		205
		206	To expand the example above to typical perl error messages ("XXX at
		207	FILENAME line YYY."), you need a slightly more elaborate solution:
		208
		209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		211
		212	The first line tells the selection code to treat the unchanging part of
		213	every error message as a selection pattern, and the second line transforms
		214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
85		238
86	=item mark-urls	239	=item mark-urls
87		240
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
		242	make them clickable. When middle-clicked, the program specified in the
		243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		244	the URL as first argument.
		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
		258	=item automove-background
		259
		260	This is basically a one-line extension that dynamically changes the background pixmap offset
		261	to the window position, in effect creating the same effect as pseudo transparency with
		262	a custom pixmap. No scaling is supported in this mode. Exmaple:
		263
		264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
89		265
90	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
91		267
92	A not very useful example of filtering all text output to the terminal,	268	A not very useful example of filtering all text output to the terminal,
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	270	similar-looking ascii character.
95		271
		272	=item digital-clock
		273
		274	Displays a digital clock using the built-in overlay.
		275
		276	=item remote-clipboard
		277
		278	Somewhat of a misnomer, this extension adds two menu entries to the
		279	selection popup that allows one ti run external commands to store the
		280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		295
		296	=item selection-pastebin
		297
		298	This is a little rarely useful extension that Uploads the selection as
		299	textfile to a remote site (or does other things). (The implementation is
		300	not currently secure for use in a multiuser environment as it writes to
		301	F</tmp> directly.).
		302
		303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		304	i.e.
		305
		306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		307
		308	Pressing this combination runs a command with C<%> replaced by the name of
		309	the textfile. This command can be set via a resource:
		310
		311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		312
		313	And the default is likely not useful to anybody but the few people around
		314	here :)
		315
		316	The name of the textfile is the hex encoded md5 sum of the selection, so
		317	the same content should lead to the same filename.
		318
		319	After a successful upload the selection will be replaced by the text given
		320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		321	for the filename):
		322
		323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		324
96	=item example-refresh-hooks	325	=item example-refresh-hooks
97		326
98	Displays a very simple digital clock in the upper right corner of the	327	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	329	overlays or changes.
101		330
102	=back	331	=back
		332
		333	=head1 API DOCUMENTATION
103		334
104	=head2 General API Considerations	335	=head2 General API Considerations
105		336
106	All objects (such as terminals, time watchers etc.) are typical	337	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	338	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	351	=over 4
121		352
122	=item $text	353	=item $text
123		354
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	355	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	356	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		357
127	=item $string	358	=item $string
128		359
129	A perl text string, with an emphasis on I<text>. It can store all unicode	360	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	361	characters and is to be distinguished with text encoded in a specific
…		…
176	called whenever the relevant event happens.	407	called whenever the relevant event happens.
177		408
178	The first argument passed to them is an extension oject as described in	409	The first argument passed to them is an extension oject as described in
179	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
180		411
181	B<All> of these hooks must return a boolean value. If it is true, then the	412	B<All> of these hooks must return a boolean value. If any of the called
182	event counts as being I<consumed>, and the invocation of other hooks is	413	hooks returns true, then the event counts as being I<consumed>, and the
183	skipped, and the relevant action might not be carried out by the C++ code.	414	relevant action might not be carried out by the C++ code.
184		415
185	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
186		417
187	=over 4	418	=over 4
188		419
189	=item on_init $term	420	=item on_init $term
190		421
191	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
192	windows are created or the command gets run. Most methods are unsafe to	423	windows are created or the command gets run. Most methods are unsafe to
193	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	425	have not yet been determined. You can safely query and change resources
195	though.	426	and options, though. For many purposes the C<on_start> hook is a better
		427	place.
		428
		429	=item on_start $term
		430
		431	Called at the very end of initialisation of a new terminal, just before
		432	trying to map (display) the toplevel and returning to the mainloop.
		433
		434	=item on_destroy $term
		435
		436	Called whenever something tries to destroy terminal, when the terminal is
		437	still fully functional (not for long, though).
196		438
197	=item on_reset $term	439	=item on_reset $term
198		440
199	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
200	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
201	variables.	443	variables.
202		444
203	=item on_start $term	445	=item on_child_start $term, $pid
204		446
205	Called at the very end of initialisation of a new terminal, just before	447	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	448
		449	=item on_child_exit $term, $status
		450
		451	Called just after the child process has exited. C<$status> is the status
		452	from C<waitpid>.
207		453
208	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
209		455
210	Called whenever a selection has been made by the user, but before the	456	Called whenever a selection has been made by the user, but before the
211	selection text is copied, so changes to the beginning, end or type of the	457	selection text is copied, so changes to the beginning, end or type of the
…		…
225	=item on_sel_extend $term	471	=item on_sel_extend $term
226		472
227	Called whenever the user tries to extend the selection (e.g. with a double	473	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	474	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	475	should extend the selection itelf and return true to suppress the built-in
230	processing.	476	processing. This can happen multiple times, as long as the callback
		477	returns true, it will be called on every further click by the user and is
		478	supposed to enlarge the selection more and more, if possible.
231		479
232	See the F<selection> example extension.	480	See the F<selection> example extension.
233		481
234	=item on_view_change $term, $offset	482	=item on_view_change $term, $offset
235		483
…		…
296		544
297	=item on_refresh_end $term	545	=item on_refresh_end $term
298		546
299	Called just after the screen gets redrawn. See C<on_refresh_begin>.	547	Called just after the screen gets redrawn. See C<on_refresh_begin>.
300		548
301	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
302		550
303	Called whenever the user presses a key combination that has a	551	Called whenever the a user-configured event is being activated (e.g. via
304	C<perl:string> action bound to it (see description of the B<keysym>	552	a C<perl:string> action bound to a key, see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	553	resource in the @@RXVT_NAME@@(1) manpage).
		554
		555	The event is simply the action string. This interface is assumed to change
		556	slightly in the future.
		557
		558	=item on_resize_all_windows $tern, $new_width, $new_height
		559
		560	Called just after the new window size has been calculcated, but before
		561	windows are actually being resized or hints are being set. If this hook
		562	returns TRUE, setting of the window hints is being skipped.
		563
		564	=item on_x_event $term, $event
		565
		566	Called on every X event received on the vt window (and possibly other
		567	windows). Should only be used as a last resort. Most event structure
		568	members are not passed.
306		569
307	=item on_focus_in $term	570	=item on_focus_in $term
308		571
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	572	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	573	does focus in processing.
…		…
312	=item on_focus_out $term	575	=item on_focus_out $term
313		576
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	577	Called wheneever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	578	focus out processing.
316		579
		580	=item on_configure_notify $term, $event
		581
		582	=item on_property_notify $term, $event
		583
317	=item on_key_press $term, $event, $keysym, $octets	584	=item on_key_press $term, $event, $keysym, $octets
318		585
319	=item on_key_release $term, $event, $keysym	586	=item on_key_release $term, $event, $keysym
320		587
321	=item on_button_press $term, $event	588	=item on_button_press $term, $event
…		…
330		597
331	Called whenever the corresponding X event is received for the terminal If	598	Called whenever the corresponding X event is received for the terminal If
332	the hook returns true, then the even will be ignored by rxvt-unicode.	599	the hook returns true, then the even will be ignored by rxvt-unicode.
333		600
334	The event is a hash with most values as named by Xlib (see the XEvent	601	The event is a hash with most values as named by Xlib (see the XEvent
335	manpage), with the additional members C<row> and C<col>, which are the row	602	manpage), with the additional members C<row> and C<col>, which are the
336	and column under the mouse cursor.	603	(real, not screen-based) row and column under the mouse cursor.
337		604
338	C<on_key_press> additionally receives the string rxvt-unicode would	605	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	606	output, if any, in locale-specific encoding.
340		607
341	subwindow.	608	subwindow.
342		609
343	=back	610	=item on_client_message $term, $event
344		611
345	=head2 Variables in the C<urxvt> Package	612	=item on_wm_protocols $term, $event
346		613
347	=over 4	614	=item on_wm_delete_window $term, $event
348		615
349	=item $urxvt::TERM	616	Called when various types of ClientMessage events are received (all with
350		617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		618
453	=back	619	=back
454		620
455	=cut	621	=cut
456		622
…		…
462	use Scalar::Util ();	628	use Scalar::Util ();
463	use List::Util ();	629	use List::Util ();
464		630
465	our $VERSION = 1;	631	our $VERSION = 1;
466	our $TERM;	632	our $TERM;
		633	our @TERM_INIT;
		634	our @TERM_EXT;
467	our @HOOKNAME;	635	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	637	our %OPTION;
470		638
471	our $LIBDIR;	639	our $LIBDIR;
472	our $RESNAME;	640	our $RESNAME;
473	our $RESCLASS;	641	our $RESCLASS;
474	our $RXVTNAME;	642	our $RXVTNAME;
475		643
		644	our $NOCHAR = chr 0xffff;
		645
		646	=head2 Variables in the C<urxvt> Package
		647
		648	=over 4
		649
		650	=item $urxvt::LIBDIR
		651
		652	The rxvt-unicode library directory, where, among other things, the perl
		653	modules and scripts are stored.
		654
		655	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		656
		657	The resource class and name rxvt-unicode uses to look up X resources.
		658
		659	=item $urxvt::RXVTNAME
		660
		661	The basename of the installed binaries, usually C<urxvt>.
		662
		663	=item $urxvt::TERM
		664
		665	The current terminal. This variable stores the current C<urxvt::term>
		666	object, whenever a callback/hook is executing.
		667
		668	=item @urxvt::TERM_INIT
		669
		670	All coderefs in this array will be called as methods of the next newly
		671	created C<urxvt::term> object (during the C<on_init> phase). The array
		672	gets cleared before the codereferences that were in it are being executed,
		673	so coderefs can push themselves onto it again if they so desire.
		674
		675	This complements to the perl-eval commandline option, but gets executed
		676	first.
		677
		678	=item @urxvt::TERM_EXT
		679
		680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		681	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		682	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		683
		684	=back
		685
		686	=head2 Functions in the C<urxvt> Package
		687
		688	=over 4
		689
		690	=item urxvt::fatal $errormessage
		691
		692	Fatally aborts execution with the given error message. Avoid at all
		693	costs! The only time this is acceptable is when the terminal process
		694	starts up.
		695
		696	=item urxvt::warn $string
		697
		698	Calls C<rxvt_warn> with the given string which should not include a
		699	newline. The module also overwrites the C<warn> builtin with a function
		700	that calls this function.
		701
		702	Using this function has the advantage that its output ends up in the
		703	correct place, e.g. on stderr of the connecting urxvtc client.
		704
		705	Messages have a size limit of 1023 bytes currently.
		706
		707	=item @terms = urxvt::termlist
		708
		709	Returns all urxvt::term objects that exist in this process, regardless of
		710	wether they are started, being destroyed etc., so be careful. Only term
		711	objects that have perl extensions attached will be returned (because there
		712	is no urxvt::term objet associated with others).
		713
		714	=item $time = urxvt::NOW
		715
		716	Returns the "current time" (as per the event loop).
		717
		718	=item urxvt::CurrentTime
		719
		720	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		721	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		722	Button4Mask, Button5Mask, AnyModifier
		723
		724	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		725	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		726	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		727	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		728	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		729	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		730	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		731
		732	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		733	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		734	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		735	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		736	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		737	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		738	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		739
		740	Various constants for use in X calls and event processing.
		741
		742	=back
		743
		744	=head2 RENDITION
		745
		746	Rendition bitsets contain information about colour, font, font styles and
		747	similar information for each screen cell.
		748
		749	The following "macros" deal with changes in rendition sets. You should
		750	never just create a bitset, you should always modify an existing one,
		751	as they contain important information required for correct operation of
		752	rxvt-unicode.
		753
		754	=over 4
		755
		756	=item $rend = urxvt::DEFAULT_RSTYLE
		757
		758	Returns the default rendition, as used when the terminal is starting up or
		759	being reset. Useful as a base to start when creating renditions.
		760
		761	=item $rend = urxvt::OVERLAY_RSTYLE
		762
		763	Return the rendition mask used for overlays by default.
		764
		765	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		766
		767	Return the bit that enabled bold, italic, blink, reverse-video and
		768	underline, respectively. To enable such a style, just logically OR it into
		769	the bitset.
		770
		771	=item $foreground = urxvt::GET_BASEFG $rend
		772
		773	=item $background = urxvt::GET_BASEBG $rend
		774
		775	Return the foreground/background colour index, respectively.
		776
		777	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		778
		779	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		780
		781	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		782
		783	Replace the foreground/background colour in the rendition mask with the
		784	specified one.
		785
		786	=item $value = urxvt::GET_CUSTOM $rend
		787
		788	Return the "custom" value: Every rendition has 5 bits for use by
		789	extensions. They can be set and changed as you like and are initially
		790	zero.
		791
		792	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		793
		794	Change the custom value.
		795
		796	=back
		797
		798	=cut
		799
476	BEGIN {	800	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	801	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	802	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	803	my $msg = join "", @_;
482	$msg .= "\n"	804	$msg .= "\n"
483	unless $msg =~ /\n$/;	805	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	806	urxvt::warn ($msg);
485	};	807	};
486
487	delete $ENV{IFS};
488	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	808	}
492		809
493	my @hook_count;	810	no warnings 'utf8';
		811
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		813
496	sub verbose {	814	sub verbose {
497	my ($level, $msg) = @_;	815	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	816	warn "$msg\n" if $level <= $verbosity;
499	}	817	}
500		818
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	819	my %extension_pkg;
503		820
504	# load a single script into its own package, once only	821	# load a single script into its own package, once only
505	sub extension_package($) {	822	sub extension_package($) {
506	my ($path) = @_;	823	my ($path) = @_;
507		824
508	$extension_pkg{$path} ||= do {	825	$extension_pkg{$path} ||= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	826	$path =~ /([^\/\\]+)$/;
		827	my $pkg = $1;
		828	$pkg =~ s/[^[:word:]]/_/g;
		829	$pkg = "urxvt::ext::$pkg";
510		830
511	verbose 3, "loading extension '$path' into package '$pkg'";	831	verbose 3, "loading extension '$path' into package '$pkg'";
512		832
513	open my $fh, "<:raw", $path	833	open my $fh, "<:raw", $path
514	or die "$path: $!";	834	or die "$path: $!";
515		835
516	my $source = untaint	836	my $source =
517	"package $pkg; use strict; use utf8;\n"	837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	838	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	839	. (do { local $/; <$fh> })
521	. "\n};\n1";	840	. "\n};\n1";
522		841
523	eval $source	842	eval $source
…		…
537	if ($htype == 0) { # INIT	856	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		858
540	my %ext_arg;	859	my %ext_arg;
541		860
		861	{
		862	my @init = @TERM_INIT;
		863	@TERM_INIT = ();
		864	$_->($TERM) for @init;
		865	my @pkg = @TERM_EXT;
		866	@TERM_EXT = ();
		867	$TERM->register_package ($_) for @pkg;
		868	}
		869
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	871	if ($_ eq "default") {
544	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	872	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
545	} elsif (/^-(.*)$/) {	873	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	874	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	875	} elsif (/^([^<]+)<(.*)>$/) {
548	push @{ $ext_arg{$1} }, $2;	876	push @{ $ext_arg{$1} }, $2;
549	} else {	877	} else {
550	$ext_arg{$_} ||= [];	878	$ext_arg{$_} ||= [];
551	}	879	}
552	}	880	}
553		881
554	while (my ($ext, $argv) = each %ext_arg) {	882	for my $ext (sort keys %ext_arg) {
555	my @files = grep -f $_, map "$_/$ext", @dirs;	883	my @files = grep -f $_, map "$_/$ext", @dirs;
556		884
557	if (@files) {	885	if (@files) {
558	$TERM->register_package (extension_package $files[0], $argv);	886	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
559	} else {	887	} else {
560	warn "perl extension '$ext' not found in perl library search path\n";	888	warn "perl extension '$ext' not found in perl library search path\n";
561	}	889	}
562	}	890	}
563		891
…		…
572	if $verbosity >= 10;	900	if $verbosity >= 10;
573		901
574	keys %$cb;	902	keys %$cb;
575		903
576	while (my ($pkg, $cb) = each %$cb) {	904	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	906	$retval ||= $retval_;
579		907
580	if ($@) {	908	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	909	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	910	warn $@;
583	}	911	}
584	}	912	}
		913
		914	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		915	if $verbosity >= 11;
585	}	916	}
586		917
587	if ($htype == 1) { # DESTROY	918	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	919	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	920	%$_ = () for values %{ $TERM->{_pkg} };
597		921
598	# clear package	922	# clear package
599	%$TERM = ();	923	%$TERM = ();
600	}	924	}
601		925
602	$retval	926	$retval
		927	}
		928
		929	sub SET_COLOR($$$) {
		930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
603	}	931	}
604		932
605	# urxvt::term::extension	933	# urxvt::term::extension
606		934
607	package urxvt::term::extension;	935	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	941	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	942	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	943	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	944	or Carp::croak "unsupported hook type '$name'";
617		945
		946	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	947	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		948
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	949	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	950	}
625	}	951	}
626		952
…		…
631	for my $name (@hook) {	957	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	958	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	959	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	960	or Carp::croak "unsupported hook type '$name'";
635		961
		962	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	963	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	964	}
641	}	965	}
642		966
643	our $AUTOLOAD;	967	our $AUTOLOAD;
644		968
…		…
675		999
676	=head2 The C<urxvt::anyevent> Class	1000	=head2 The C<urxvt::anyevent> Class
677		1001
678	The sole purpose of this class is to deliver an interface to the	1002	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	1003	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	1004	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	1005	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	1006	is that you cannot use blocking APIs, but the non-blocking variant should
		1007	work.
683		1008
684	=cut	1009	=cut
685		1010
686	our $VERSION = 1;	1011	our $VERSION = 1;
687		1012
…		…
749	# find on_xxx subs in the package and register them	1074	# find on_xxx subs in the package and register them
750	# as hooks	1075	# as hooks
751	sub register_package {	1076	sub register_package {
752	my ($self, $pkg, $argv) = @_;	1077	my ($self, $pkg, $argv) = @_;
753		1078
		1079	no strict 'refs';
		1080
		1081	urxvt::verbose 6, "register package $pkg to $self";
		1082
		1083	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1084
754	my $proxy = bless {	1085	my $proxy = bless {
755	_pkg => $pkg,	1086	_pkg => $pkg,
756	argv => $argv,	1087	argv => $argv,
757	}, $pkg;	1088	}, $pkg;
758	Scalar::Util::weaken ($proxy->{term} = $self);	1089	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
764	$proxy->enable ($name => $ref);	1095	$proxy->enable ($name => $ref);
765	}	1096	}
766	}	1097	}
767	}	1098	}
768		1099
		1100	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1101
		1102	Creates a new terminal, very similar as if you had started it with system
		1103	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1104	hash which defines the environment of the new terminal.
		1105
		1106	Croaks (and probably outputs an error message) if the new instance
		1107	couldn't be created. Returns C<undef> if the new instance didn't
		1108	initialise perl, and the terminal object otherwise. The C<init> and
		1109	C<start> hooks will be called before this call returns, and are free to
		1110	refer to global data (which is race free).
		1111
		1112	=cut
		1113
		1114	sub new {
		1115	my ($class, $env, @args) = @_;
		1116
		1117	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1118	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1119
		1120	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1121	}
		1122
769	=item $term->destroy	1123	=item $term->destroy
770		1124
771	Destroy the terminal object (close the window, free resources etc.).	1125	Destroy the terminal object (close the window, free resources
		1126	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1127	watchers (timers, io watchers) are still active.
		1128
		1129	=item $term->exec_async ($cmd[, @args])
		1130
		1131	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1132	("starts") programs in the background. This function takes care of setting
		1133	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1134	be preferred over explicit calls to C<exec> or C<system>.
		1135
		1136	Returns the pid of the subprocess or C<undef> on error.
		1137
		1138	=cut
		1139
		1140	sub exec_async {
		1141	my $self = shift;
		1142
		1143	my $pid = fork;
		1144
		1145	return $pid
		1146	if !defined $pid or $pid;
		1147
		1148	%ENV = %{ $self->env };
		1149
		1150	exec @_;
		1151	urxvt::_exit 255;
		1152	}
772		1153
773	=item $isset = $term->option ($optval[, $set])	1154	=item $isset = $term->option ($optval[, $set])
774		1155
775	Returns true if the option specified by C<$optval> is enabled, and	1156	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	1157	optionally change it. All option values are stored by name in the hash
…		…
779	Here is a a likely non-exhaustive list of option names, please see the	1160	Here is a a likely non-exhaustive list of option names, please see the
780	source file F</src/optinc.h> to see the actual list:	1161	source file F</src/optinc.h> to see the actual list:
781		1162
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1163	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1168	transparent tripleclickwords utmpInhibit visualBell
788		1169
789	=item $value = $term->resource ($name[, $newval])	1170	=item $value = $term->resource ($name[, $newval])
790		1171
791	Returns the current resource value associated with a given name and	1172	Returns the current resource value associated with a given name and
792	optionally sets a new value. Setting values is most useful in the C<init>	1173	optionally sets a new value. Setting values is most useful in the C<init>
…		…
809		1190
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1192	borderLess color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1193	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1201	secondaryScreen secondaryScroll selectstyle shade term_name title
821	utmpInhibit visualBell	1202	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1203	visualBell
822		1204
823	=cut	1205	=cut
824		1206
825	sub resource($$;$) {	1207	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1208	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1209	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1210	&urxvt::term::_resource
829	}	1211	}
830		1212
		1213	=item $value = $term->x_resource ($pattern)
		1214
		1215	Returns the X-Resource for the given pattern, excluding the program or
		1216	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1217	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1218	resource with that pattern exists.
		1219
		1220	This method should only be called during the C<on_start> hook, as there is
		1221	only one resource database per display, and later invocations might return
		1222	the wrong resources.
		1223
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1224	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1225
833	Adds a keymap translation exactly as specified via a resource. See the	1226	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1227	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1228
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1243	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1244
852	Return the current values of the selection mark, begin or end positions,	1245	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1246	and optionally set them to new values.
854		1247
		1248	=item $term->selection_make ($eventtime[, $rectangular])
		1249
		1250	Tries to make a selection as set by C<selection_beg> and
		1251	C<selection_end>. If C<$rectangular> is true (default: false), a
		1252	rectangular selection will be made. This is the prefered function to make
		1253	a selection.
		1254
855	=item $success = $term->selection_grab ($eventtime)	1255	=item $success = $term->selection_grab ($eventtime)
856		1256
857	Try to request the primary selection from the server (for example, as set	1257	Try to request the primary selection text from the server (for example, as
858	by the next method).	1258	set by the next method). No visual feedback will be given. This function
		1259	is mostly useful from within C<on_sel_grab> hooks.
859		1260
860	=item $oldtext = $term->selection ([$newtext])	1261	=item $oldtext = $term->selection ([$newtext])
861		1262
862	Return the current selection text and optionally replace it by C<$newtext>.	1263	Return the current selection text and optionally replace it by C<$newtext>.
863		1264
…		…
956	Convert the given locale-encoded octets into a perl string.	1357	Convert the given locale-encoded octets into a perl string.
957		1358
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1359	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1360
960	XORs the rendition values in the given span with the provided value	1361	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1362	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1363	refresh hooks to provide effects similar to the selection.
963		1364
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1365	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1366
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1367	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1368	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1369	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969	it instead.	1370	it instead. Both styles I<MUST NOT> contain font styles.
970		1371
971	=item $term->scr_bell	1372	=item $term->scr_bell
972		1373
973	Ring the bell!	1374	Ring the bell!
974		1375
…		…
981		1382
982	Normally its not a good idea to use this function, as programs might be	1383	Normally its not a good idea to use this function, as programs might be
983	confused by changes in cursor position or scrolling. Its useful inside a	1384	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1385	C<on_add_lines> hook, though.
985		1386
		1387	=item $term->scr_change_screen ($screen)
		1388
		1389	Switch to given screen - 0 primary, 1 secondary.
		1390
986	=item $term->cmd_parse ($octets)	1391	=item $term->cmd_parse ($octets)
987		1392
988	Similar to C<scr_add_lines>, but the argument must be in the	1393	Similar to C<scr_add_lines>, but the argument must be in the
989	locale-specific encoding of the terminal and can contain command sequences	1394	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1395	(escape codes) that will be interpreted.
…		…
1000	Replaces the event mask of the pty watcher by the given event mask. Can	1405	Replaces the event mask of the pty watcher by the given event mask. Can
1001	be used to suppress input and output handling to the pty/tty. See the	1406	be used to suppress input and output handling to the pty/tty. See the
1002	description of C<< urxvt::timer->events >>. Make sure to always restore	1407	description of C<< urxvt::timer->events >>. Make sure to always restore
1003	the previous value.	1408	the previous value.
1004		1409
		1410	=item $fd = $term->pty_fd
		1411
		1412	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1413	is used.
		1414
1005	=item $windowid = $term->parent	1415	=item $windowid = $term->parent
1006		1416
1007	Return the window id of the toplevel window.	1417	Return the window id of the toplevel window.
1008		1418
1009	=item $windowid = $term->vt	1419	=item $windowid = $term->vt
1010		1420
1011	Return the window id of the terminal window.	1421	Return the window id of the terminal window.
1012		1422
		1423	=item $term->vt_emask_add ($x_event_mask)
		1424
		1425	Adds the specified events to the vt event mask. Useful e.g. when you want
		1426	to receive pointer events all the times:
		1427
		1428	$term->vt_emask_add (urxvt::PointerMotionMask);
		1429
		1430	=item $term->focus_in
		1431
		1432	=item $term->focus_out
		1433
		1434	=item $term->key_press ($state, $keycode[, $time])
		1435
		1436	=item $term->key_release ($state, $keycode[, $time])
		1437
		1438	Deliver various fake events to to terminal.
		1439
1013	=item $window_width = $term->width	1440	=item $window_width = $term->width
1014		1441
1015	=item $window_height = $term->height	1442	=item $window_height = $term->height
1016		1443
1017	=item $font_width = $term->fwidth	1444	=item $font_width = $term->fwidth
…		…
1030		1457
1031	=item $max_scrollback = $term->saveLines	1458	=item $max_scrollback = $term->saveLines
1032		1459
1033	=item $nrow_plus_saveLines = $term->total_rows	1460	=item $nrow_plus_saveLines = $term->total_rows
1034		1461
1035	=item $lines_in_scrollback = $term->nsaved	1462	=item $topmost_scrollback_row = $term->top_row
1036		1463
1037	Return various integers describing terminal characteristics.	1464	Return various integers describing terminal characteristics.
1038		1465
		1466	=item $x_display = $term->display_id
		1467
		1468	Return the DISPLAY used by rxvt-unicode.
		1469
1039	=item $lc_ctype = $term->locale	1470	=item $lc_ctype = $term->locale
1040		1471
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1472	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1473
1043	=item $x_display = $term->display_id	1474	=item $env = $term->env
1044		1475
1045	Return the DISPLAY used by rxvt-unicode.	1476	Returns a copy of the environment in effect for the terminal as a hashref
		1477	similar to C<\%ENV>.
		1478
		1479	=item @envv = $term->envv
		1480
		1481	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1482
		1483	=item @argv = $term->argv
		1484
		1485	Return the argument vector as this terminal, similar to @ARGV, but
		1486	includes the program name as first element.
		1487
		1488	=cut
		1489
		1490	sub env {
		1491	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1492	}
1046		1493
1047	=item $modifiermask = $term->ModLevel3Mask	1494	=item $modifiermask = $term->ModLevel3Mask
1048		1495
1049	=item $modifiermask = $term->ModMetaMask	1496	=item $modifiermask = $term->ModMetaMask
1050		1497
1051	=item $modifiermask = $term->ModNumLockMask	1498	=item $modifiermask = $term->ModNumLockMask
1052		1499
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1500	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1501	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1502
		1503	=item $screen = $term->current_screen
		1504
		1505	Returns the currently displayed screen (0 primary, 1 secondary).
		1506
		1507	=item $cursor_is_hidden = $term->hidden_cursor
		1508
		1509	Returns wether the cursor is currently hidden or not.
		1510
1056	=item $view_start = $term->view_start ([$newvalue])	1511	=item $view_start = $term->view_start ([$newvalue])
1057		1512
1058	Returns the negative row number of the topmost line. Minimum value is	1513	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1514	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1515	this many lines into the scrollback buffer.
1061		1516
1062	=item $term->want_refresh	1517	=item $term->want_refresh
1063		1518
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1519	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1534	line, starting at column C<$start_col> (default C<0>), which is useful
1080	to replace only parts of a line. The font index in the rendition will	1535	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1536	automatically be updated.
1082		1537
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1538	C<$text> is in a special encoding: tabs and wide characters that use more
1084	than one cell when displayed are padded with urxvt::NOCHAR characters	1539	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1085	(C<chr 65535>). Characters with combining characters and other characters	1540	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1541	do not fit into the normal tetx encoding will be replaced with characters
1087	characters in the private use area.	1542	in the private use area.
1088		1543
1089	You have to obey this encoding when changing text. The advantage is	1544	You have to obey this encoding when changing text. The advantage is
1090	that C<substr> and similar functions work on screen cells and not on	1545	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1546	characters.
1092		1547
…		…
1143	Return the row number of the first/last row of the line, respectively.	1598	Return the row number of the first/last row of the line, respectively.
1144		1599
1145	=item $offset = $line->offset_of ($row, $col)	1600	=item $offset = $line->offset_of ($row, $col)
1146		1601
1147	Returns the character offset of the given row|col pair within the logical	1602	Returns the character offset of the given row|col pair within the logical
1148	line.	1603	line. Works for rows outside the line, too, and returns corresponding
		1604	offsets outside the string.
1149		1605
1150	=item ($row, $col) = $line->coord_of ($offset)	1606	=item ($row, $col) = $line->coord_of ($offset)
1151		1607
1152	Translates a string offset into terminal coordinates again.	1608	Translates a string offset into terminal coordinates again.
1153		1609
…		…
1238	=item $string = $term->special_decode $text	1694	=item $string = $term->special_decode $text
1239		1695
1240	Converts rxvt-unicodes text reprsentation into a perl string. See	1696	Converts rxvt-unicodes text reprsentation into a perl string. See
1241	C<< $term->ROW_t >> for details.	1697	C<< $term->ROW_t >> for details.
1242		1698
1243	=item $success = $term->grab_button ($button, $modifiermask)	1699	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1244		1700
		1701	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1702
1245	Registers a synchronous button grab. See the XGrabButton manpage.	1703	Register/unregister a synchronous button grab. See the XGrabButton
		1704	manpage.
1246		1705
1247	=item $success = $term->grab ($eventtime[, $sync])	1706	=item $success = $term->grab ($eventtime[, $sync])
1248		1707
1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1708	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1709	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1266		1725
1267	Calls XUngrab for the most recent grab. Is called automatically on	1726	Calls XUngrab for the most recent grab. Is called automatically on
1268	evaluation errors, as it is better to lose the grab in the error case as	1727	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1728	the session.
1270		1729
		1730	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1731
		1732	=item $atom_name = $term->XGetAtomName ($atom)
		1733
		1734	=item @atoms = $term->XListProperties ($window)
		1735
		1736	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1737
		1738	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1739
		1740	=item $term->XDeleteProperty ($window, $property)
		1741
		1742	=item $window = $term->DefaultRootWindow
		1743
		1744	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1745
		1746	=item $term->XMapWindow ($window)
		1747
		1748	=item $term->XUnmapWindow ($window)
		1749
		1750	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1751
		1752	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1753
		1754	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1755
		1756	Various X or X-related functions. The C<$term> object only serves as
		1757	the source of the display, otherwise those functions map more-or-less
		1758	directory onto the X functions of the same name.
		1759
1271	=back	1760	=back
1272		1761
1273	=cut	1762	=cut
1274		1763
1275	package urxvt::popup;	1764	package urxvt::popup;
…		…
1289		1778
1290	$item->{render} ||= sub { $_[0]{text} };	1779	$item->{render} ||= sub { $_[0]{text} };
1291		1780
1292	push @{ $self->{item} }, $item;	1781	push @{ $self->{item} }, $item;
1293	}	1782	}
		1783
		1784	=item $popup->add_title ($title)
		1785
		1786	Adds a non-clickable title to the popup.
		1787
		1788	=cut
		1789
		1790	sub add_title {
		1791	my ($self, $title) = @_;
		1792
		1793	$self->add_item ({
		1794	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1795	text => $title,
		1796	activate => sub { },
		1797	});
		1798	}
		1799
		1800	=item $popup->add_separator ([$sepchr])
		1801
		1802	Creates a separator, optionally using the character given as C<$sepchr>.
		1803
		1804	=cut
1294		1805
1295	sub add_separator {	1806	sub add_separator {
1296	my ($self, $sep) = @_;	1807	my ($self, $sep) = @_;
1297		1808
1298	$sep ||= "=";	1809	$sep ||= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1814	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1815	activate => sub { },
1305	});	1816	});
1306	}	1817	}
1307		1818
1308	sub add_title {	1819	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1820
1311	$self->add_item ({	1821	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1822	selected.
1313	text => $title,	1823
1314	activate => sub { },	1824	=cut
1315	});
1316	}
1317		1825
1318	sub add_button {	1826	sub add_button {
1319	my ($self, $text, $cb) = @_;	1827	my ($self, $text, $cb) = @_;
1320		1828
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1829	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1830	}
1323		1831
		1832	=item $popup->add_toggle ($text, $initial_value, $cb)
		1833
		1834	Adds a toggle/checkbox item to the popup. The callback gets called
		1835	whenever it gets toggled, with a boolean indicating its new value as its
		1836	first argument.
		1837
		1838	=cut
		1839
1324	sub add_toggle {	1840	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1841	my ($self, $text, $value, $cb) = @_;
1326		1842
1327	my $item; $item = {	1843	my $item; $item = {
1328	type => "button",	1844	type => "button",
1329	text => " $text",	1845	text => " $text",
1330	value => $value,	1846	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1847	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1848	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1849	};
1334		1850
1335	$self->add_item ($item);	1851	$self->add_item ($item);
1336	}	1852	}
		1853
		1854	=item $popup->show
		1855
		1856	Displays the popup (which is initially hidden).
		1857
		1858	=cut
1337		1859
1338	sub show {	1860	sub show {
1339	my ($self) = @_;	1861	my ($self) = @_;
1340		1862
1341	local $urxvt::popup::self = $self;	1863	local $urxvt::popup::self = $self;
1342		1864
		1865	my $env = $self->{term}->env;
		1866	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1867	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1868	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1869
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1870	urxvt::term->new ($env, "popup",
		1871	"--perl-lib" => "", "--perl-ext-common" => "",
		1872	"-pty-fd" => -1, "-sl" => 0,
		1873	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1874	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1875	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1876	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1877	or die "unable to create popup window\n";
1350	}	1878	}
1351		1879
1352	sub DESTROY {	1880	sub DESTROY {
1353	my ($self) = @_;	1881	my ($self) = @_;
1354		1882
1355	delete $self->{term}{_destroy}{$self};	1883	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1884	$self->{term}->ungrab;
1357	}	1885	}
		1886
		1887	=back
		1888
		1889	=cut
		1890
		1891	package urxvt::watcher;
		1892
		1893	@urxvt::timer::ISA = __PACKAGE__;
		1894	@urxvt::iow::ISA = __PACKAGE__;
		1895	@urxvt::pw::ISA = __PACKAGE__;
		1896	@urxvt::iw::ISA = __PACKAGE__;
1358		1897
1359	=head2 The C<urxvt::timer> Class	1898	=head2 The C<urxvt::timer> Class
1360		1899
1361	This class implements timer watchers/events. Time is represented as a	1900	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1901	fractional number of seconds since the epoch. Example:
…		…
1400	Start the timer.	1939	Start the timer.
1401		1940
1402	=item $timer = $timer->start ($tstamp)	1941	=item $timer = $timer->start ($tstamp)
1403		1942
1404	Set the event trigger time to C<$tstamp> and start the timer.	1943	Set the event trigger time to C<$tstamp> and start the timer.
		1944
		1945	=item $timer = $timer->after ($delay)
		1946
		1947	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		1948
1406	=item $timer = $timer->stop	1949	=item $timer = $timer->stop
1407		1950
1408	Stop the timer.	1951	Stop the timer.
1409		1952
…		…
1456		1999
1457	Stop watching for events on the given filehandle.	2000	Stop watching for events on the given filehandle.
1458		2001
1459	=back	2002	=back
1460		2003
		2004	=head2 The C<urxvt::iw> Class
		2005
		2006	This class implements idle watchers, that get called automatically when
		2007	the process is idle. They should return as fast as possible, after doing
		2008	some useful work.
		2009
		2010	=over 4
		2011
		2012	=item $iw = new urxvt::iw
		2013
		2014	Create a new idle watcher object in stopped state.
		2015
		2016	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2017
		2018	Set the callback to be called when the watcher triggers.
		2019
		2020	=item $timer = $timer->start
		2021
		2022	Start the watcher.
		2023
		2024	=item $timer = $timer->stop
		2025
		2026	Stop the watcher.
		2027
		2028	=back
		2029
		2030	=head2 The C<urxvt::pw> Class
		2031
		2032	This class implements process watchers. They create an event whenever a
		2033	process exits, after which they stop automatically.
		2034
		2035	my $pid = fork;
		2036	...
		2037	$term->{pw} = urxvt::pw
		2038	->new
		2039	->start ($pid)
		2040	->cb (sub {
		2041	my ($pw, $exit_status) = @_;
		2042	...
		2043	});
		2044
		2045	=over 4
		2046
		2047	=item $pw = new urxvt::pw
		2048
		2049	Create a new process watcher in stopped state.
		2050
		2051	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2052
		2053	Set the callback to be called when the timer triggers.
		2054
		2055	=item $pw = $timer->start ($pid)
		2056
		2057	Tells the wqtcher to start watching for process C<$pid>.
		2058
		2059	=item $pw = $pw->stop
		2060
		2061	Stop the watcher.
		2062
		2063	=back
		2064
1461	=head1 ENVIRONMENT	2065	=head1 ENVIRONMENT
1462		2066
1463	=head2 URXVT_PERL_VERBOSITY	2067	=head2 URXVT_PERL_VERBOSITY
1464		2068
1465	This variable controls the verbosity level of the perl extension. Higher	2069	This variable controls the verbosity level of the perl extension. Higher
…		…
1469		2073
1470	=item == 0 - fatal messages	2074	=item == 0 - fatal messages
1471		2075
1472	=item >= 3 - script loading and management	2076	=item >= 3 - script loading and management
1473		2077
1474	=item >=10 - all events received	2078	=item >=10 - all called hooks
		2079
		2080	=item >=11 - hook reutrn values
1475		2081
1476	=back	2082	=back
1477		2083
1478	=head1 AUTHOR	2084	=head1 AUTHOR
1479		2085

Diff Legend

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