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.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 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	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
		75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
58		84
59	=back	85	=back
60		86
61	=item option-popup (enabled by default)	87	=item option-popup (enabled by default)
62		88
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	90	runtime.
65		91
66	=item digital-clock	92	=item selection-popup (enabled by default)
67		93
68	Displays a digital clock using the built-in overlay.	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		95	text into various other formats/action (such as uri unescaping, perl
		96	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
		117	=item searchable-scrollback<hotkey> (enabled by default)
		118
		119	Adds regex search functionality to the scrollback buffer, triggered
		120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
		123
		124	Inputting characters appends them to the regex and continues incremental
		125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
		131
		132	=item selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	To avoid too many false positives, this is only done when:
		176
		177	=over 4
		178
		179	=item - the mouse is on the same (multi-row-) line as the text cursor.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the text cursor is visible.
		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 tabbed
		191
		192	This transforms the terminal into a tabbar with additional terminals, that
		193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		195	button per tab.
		196
		197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		198	B<Shift-Right> will switch to the tab left or right of the current one,
		199	while B<Shift-Down> creates a new tab.
69		200
70	=item mark-urls	201	=item mark-urls
71		202
72	Uses per-line display filtering (C<on_line_update>) to underline urls.	203	Uses per-line display filtering (C<on_line_update>) to underline urls and
		204	make them clickable. When middle-clicked, the program specified in the
		205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		206	the URL as first argument.
		207
		208	=item automove-background
		209
		210	This is basically a one-line extension that dynamically changes the background pixmap offset
		211	to the window position, in effect creating the same effect as pseudo transparency with
		212	a custom pixmap. No scaling is supported in this mode. Exmaple:
		213
		214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
73		215
74	=item block-graphics-to-ascii	216	=item block-graphics-to-ascii
75		217
76	A not very useful example of filtering all text output to the terminal,	218	A not very useful example of filtering all text output to the terminal,
77	by replacing all line-drawing characters (U+2500 .. U+259F) by a	219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
78	similar-looking ascii character.	220	similar-looking ascii character.
79		221
		222	=item digital-clock
		223
		224	Displays a digital clock using the built-in overlay.
		225
80	=item example-refresh-hooks	226	=item example-refresh-hooks
81		227
82	Displays a very simple digital clock in the upper right corner of the	228	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	229	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	230	overlays or changes.
85		231
		232	=item selection-pastebin
		233
		234	This is a little rarely useful extension that Uploads the selection as
		235	textfile to a remote site (or does other things). (The implementation is
		236	not currently secure for use in a multiuser environment as it writes to
		237	F</tmp> directly.).
		238
		239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		240	i.e.
		241
		242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		243
		244	Pressing this combination runs a command with C<%> replaced by the name of
		245	the textfile. This command can be set via a resource:
		246
		247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		248
		249	And the default is likely not useful to anybody but the few people around
		250	here :)
		251
		252	The name of the textfile is the hex encoded md5 sum of the selection, so
		253	the same content should lead to the same filename.
		254
		255	After a successful upload the selection will be replaced by the text given
		256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		257	for the filename):
		258
		259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		260
86	=back	261	=back
		262
		263	=head1 API DOCUMENTATION
87		264
88	=head2 General API Considerations	265	=head2 General API Considerations
89		266
90	All objects (such as terminals, time watchers etc.) are typical	267	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	268	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	281	=over 4
105		282
106	=item $text	283	=item $text
107		284
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	285	Rxvt-unicodes special way of encoding text, where one "unicode" character
109	always represents one screen cell. See L<row_t> for a discussion of this format.	286	always represents one screen cell. See L<ROW_t> for a discussion of this format.
110		287
111	=item $string	288	=item $string
112		289
113	A perl text string, with an emphasis on I<text>. It can store all unicode	290	A perl text string, with an emphasis on I<text>. It can store all unicode
114	characters and is to be distinguished with text encoded in a specific	291	characters and is to be distinguished with text encoded in a specific
…		…
119	Either binary data or - more common - a text string encoded in a	296	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	297	locale-specific way.
121		298
122	=back	299	=back
123		300
		301	=head2 Extension Objects
		302
		303	Very perl extension is a perl class. A separate perl object is created
		304	for each terminal and each extension and passed as the first parameter to
		305	hooks. So extensions can use their C<$self> object without having to think
		306	about other extensions, with the exception of methods and members that
		307	begin with an underscore character C<_>: these are reserved for internal
		308	use.
		309
		310	Although it isn't a C<urxvt::term> object, you can call all methods of the
		311	C<urxvt::term> class on this object.
		312
		313	It has the following methods and data members:
		314
		315	=over 4
		316
		317	=item $urxvt_term = $self->{term}
		318
		319	Returns the C<urxvt::term> object associated with this instance of the
		320	extension. This member I<must not> be changed in any way.
		321
		322	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		323
		324	Dynamically enable the given hooks (named without the C<on_> prefix) for
		325	this extension, replacing any previous hook. This is useful when you want
		326	to overwrite time-critical hooks only temporarily.
		327
		328	=item $self->disable ($hook_name[, $hook_name..])
		329
		330	Dynamically disable the given hooks.
		331
		332	=back
		333
124	=head2 Hooks	334	=head2 Hooks
125		335
126	The following subroutines can be declared in extension files, and will be	336	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	337	called whenever the relevant event happens.
128		338
129	The first argument passed to them is an object private to each terminal	339	The first argument passed to them is an extension oject as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	340	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		341
136	All of them must return a boolean value. If it is true, then the event	342	B<All> of these hooks must return a boolean value. If any of the called
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	343	hooks returns true, then the event counts as being I<consumed>, and the
138	and the relevant action might not be carried out by the C++ code.	344	relevant action might not be carried out by the C++ code.
139		345
140	When in doubt, return a false value (preferably C<()>).	346	I<< When in doubt, return a false value (preferably C<()>). >>
141		347
142	=over 4	348	=over 4
143		349
144	=item on_init $term	350	=item on_init $term
145		351
146	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
147	windows are created or the command gets run. Most methods are unsafe to	353	windows are created or the command gets run. Most methods are unsafe to
148	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
149	have not yet been determined. You can safely query and change resources,	355	have not yet been determined. You can safely query and change resources
150	though.	356	and options, though. For many purposes the C<on_start> hook is a better
		357	place.
		358
		359	=item on_start $term
		360
		361	Called at the very end of initialisation of a new terminal, just before
		362	trying to map (display) the toplevel and returning to the mainloop.
		363
		364	=item on_destroy $term
		365
		366	Called whenever something tries to destroy terminal, before doing anything
		367	yet. If this hook returns true, then destruction is skipped, but this is
		368	rarely a good idea.
151		369
152	=item on_reset $term	370	=item on_reset $term
153		371
154	Called after the screen is "reset" for any reason, such as resizing or	372	Called after the screen is "reset" for any reason, such as resizing or
155	control sequences. Here is where you can react on changes to size-related	373	control sequences. Here is where you can react on changes to size-related
156	variables.	374	variables.
157		375
158	=item on_start $term	376	=item on_child_start $term, $pid
159		377
160	Called at the very end of initialisation of a new terminal, just before	378	Called just after the child process has been C<fork>ed.
161	returning to the mainloop.	379
		380	=item on_child_exit $term, $status
		381
		382	Called just after the child process has exited. C<$status> is the status
		383	from C<waitpid>.
162		384
163	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
164		386
165	Called whenever a selection has been made by the user, but before the	387	Called whenever a selection has been made by the user, but before the
166	selection text is copied, so changes to the beginning, end or type of the	388	selection text is copied, so changes to the beginning, end or type of the
…		…
180	=item on_sel_extend $term	402	=item on_sel_extend $term
181		403
182	Called whenever the user tries to extend the selection (e.g. with a double	404	Called whenever the user tries to extend the selection (e.g. with a double
183	click) and is either supposed to return false (normal operation), or	405	click) and is either supposed to return false (normal operation), or
184	should extend the selection itelf and return true to suppress the built-in	406	should extend the selection itelf and return true to suppress the built-in
185	processing.	407	processing. This can happen multiple times, as long as the callback
		408	returns true, it will be called on every further click by the user and is
		409	supposed to enlarge the selection more and more, if possible.
186		410
187	See the F<selection> example extension.	411	See the F<selection> example extension.
188		412
189	=item on_view_change $term, $offset	413	=item on_view_change $term, $offset
190		414
…		…
199	than the scroll back buffer or the terminal.	423	than the scroll back buffer or the terminal.
200		424
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	425	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	426	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	427	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term *NYI*
206
207	Called whenever the program(s) running in the urxvt window send output.
208		428
209	=item on_osc_seq $term, $string	429	=item on_osc_seq $term, $string
210		430
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	432	operating system command) is processed. Cursor position and other state
…		…
225	can filter/change and output the text yourself by returning a true value	445	can filter/change and output the text yourself by returning a true value
226	and calling C<< $term->scr_add_lines >> yourself. Please note that this	446	and calling C<< $term->scr_add_lines >> yourself. Please note that this
227	might be very slow, however, as your hook is called for B<all> text being	447	might be very slow, however, as your hook is called for B<all> text being
228	output.	448	output.
229		449
		450	=item on_tt_write $term, $octets
		451
		452	Called whenever some data is written to the tty/pty and can be used to
		453	suppress or filter tty input.
		454
230	=item on_line_update $term, $row	455	=item on_line_update $term, $row
231		456
232	Called whenever a line was updated or changed. Can be used to filter	457	Called whenever a line was updated or changed. Can be used to filter
233	screen output (e.g. underline urls or other useless stuff). Only lines	458	screen output (e.g. underline urls or other useless stuff). Only lines
234	that are being shown will be filtered, and, due to performance reasons,	459	that are being shown will be filtered, and, due to performance reasons,
…		…
256		481
257	Called whenever the user presses a key combination that has a	482	Called whenever the user presses a key combination that has a
258	C<perl:string> action bound to it (see description of the B<keysym>	483	C<perl:string> action bound to it (see description of the B<keysym>
259	resource in the @@RXVT_NAME@@(1) manpage).	484	resource in the @@RXVT_NAME@@(1) manpage).
260		485
		486	=item on_x_event $term, $event
		487
		488	Called on every X event received on the vt window (and possibly other
		489	windows). Should only be used as a last resort. Most event structure
		490	members are not passed.
		491
261	=item on_focus_in $term	492	=item on_focus_in $term
262		493
263	Called whenever the window gets the keyboard focus, before rxvt-unicode	494	Called whenever the window gets the keyboard focus, before rxvt-unicode
264	does focus in processing.	495	does focus in processing.
265		496
266	=item on_focus_out $term	497	=item on_focus_out $term
267		498
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	500	focus out processing.
270		501
		502	=item on_configure_notify $term, $event
		503
		504	=item on_property_notify $term, $event
		505
271	=item on_key_press $term, $event, $octets	506	=item on_key_press $term, $event, $keysym, $octets
272		507
273	=item on_key_release $term, $event	508	=item on_key_release $term, $event, $keysym
274		509
275	=item on_button_press $term, $event	510	=item on_button_press $term, $event
276		511
277	=item on_button_release $term, $event	512	=item on_button_release $term, $event
278		513
…		…
284		519
285	Called whenever the corresponding X event is received for the terminal If	520	Called whenever the corresponding X event is received for the terminal If
286	the hook returns true, then the even will be ignored by rxvt-unicode.	521	the hook returns true, then the even will be ignored by rxvt-unicode.
287		522
288	The event is a hash with most values as named by Xlib (see the XEvent	523	The event is a hash with most values as named by Xlib (see the XEvent
289	manpage), with the additional members C<row> and C<col>, which are the row	524	manpage), with the additional members C<row> and C<col>, which are the
290	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
291		526
292	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
293	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
294		529
295	subwindow.	530	subwindow.
296		531
		532	=item on_client_message $term, $event
		533
		534	=item on_wm_protocols $term, $event
		535
		536	=item on_wm_delete_window $term, $event
		537
		538	Called when various types of ClientMessage events are received (all with
		539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		540
297	=back	541	=back
298		542
		543	=cut
		544
		545	package urxvt;
		546
		547	use utf8;
		548	use strict;
		549	use Carp ();
		550	use Scalar::Util ();
		551	use List::Util ();
		552
		553	our $VERSION = 1;
		554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
		557	our @HOOKNAME;
		558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		559	our %OPTION;
		560
		561	our $LIBDIR;
		562	our $RESNAME;
		563	our $RESCLASS;
		564	our $RXVTNAME;
		565
		566	our $NOCHAR = chr 0xfffe;
		567
299	=head2 Variables in the C<urxvt> Package	568	=head2 Variables in the C<urxvt> Package
300		569
301	=over 4	570	=over 4
		571
		572	=item $urxvt::LIBDIR
		573
		574	The rxvt-unicode library directory, where, among other things, the perl
		575	modules and scripts are stored.
		576
		577	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		578
		579	The resource class and name rxvt-unicode uses to look up X resources.
		580
		581	=item $urxvt::RXVTNAME
		582
		583	The basename of the installed binaries, usually C<urxvt>.
302		584
303	=item $urxvt::TERM	585	=item $urxvt::TERM
304		586
305	The current terminal. This variable stores the current C<urxvt::term>	587	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	588	object, whenever a callback/hook is executing.
307		589
		590	=item @urxvt::TERM_INIT
		591
		592	All coderefs in this array will be called as methods of the next newly
		593	created C<urxvt::term> object (during the C<on_init> phase). The array
		594	gets cleared before the codereferences that were in it are being executed,
		595	so coderefs can push themselves onto it again if they so desire.
		596
		597	This complements to the perl-eval commandline option, but gets executed
		598	first.
		599
		600	=item @urxvt::TERM_EXT
		601
		602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		603	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		604	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		605
308	=back	606	=back
309		607
310	=head2 Functions in the C<urxvt> Package	608	=head2 Functions in the C<urxvt> Package
311		609
312	=over 4	610	=over 4
313
314	=item $term = new urxvt [arg...]
315
316	Creates a new terminal, very similar as if you had started it with
317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318	if the new instance couldn't be created. Returns C<undef> if the new
319	instance didn't initialise perl, and the terminal object otherwise. The
320	C<init> and C<start> hooks will be called during the call.
321		611
322	=item urxvt::fatal $errormessage	612	=item urxvt::fatal $errormessage
323		613
324	Fatally aborts execution with the given error message. Avoid at all	614	Fatally aborts execution with the given error message. Avoid at all
325	costs! The only time this is acceptable is when the terminal process	615	costs! The only time this is acceptable is when the terminal process
…		…
332	that calls this function.	622	that calls this function.
333		623
334	Using this function has the advantage that its output ends up in the	624	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	625	correct place, e.g. on stderr of the connecting urxvtc client.
336		626
		627	Messages have a size limit of 1023 bytes currently.
		628
337	=item $time = urxvt::NOW	629	=item $time = urxvt::NOW
338		630
339	Returns the "current time" (as per the event loop).	631	Returns the "current time" (as per the event loop).
340		632
341	=item urxvt::CurrentTime	633	=item urxvt::CurrentTime
342		634
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	635	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	636	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	637	Button4Mask, Button5Mask, AnyModifier
		638
		639	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		640	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		641	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		642	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		643	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		644	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		645	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		646
		647	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		648	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		649	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		650	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		651	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		652	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		653	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
346		654
347	Various constants for use in X calls and event processing.	655	Various constants for use in X calls and event processing.
348		656
349	=back	657	=back
350		658
…		…
379		687
380	=item $background = urxvt::GET_BASEBG $rend	688	=item $background = urxvt::GET_BASEBG $rend
381		689
382	Return the foreground/background colour index, respectively.	690	Return the foreground/background colour index, respectively.
383		691
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		693
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		695
388	Replace the foreground/background colour in the rendition mask with the	696	Replace the foreground/background colour in the rendition mask with the
389	specified one.	697	specified one.
390		698
391	=item $value = urxvt::GET_CUSTOM ($rend)	699	=item $value = urxvt::GET_CUSTOM $rend
392		700
393	Return the "custom" value: Every rendition has 5 bits for use by	701	Return the "custom" value: Every rendition has 5 bits for use by
394	extensions. They can be set and changed as you like and are initially	702	extensions. They can be set and changed as you like and are initially
395	zero.	703	zero.
396		704
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	705	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		706
399	Change the custom value.	707	Change the custom value.
400		708
401	=back	709	=back
402		710
403	=cut	711	=cut
404		712
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $VERSION = 1;
413	our $TERM;
414	our @HOOKNAME;
415	our %OPTION;
416	our $LIBDIR;
417
418	BEGIN {	713	BEGIN {
419	urxvt->bootstrap;
420
421	# overwrite perl's warn	714	# overwrite perl's warn
422	*CORE::GLOBAL::warn = sub {	715	*CORE::GLOBAL::warn = sub {
423	my $msg = join "", @_;	716	my $msg = join "", @_;
424	$msg .= "\n"	717	$msg .= "\n"
425	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	719	urxvt::warn ($msg);
427	};	720	};
428	}	721	}
429		722
430	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		724
433	sub verbose {	725	sub verbose {
434	my ($level, $msg) = @_;	726	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	727	warn "$msg\n" if $level <= $verbosity;
436	}	728	}
437		729
438	# find on_xxx subs in the package and register them
439	# as hooks
440	sub register_package($) {
441	my ($pkg) = @_;
442
443	for my $htype (0.. $#HOOKNAME) {
444	my $name = $HOOKNAME[$htype];
445
446	my $ref = $pkg->can ("on_" . lc $name)
447	or next;
448
449	$TERM->{_hook}[$htype]{$pkg} = $ref;
450	$hook_count[$htype]++
451	or set_should_invoke $htype, 1;
452	}
453	}
454
455	my $extension_pkg = "extension0000";
456	my %extension_pkg;	730	my %extension_pkg;
457		731
458	# load a single script into its own package, once only	732	# load a single script into its own package, once only
459	sub extension_package($) {	733	sub extension_package($) {
460	my ($path) = @_;	734	my ($path) = @_;
461		735
462	$extension_pkg{$path} ||= do {	736	$extension_pkg{$path} ||= do {
463	my $pkg = "urxvt::" . ($extension_pkg++);	737	$path =~ /([^\/\\]+)$/;
		738	my $pkg = $1;
		739	$pkg =~ s/[^[:word:]]/_/g;
		740	$pkg = "urxvt::ext::$pkg";
464		741
465	verbose 3, "loading extension '$path' into package '$pkg'";	742	verbose 3, "loading extension '$path' into package '$pkg'";
466		743
467	open my $fh, "<:raw", $path	744	open my $fh, "<:raw", $path
468	or die "$path: $!";	745	or die "$path: $!";
469		746
		747	my $source =
470	my $source = "package $pkg; use strict; use utf8;\n"	748	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"
472	. "#line 1 \"$path\"\n{\n"	749	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	750	. (do { local $/; <$fh> })
474	. "\n};\n1";	751	. "\n};\n1";
475		752
476	$source =~ /(.*)/s and $source = $1; # untaint	753	eval $source
477
478	eval $source or die "$path: $@";	754	or die "$path: $@";
479		755
480	$pkg	756	$pkg
481	}	757	}
482	}	758	}
483		759
…		…
489	my $htype = shift;	765	my $htype = shift;
490		766
491	if ($htype == 0) { # INIT	767	if ($htype == 0) { # INIT
492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493		769
494	my %want_ext;	770	my %ext_arg;
495		771
		772	{
		773	my @init = @TERM_INIT;
		774	@TERM_INIT = ();
		775	$_->($TERM) for @init;
		776	my @pkg = @TERM_EXT;
		777	@TERM_EXT = ();
		778	$TERM->register_package ($_) for @pkg;
		779	}
		780
496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497	if ($_ eq "default") {	782	if ($_ eq "default") {
498	$want_ext{$_}++ for qw(selection option-popup);	783	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
499	} elsif (/^-(.*)$/) {	784	} elsif (/^-(.*)$/) {
500	delete $want_ext{$1};	785	delete $ext_arg{$1};
		786	} elsif (/^([^<]+)<(.*)>$/) {
		787	push @{ $ext_arg{$1} }, $2;
501	} else {	788	} else {
502	$want_ext{$_}++;	789	$ext_arg{$_} ||= [];
503	}	790	}
504	}	791	}
505		792
506	for my $ext (keys %want_ext) {	793	while (my ($ext, $argv) = each %ext_arg) {
507	my @files = grep -f $_, map "$_/$ext", @dirs;	794	my @files = grep -f $_, map "$_/$ext", @dirs;
508		795
509	if (@files) {	796	if (@files) {
510	register_package extension_package $files[0];	797	$TERM->register_package (extension_package $files[0], $argv);
511	} else {	798	} else {
512	warn "perl extension '$ext' not found in perl library search path\n";	799	warn "perl extension '$ext' not found in perl library search path\n";
513	}	800	}
514	}	801	}
515		802
…		…
524	if $verbosity >= 10;	811	if $verbosity >= 10;
525		812
526	keys %$cb;	813	keys %$cb;
527		814
528	while (my ($pkg, $cb) = each %$cb) {	815	while (my ($pkg, $cb) = each %$cb) {
529	eval {	816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
530	$retval = $cb->(	817	$retval ||= $retval_;
531	$TERM->{_pkg}{$pkg} ||= do {
532	my $proxy = bless { }, $pkg;
533	Scalar::Util::weaken ($proxy->{term} = $TERM);
534	$proxy
535	},
536	@_,
537	) and last;
538	};
539	warn $@ if $@;#d#
540	}
541	}
542		818
543	if ($htype == 1) { # DESTROY	819	if ($@) {
544	# remove hooks if unused	820	$TERM->ungrab; # better to lose the grab than the session
545	if (my $hook = $TERM->{_hook}) {	821	warn $@;
546	for my $htype (0..$#$hook) {
547	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
548	or set_should_invoke $htype, 0;
549	}	822	}
550	}	823	}
551		824
		825	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		826	if $verbosity >= 11;
		827	}
		828
		829	if ($htype == 1) { # DESTROY
552	# clear package objects	830	# clear package objects
553	%$_ = () for values %{ $TERM->{_pkg} };	831	%$_ = () for values %{ $TERM->{_pkg} };
554		832
555	# clear package	833	# clear package
556	%$TERM = ();	834	%$TERM = ();
557	}	835	}
558		836
559	$retval	837	$retval
560	}	838	}
561		839
562	# urxvt::term::proxy	840	# urxvt::term::extension
563		841
564	sub urxvt::term::proxy::AUTOLOAD {	842	package urxvt::term::extension;
565	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	our $AUTOLOAD;
		875
		876	sub AUTOLOAD {
		877	$AUTOLOAD =~ /:([^:]+)$/
566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	878	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
567		879
568	eval qq{	880	eval qq{
569	sub $urxvt::term::proxy::AUTOLOAD {	881	sub $AUTOLOAD {
570	my \$proxy = shift;	882	my \$proxy = shift;
571	\$proxy->{term}->$1 (\@_)	883	\$proxy->{term}->$1 (\@_)
572	}	884	}
573	1	885	1
574	} or die "FATAL: unable to compile method forwarder: $@";	886	} or die "FATAL: unable to compile method forwarder: $@";
575		887
576	goto &$urxvt::term::proxy::AUTOLOAD;	888	goto &$AUTOLOAD;
		889	}
		890
		891	sub DESTROY {
		892	# nop
577	}	893	}
578		894
579	# urxvt::destroy_hook	895	# urxvt::destroy_hook
580		896
581	sub urxvt::destroy_hook::DESTROY {	897	sub urxvt::destroy_hook::DESTROY {
…		…
590		906
591	=head2 The C<urxvt::anyevent> Class	907	=head2 The C<urxvt::anyevent> Class
592		908
593	The sole purpose of this class is to deliver an interface to the	909	The sole purpose of this class is to deliver an interface to the
594	C<AnyEvent> module - any module using it will work inside urxvt without	910	C<AnyEvent> module - any module using it will work inside urxvt without
595	further work. The only exception is that you cannot wait on condition	911	further programming. The only exception is that you cannot wait on
596	variables, but non-blocking condvar use is ok. What this means is that you	912	condition variables, but non-blocking condvar use is ok. What this means
597	cannot use blocking APIs, but the non-blocking variant should work.	913	is that you cannot use blocking APIs, but the non-blocking variant should
		914	work.
598		915
599	=cut	916	=cut
600		917
601	our $VERSION = 1;	918	our $VERSION = 1;
602		919
…		…
647	${$_[0]}++;	964	${$_[0]}++;
648	}	965	}
649		966
650	sub urxvt::anyevent::condvar::wait {	967	sub urxvt::anyevent::condvar::wait {
651	unless (${$_[0]}) {	968	unless (${$_[0]}) {
652	require Carp;
653	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	969	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
654	}	970	}
655	}	971	}
656		972
657	package urxvt::term;	973	package urxvt::term;
658		974
659	=head2 The C<urxvt::term> Class	975	=head2 The C<urxvt::term> Class
660		976
661	=over 4	977	=over 4
662		978
		979	=cut
		980
		981	# find on_xxx subs in the package and register them
		982	# as hooks
		983	sub register_package {
		984	my ($self, $pkg, $argv) = @_;
		985
		986	no strict 'refs';
		987
		988	urxvt::verbose 6, "register package $pkg to $self";
		989
		990	@{"$pkg\::ISA"} = urxvt::term::extension::;
		991
		992	my $proxy = bless {
		993	_pkg => $pkg,
		994	argv => $argv,
		995	}, $pkg;
		996	Scalar::Util::weaken ($proxy->{term} = $self);
		997
		998	$self->{_pkg}{$pkg} = $proxy;
		999
		1000	for my $name (@HOOKNAME) {
		1001	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1002	$proxy->enable ($name => $ref);
		1003	}
		1004	}
		1005	}
		1006
		1007	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1008
		1009	Creates a new terminal, very similar as if you had started it with system
		1010	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1011	hash which defines the environment of the new terminal.
		1012
		1013	Croaks (and probably outputs an error message) if the new instance
		1014	couldn't be created. Returns C<undef> if the new instance didn't
		1015	initialise perl, and the terminal object otherwise. The C<init> and
		1016	C<start> hooks will be called during this call.
		1017
		1018	=cut
		1019
		1020	sub new {
		1021	my ($class, $env, @args) = @_;
		1022
		1023	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1024	}
		1025
663	=item $term->destroy	1026	=item $term->destroy
664		1027
665	Destroy the terminal object (close the window, free resources etc.).	1028	Destroy the terminal object (close the window, free resources
		1029	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1030	watchers (timers, io watchers) are still active.
		1031
		1032	=item $term->exec_async ($cmd[, @args])
		1033
		1034	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1035	("starts") programs in the background. This function takes care of setting
		1036	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1037	be preferred over explicit calls to C<exec> or C<system>.
		1038
		1039	Returns the pid of the subprocess or C<undef> on error.
		1040
		1041	=cut
		1042
		1043	sub exec_async {
		1044	my $self = shift;
		1045
		1046	my $pid = fork;
		1047
		1048	return $pid
		1049	if !defined $pid or $pid;
		1050
		1051	%ENV = %{ $self->env };
		1052
		1053	exec @_;
		1054	urxvt::_exit 255;
		1055	}
666		1056
667	=item $isset = $term->option ($optval[, $set])	1057	=item $isset = $term->option ($optval[, $set])
668		1058
669	Returns true if the option specified by C<$optval> is enabled, and	1059	Returns true if the option specified by C<$optval> is enabled, and
670	optionally change it. All option values are stored by name in the hash	1060	optionally change it. All option values are stored by name in the hash
…		…
673	Here is a a likely non-exhaustive list of option names, please see the	1063	Here is a a likely non-exhaustive list of option names, please see the
674	source file F</src/optinc.h> to see the actual list:	1064	source file F</src/optinc.h> to see the actual list:
675		1065
676	borderLess console cursorBlink cursorUnderline hold iconic insecure	1066	borderLess console cursorBlink cursorUnderline hold iconic insecure
677	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
678	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
679	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
680	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
681	tripleclickwords utmpInhibit visualBell	1071	transparent tripleclickwords utmpInhibit visualBell
682		1072
683	=item $value = $term->resource ($name[, $newval])	1073	=item $value = $term->resource ($name[, $newval])
684		1074
685	Returns the current resource value associated with a given name and	1075	Returns the current resource value associated with a given name and
686	optionally sets a new value. Setting values is most useful in the C<init>	1076	optionally sets a new value. Setting values is most useful in the C<init>
…		…
703		1093
704	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
705	borderLess color cursorBlink cursorUnderline cutchars delete_key	1095	borderLess color cursorBlink cursorUnderline cutchars delete_key
706	display_name embed ext_bwidth fade font geometry hold iconName	1096	display_name embed ext_bwidth fade font geometry hold iconName
707	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1097	imFont imLocale inputMethod insecure int_bwidth intensityStyles
708	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
709	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
710	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
711	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
712	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
713	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
714	shade term_name title transparent transparent_all tripleclickwords	1104	secondaryScreen secondaryScroll selectstyle shade term_name title
715	utmpInhibit visualBell	1105	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1106	visualBell
716		1107
717	=cut	1108	=cut
718		1109
719	sub resource($$;$) {	1110	sub resource($$;$) {
720	my ($self, $name) = (shift, shift);	1111	my ($self, $name) = (shift, shift);
721	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1112	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
722	&urxvt::term::_resource	1113	&urxvt::term::_resource
723	}	1114	}
724		1115
		1116	=item $value = $term->x_resource ($pattern)
		1117
		1118	Returns the X-Resource for the given pattern, excluding the program or
		1119	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1120	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1121	resource with that pattern exists.
		1122
		1123	This method should only be called during the C<on_start> hook, as there is
		1124	only one resource database per display, and later invocations might return
		1125	the wrong resources.
		1126
		1127	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1128
		1129	Adds a keymap translation exactly as specified via a resource. See the
		1130	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1131
725	=item $rend = $term->rstyle ([$new_rstyle])	1132	=item $rend = $term->rstyle ([$new_rstyle])
726		1133
727	Return and optionally change the current rendition. Text that is output by	1134	Return and optionally change the current rendition. Text that is output by
728	the terminal application will use this style.	1135	the terminal application will use this style.
729		1136
…		…
739	=item ($row, $col) = $term->selection_end ([$row, $col])	1146	=item ($row, $col) = $term->selection_end ([$row, $col])
740		1147
741	Return the current values of the selection mark, begin or end positions,	1148	Return the current values of the selection mark, begin or end positions,
742	and optionally set them to new values.	1149	and optionally set them to new values.
743		1150
		1151	=item $term->selection_make ($eventtime[, $rectangular])
		1152
		1153	Tries to make a selection as set by C<selection_beg> and
		1154	C<selection_end>. If C<$rectangular> is true (default: false), a
		1155	rectangular selection will be made. This is the prefered function to make
		1156	a selection.
		1157
744	=item $success = $term->selection_grab ($eventtime)	1158	=item $success = $term->selection_grab ($eventtime)
745		1159
746	Try to request the primary selection from the server (for example, as set	1160	Try to request the primary selection text from the server (for example, as
747	by the next method).	1161	set by the next method). No visual feedback will be given. This function
		1162	is mostly useful from within C<on_sel_grab> hooks.
748		1163
749	=item $oldtext = $term->selection ([$newtext])	1164	=item $oldtext = $term->selection ([$newtext])
750		1165
751	Return the current selection text and optionally replace it by C<$newtext>.	1166	Return the current selection text and optionally replace it by C<$newtext>.
752		1167
753	#=item $term->overlay ($x, $y, $text)	1168	=item $term->overlay_simple ($x, $y, $text)
754	#	1169
755	#Create a simple multi-line overlay box. See the next method for details.	1170	Create a simple multi-line overlay box. See the next method for details.
756	#	1171
757	#=cut	1172	=cut
758	#	1173
759	#sub urxvt::term::scr_overlay {	1174	sub overlay_simple {
760	# my ($self, $x, $y, $text) = @_;	1175	my ($self, $x, $y, $text) = @_;
761	#	1176
762	# my @lines = split /\n/, $text;	1177	my @lines = split /\n/, $text;
763	#	1178
764	# my $w = 0;	1179	my $w = List::Util::max map $self->strwidth ($_), @lines;
765	# for (map $self->strwidth ($_), @lines) {	1180
766	# $w = $_ if $w < $_;
767	# }
768	#
769	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1181	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
770	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1182	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
771	#}	1183
		1184	$overlay
		1185	}
772		1186
773	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1187	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
774		1188
775	Create a new (empty) overlay at the given position with the given	1189	Create a new (empty) overlay at the given position with the given
776	width/height. C<$rstyle> defines the initial rendition style	1190	width/height. C<$rstyle> defines the initial rendition style
…		…
843		1257
844	=item $string = $term->locale_decode ($octets)	1258	=item $string = $term->locale_decode ($octets)
845		1259
846	Convert the given locale-encoded octets into a perl string.	1260	Convert the given locale-encoded octets into a perl string.
847		1261
		1262	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1263
		1264	XORs the rendition values in the given span with the provided value
		1265	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1266	refresh hooks to provide effects similar to the selection.
		1267
		1268	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1269
		1270	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1271	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1272	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1273	it instead. Both styles I<MUST NOT> contain font styles.
		1274
		1275	=item $term->scr_bell
		1276
		1277	Ring the bell!
		1278
848	=item $term->scr_add_lines ($string)	1279	=item $term->scr_add_lines ($string)
849		1280
850	Write the given text string to the screen, as if output by the application	1281	Write the given text string to the screen, as if output by the application
851	running inside the terminal. It may not contain command sequences (escape	1282	running inside the terminal. It may not contain command sequences (escape
852	codes), but is free to use line feeds, carriage returns and tabs. The	1283	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
854		1285
855	Normally its not a good idea to use this function, as programs might be	1286	Normally its not a good idea to use this function, as programs might be
856	confused by changes in cursor position or scrolling. Its useful inside a	1287	confused by changes in cursor position or scrolling. Its useful inside a
857	C<on_add_lines> hook, though.	1288	C<on_add_lines> hook, though.
858		1289
		1290	=item $term->scr_change_screen ($screen)
		1291
		1292	Switch to given screen - 0 primary, 1 secondary.
		1293
859	=item $term->cmd_parse ($octets)	1294	=item $term->cmd_parse ($octets)
860		1295
861	Similar to C<scr_add_lines>, but the argument must be in the	1296	Similar to C<scr_add_lines>, but the argument must be in the
862	locale-specific encoding of the terminal and can contain command sequences	1297	locale-specific encoding of the terminal and can contain command sequences
863	(escape codes) that will be interpreted.	1298	(escape codes) that will be interpreted.
…		…
866		1301
867	Write the octets given in C<$data> to the tty (i.e. as program input). To	1302	Write the octets given in C<$data> to the tty (i.e. as program input). To
868	pass characters instead of octets, you should convert your strings first	1303	pass characters instead of octets, you should convert your strings first
869	to the locale-specific encoding using C<< $term->locale_encode >>.	1304	to the locale-specific encoding using C<< $term->locale_encode >>.
870		1305
		1306	=item $old_events = $term->pty_ev_events ([$new_events])
		1307
		1308	Replaces the event mask of the pty watcher by the given event mask. Can
		1309	be used to suppress input and output handling to the pty/tty. See the
		1310	description of C<< urxvt::timer->events >>. Make sure to always restore
		1311	the previous value.
		1312
871	=item $windowid = $term->parent	1313	=item $windowid = $term->parent
872		1314
873	Return the window id of the toplevel window.	1315	Return the window id of the toplevel window.
874		1316
875	=item $windowid = $term->vt	1317	=item $windowid = $term->vt
876		1318
877	Return the window id of the terminal window.	1319	Return the window id of the terminal window.
878		1320
		1321	=item $term->vt_emask_add ($x_event_mask)
		1322
		1323	Adds the specified events to the vt event mask. Useful e.g. when you want
		1324	to receive pointer events all the times:
		1325
		1326	$term->vt_emask_add (urxvt::PointerMotionMask);
		1327
879	=item $window_width = $term->width	1328	=item $window_width = $term->width
880		1329
881	=item $window_height = $term->height	1330	=item $window_height = $term->height
882		1331
883	=item $font_width = $term->fwidth	1332	=item $font_width = $term->fwidth
…		…
896		1345
897	=item $max_scrollback = $term->saveLines	1346	=item $max_scrollback = $term->saveLines
898		1347
899	=item $nrow_plus_saveLines = $term->total_rows	1348	=item $nrow_plus_saveLines = $term->total_rows
900		1349
901	=item $lines_in_scrollback = $term->nsaved	1350	=item $topmost_scrollback_row = $term->top_row
902		1351
903	Return various integers describing terminal characteristics.	1352	Return various integers describing terminal characteristics.
		1353
		1354	=item $x_display = $term->display_id
		1355
		1356	Return the DISPLAY used by rxvt-unicode.
		1357
		1358	=item $lc_ctype = $term->locale
		1359
		1360	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1361
		1362	=item $env = $term->env
		1363
		1364	Returns a copy of the environment in effect for the terminal as a hashref
		1365	similar to C<\%ENV>.
		1366
		1367	=cut
		1368
		1369	sub env {
		1370	if (my $env = $_[0]->_env) {
		1371	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1372	} else {
		1373	+{ %ENV }
		1374	}
		1375	}
904		1376
905	=item $modifiermask = $term->ModLevel3Mask	1377	=item $modifiermask = $term->ModLevel3Mask
906		1378
907	=item $modifiermask = $term->ModMetaMask	1379	=item $modifiermask = $term->ModMetaMask
908		1380
909	=item $modifiermask = $term->ModNumLockMask	1381	=item $modifiermask = $term->ModNumLockMask
910		1382
911	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1383	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
912	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1384	AltGr), the meta key (often Alt) and the num lock key, if applicable.
913		1385
		1386	=item $screen = $term->current_screen
		1387
		1388	Returns the currently displayed screen (0 primary, 1 secondary).
		1389
		1390	=item $cursor_is_hidden = $term->hidden_cursor
		1391
		1392	Returns wether the cursor is currently hidden or not.
		1393
914	=item $view_start = $term->view_start ([$newvalue])	1394	=item $view_start = $term->view_start ([$newvalue])
915		1395
916	Returns the negative row number of the topmost line. Minimum value is	1396	Returns the row number of the topmost displayed line. Maximum value is
917	C<0>, which displays the normal terminal contents. Larger values scroll	1397	C<0>, which displays the normal terminal contents. Lower values scroll
918	this many lines into the scrollback buffer.	1398	this many lines into the scrollback buffer.
919		1399
920	=item $term->want_refresh	1400	=item $term->want_refresh
921		1401
922	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1402	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
936	If C<$new_text> is specified, it will replace characters in the current	1416	If C<$new_text> is specified, it will replace characters in the current
937	line, starting at column C<$start_col> (default C<0>), which is useful	1417	line, starting at column C<$start_col> (default C<0>), which is useful
938	to replace only parts of a line. The font index in the rendition will	1418	to replace only parts of a line. The font index in the rendition will
939	automatically be updated.	1419	automatically be updated.
940		1420
941	C<$text> is in a special encoding: tabs and wide characters that use more	1421	C<$text> is in a special encoding: tabs and wide characters that use
942	than one cell when displayed are padded with urxvt::NOCHAR characters	1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
943	(C<chr 65535>). Characters with combining characters and other characters	1423	characters. Characters with combining characters and other characters that
944	that do not fit into the normal tetx encoding will be replaced with	1424	do not fit into the normal tetx encoding will be replaced with characters
945	characters in the private use area.	1425	in the private use area.
946		1426
947	You have to obey this encoding when changing text. The advantage is	1427	You have to obey this encoding when changing text. The advantage is
948	that C<substr> and similar functions work on screen cells and not on	1428	that C<substr> and similar functions work on screen cells and not on
949	characters.	1429	characters.
950		1430
…		…
1001	Return the row number of the first/last row of the line, respectively.	1481	Return the row number of the first/last row of the line, respectively.
1002		1482
1003	=item $offset = $line->offset_of ($row, $col)	1483	=item $offset = $line->offset_of ($row, $col)
1004		1484
1005	Returns the character offset of the given row|col pair within the logical	1485	Returns the character offset of the given row|col pair within the logical
1006	line.	1486	line. Works for rows outside the line, too, and returns corresponding
		1487	offsets outside the string.
1007		1488
1008	=item ($row, $col) = $line->coord_of ($offset)	1489	=item ($row, $col) = $line->coord_of ($offset)
1009		1490
1010	Translates a string offset into terminal coordinates again.	1491	Translates a string offset into terminal coordinates again.
1011		1492
…		…
1085	$offset / $self->{ncol} + $self->{beg},	1566	$offset / $self->{ncol} + $self->{beg},
1086	$offset % $self->{ncol}	1567	$offset % $self->{ncol}
1087	)	1568	)
1088	}	1569	}
1089		1570
1090	=item ($row, $col) = $line->coord_of ($offset)
1091	=item $text = $term->special_encode $string	1571	=item $text = $term->special_encode $string
1092		1572
1093	Converts a perl string into the special encoding used by rxvt-unicode,	1573	Converts a perl string into the special encoding used by rxvt-unicode,
1094	where one character corresponds to one screen cell. See	1574	where one character corresponds to one screen cell. See
1095	C<< $term->ROW_t >> for details.	1575	C<< $term->ROW_t >> for details.
…		…
1097	=item $string = $term->special_decode $text	1577	=item $string = $term->special_decode $text
1098		1578
1099	Converts rxvt-unicodes text reprsentation into a perl string. See	1579	Converts rxvt-unicodes text reprsentation into a perl string. See
1100	C<< $term->ROW_t >> for details.	1580	C<< $term->ROW_t >> for details.
1101		1581
		1582	=item $success = $term->grab_button ($button, $modifiermask)
		1583
		1584	Registers a synchronous button grab. See the XGrabButton manpage.
		1585
		1586	=item $success = $term->grab ($eventtime[, $sync])
		1587
		1588	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1589	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1590
		1591	=item $term->allow_events_async
		1592
		1593	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1594
		1595	=item $term->allow_events_sync
		1596
		1597	Calls XAllowEvents with SyncBoth for the most recent grab.
		1598
		1599	=item $term->allow_events_replay
		1600
		1601	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1602	recent grab.
		1603
		1604	=item $term->ungrab
		1605
		1606	Calls XUngrab for the most recent grab. Is called automatically on
		1607	evaluation errors, as it is better to lose the grab in the error case as
		1608	the session.
		1609
		1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1611
		1612	=item $atom_name = $term->XGetAtomName ($atom)
		1613
		1614	=item @atoms = $term->XListProperties ($window)
		1615
		1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1617
		1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1619
		1620	=item $term->XDeleteProperty ($window, $property)
		1621
		1622	=item $window = $term->DefaultRootWindow
		1623
		1624	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1625
		1626	=item $term->XMapWindow ($window)
		1627
		1628	=item $term->XUnmapWindow ($window)
		1629
		1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1631
		1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1633
		1634	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1635
		1636	Various X or X-related functions. The C<$term> object only serves as
		1637	the source of the display, otherwise those functions map more-or-less
		1638	directory onto the X functions of the same name.
		1639
1102	=back	1640	=back
1103		1641
1104	=cut	1642	=cut
1105		1643
1106	package urxvt::popup;	1644	package urxvt::popup;
…		…
1121	$item->{render} ||= sub { $_[0]{text} };	1659	$item->{render} ||= sub { $_[0]{text} };
1122		1660
1123	push @{ $self->{item} }, $item;	1661	push @{ $self->{item} }, $item;
1124	}	1662	}
1125		1663
1126	sub add_separator {	1664	=item $popup->add_title ($title)
1127	my ($self, $sep) = @_;
1128		1665
1129	$sep ||= "═";	1666	Adds a non-clickable title to the popup.
1130		1667
1131	$self->add_item ({	1668	=cut
1132	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1133	text => "",
1134	render => sub { $sep x $urxvt::TERM->ncol },
1135	activate => sub { },
1136	});
1137	}
1138		1669
1139	sub add_title {	1670	sub add_title {
1140	my ($self, $title) = @_;	1671	my ($self, $title) = @_;
1141		1672
1142	$self->add_item ({	1673	$self->add_item ({
…		…
1144	text => $title,	1675	text => $title,
1145	activate => sub { },	1676	activate => sub { },
1146	});	1677	});
1147	}	1678	}
1148		1679
		1680	=item $popup->add_separator ([$sepchr])
		1681
		1682	Creates a separator, optionally using the character given as C<$sepchr>.
		1683
		1684	=cut
		1685
		1686	sub add_separator {
		1687	my ($self, $sep) = @_;
		1688
		1689	$sep ||= "=";
		1690
		1691	$self->add_item ({
		1692	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1693	text => "",
		1694	render => sub { $sep x $self->{term}->ncol },
		1695	activate => sub { },
		1696	});
		1697	}
		1698
		1699	=item $popup->add_button ($text, $cb)
		1700
		1701	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1702	selected.
		1703
		1704	=cut
		1705
1149	sub add_button {	1706	sub add_button {
1150	my ($self, $text, $cb) = @_;	1707	my ($self, $text, $cb) = @_;
1151		1708
1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1709	$self->add_item ({ type => "button", text => $text, activate => $cb});
1153	}	1710	}
		1711
		1712	=item $popup->add_toggle ($text, $cb, $initial_value)
		1713
		1714	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1715	whenever it gets toggled, with a boolean indicating its value as its first
		1716	argument.
		1717
		1718	=cut
1154		1719
1155	sub add_toggle {	1720	sub add_toggle {
1156	my ($self, $text, $cb, $value) = @_;	1721	my ($self, $text, $cb, $value) = @_;
1157		1722
1158	my $item; $item = {	1723	my $item; $item = {
1159	type => "button",	1724	type => "button",
1160	text => " $text",	1725	text => " $text",
1161	value => $value,	1726	value => $value,
1162	render => sub { ($item->{value} ? "* " : " ") . $text },	1727	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1163	activate => sub { $cb->($item->{value} = !$item->{value}); },	1728	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1164	};	1729	};
1165		1730
1166	$self->add_item ($item);	1731	$self->add_item ($item);
1167	}	1732	}
		1733
		1734	=item $popup->show
		1735
		1736	Displays the popup (which is initially hidden).
		1737
		1738	=cut
1168		1739
1169	sub show {	1740	sub show {
1170	my ($self) = @_;	1741	my ($self) = @_;
1171		1742
1172	local $urxvt::popup::self = $self;	1743	local $urxvt::popup::self = $self;
1173		1744
1174	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1745	my $env = $self->{term}->env;
		1746	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1747	delete $env->{LC_ALL};
		1748	$env->{LC_CTYPE} = $self->{term}->locale;
		1749
		1750	urxvt::term->new ($env, "popup",
		1751	"--perl-lib" => "", "--perl-ext-common" => "",
		1752	"-pty-fd" => -1, "-sl" => 0,
		1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1175	"--transient-for" => $self->{term}->parent,	1754	"--transient-for" => $self->{term}->parent,
		1755	"-display" => $self->{term}->display_id,
1176	"-pe" => "urxvt-popup")	1756	"-pe" => "urxvt-popup")
1177	or die "unable to create popup window\n";	1757	or die "unable to create popup window\n";
1178	}	1758	}
1179		1759
1180	sub DESTROY {	1760	sub DESTROY {
1181	my ($self) = @_;	1761	my ($self) = @_;
1182		1762
		1763	delete $self->{term}{_destroy}{$self};
1183	$self->{term}->ungrab;	1764	$self->{term}->ungrab;
1184	}	1765	}
		1766
		1767	=back
		1768
		1769	=cut
		1770
		1771	package urxvt::watcher;
		1772
		1773	@urxvt::timer::ISA = __PACKAGE__;
		1774	@urxvt::iow::ISA = __PACKAGE__;
		1775	@urxvt::pw::ISA = __PACKAGE__;
		1776	@urxvt::iw::ISA = __PACKAGE__;
1185		1777
1186	=head2 The C<urxvt::timer> Class	1778	=head2 The C<urxvt::timer> Class
1187		1779
1188	This class implements timer watchers/events. Time is represented as a	1780	This class implements timer watchers/events. Time is represented as a
1189	fractional number of seconds since the epoch. Example:	1781	fractional number of seconds since the epoch. Example:
…		…
1228		1820
1229	=item $timer = $timer->start ($tstamp)	1821	=item $timer = $timer->start ($tstamp)
1230		1822
1231	Set the event trigger time to C<$tstamp> and start the timer.	1823	Set the event trigger time to C<$tstamp> and start the timer.
1232		1824
		1825	=item $timer = $timer->after ($delay)
		1826
		1827	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1828
1233	=item $timer = $timer->stop	1829	=item $timer = $timer->stop
1234		1830
1235	Stop the timer.	1831	Stop the timer.
1236		1832
1237	=back	1833	=back
…		…
1242		1838
1243	$term->{socket} = ...	1839	$term->{socket} = ...
1244	$term->{iow} = urxvt::iow	1840	$term->{iow} = urxvt::iow
1245	->new	1841	->new
1246	->fd (fileno $term->{socket})	1842	->fd (fileno $term->{socket})
1247	->events (1) # wait for read data	1843	->events (urxvt::EVENT_READ)
1248	->start	1844	->start
1249	->cb (sub {	1845	->cb (sub {
1250	my ($iow, $revents) = @_;	1846	my ($iow, $revents) = @_;
1251	# $revents must be 1 here, no need to check	1847	# $revents must be 1 here, no need to check
1252	sysread $term->{socket}, my $buf, 8192	1848	sysread $term->{socket}, my $buf, 8192
…		…
1269		1865
1270	Set the filedescriptor (not handle) to watch.	1866	Set the filedescriptor (not handle) to watch.
1271		1867
1272	=item $iow = $iow->events ($eventmask)	1868	=item $iow = $iow->events ($eventmask)
1273		1869
1274	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1870	Set the event mask to watch. The only allowed values are
1275	data, Bit #1 (value C<2>) enables watching for write data.	1871	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1872	together, or C<urxvt::EVENT_NONE>.
1276		1873
1277	=item $iow = $iow->start	1874	=item $iow = $iow->start
1278		1875
1279	Start watching for requested events on the given handle.	1876	Start watching for requested events on the given handle.
1280		1877
1281	=item $iow = $iow->stop	1878	=item $iow = $iow->stop
1282		1879
1283	Stop watching for events on the given filehandle.	1880	Stop watching for events on the given filehandle.
		1881
		1882	=back
		1883
		1884	=head2 The C<urxvt::iw> Class
		1885
		1886	This class implements idle watchers, that get called automatically when
		1887	the process is idle. They should return as fast as possible, after doing
		1888	some useful work.
		1889
		1890	=over 4
		1891
		1892	=item $iw = new urxvt::iw
		1893
		1894	Create a new idle watcher object in stopped state.
		1895
		1896	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1897
		1898	Set the callback to be called when the watcher triggers.
		1899
		1900	=item $timer = $timer->start
		1901
		1902	Start the watcher.
		1903
		1904	=item $timer = $timer->stop
		1905
		1906	Stop the watcher.
		1907
		1908	=back
		1909
		1910	=head2 The C<urxvt::pw> Class
		1911
		1912	This class implements process watchers. They create an event whenever a
		1913	process exits, after which they stop automatically.
		1914
		1915	my $pid = fork;
		1916	...
		1917	$term->{pw} = urxvt::pw
		1918	->new
		1919	->start ($pid)
		1920	->cb (sub {
		1921	my ($pw, $exit_status) = @_;
		1922	...
		1923	});
		1924
		1925	=over 4
		1926
		1927	=item $pw = new urxvt::pw
		1928
		1929	Create a new process watcher in stopped state.
		1930
		1931	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1932
		1933	Set the callback to be called when the timer triggers.
		1934
		1935	=item $pw = $timer->start ($pid)
		1936
		1937	Tells the wqtcher to start watching for process C<$pid>.
		1938
		1939	=item $pw = $pw->stop
		1940
		1941	Stop the watcher.
1284		1942
1285	=back	1943	=back
1286		1944
1287	=head1 ENVIRONMENT	1945	=head1 ENVIRONMENT
1288		1946
…		…
1291	This variable controls the verbosity level of the perl extension. Higher	1949	This variable controls the verbosity level of the perl extension. Higher
1292	numbers indicate more verbose output.	1950	numbers indicate more verbose output.
1293		1951
1294	=over 4	1952	=over 4
1295		1953
1296	=item =0 - only fatal messages	1954	=item == 0 - fatal messages
1297		1955
1298	=item =3 - script loading and management	1956	=item >= 3 - script loading and management
1299		1957
1300	=item =10 - all events received	1958	=item >=10 - all called hooks
		1959
		1960	=item >=11 - hook reutrn values
1301		1961
1302	=back	1962	=back
1303		1963
1304	=head1 AUTHOR	1964	=head1 AUTHOR
1305		1965

Diff Legend

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