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.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.150 by root, Thu Dec 7 03:02:44 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
…		…
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	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, 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
		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 following 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
49	It also offers the following bindable keyboard command:	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 (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	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 whether 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	};
71		140
72	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
73		142
74	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
75	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
76	input/output is suspended.	145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
77		147
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	148	Inputting characters appends them to the regex and continues incremental
79	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>
80	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
81	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.
82		155
83	=item digital-clock	156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		157	get a case-sensitive search you can delete this prefix using C<BackSpace>
		158	or simply use an uppercase character which removes the "(?i)" prefix.
84		159
85	Displays a digital clock using the built-in overlay.	160	See L<perlre> for more info about perl regular expression syntax.
86		161
87	=item mark-urls	162	=item readline (enabled by default)
88		163
		164	A support package that tries to make editing with readline easier. At
		165	the moment, it reacts to clicking shift-left mouse button by trying to
		166	move the text cursor to this position. It does so by generating as many
		167	cursor-left or cursor-right keypresses as required (the this only works
		168	for programs that correctly support wide characters).
		169
		170	To avoid too many false positives, this is only done when:
		171
		172	=over 4
		173
		174	=item - the tty is in ICANON state.
		175
		176	=item - the text cursor is visible.
		177
		178	=item - the primary screen is currently being displayed.
		179
		180	=item - the mouse is on the same (multi-row-) line as the text cursor.
		181
		182	=back
		183
		184	The normal selection mechanism isn't disabled, so quick successive clicks
		185	might interfere with selection creation in harmless ways.
		186
		187	=item selection-autotransform
		188
		189	This selection allows you to do automatic transforms on a selection
		190	whenever a selection is made.
		191
		192	It works by specifying perl snippets (most useful is a single C<s///>
		193	operator) that modify C<$_> as resources:
		194
		195	URxvt.selection-autotransform.0: transform
		196	URxvt.selection-autotransform.1: transform
		197	...
		198
		199	For example, the following will transform selections of the form
		200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		201	$word>:
		202
		203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		204
		205	And this example matches the same,but replaces it with vi-commands you can
		206	paste directly into your (vi :) editor:
		207
		208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		209
		210	Of course, this can be modified to suit your needs and your editor :)
		211
		212	To expand the example above to typical perl error messages ("XXX at
		213	FILENAME line YYY."), you need a slightly more elaborate solution:
		214
		215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		217
		218	The first line tells the selection code to treat the unchanging part of
		219	every error message as a selection pattern, and the second line transforms
		220	the message into vi commands to load the file.
		221
		222	=item tabbed
		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
		244
		245	=item matcher
		246
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	247	Uses per-line display filtering (C<on_line_update>) to underline text
		248	matching a certain pattern and make it clickable. When clicked with the
		249	mouse button specified in the C<matcher.button> resource (default 2, or
		250	middle), the program specified in the C<matcher.launcher> resource
		251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		252	with the matched text as first argument. The default configuration is
		253	suitable for matching URLs and launching a web browser, like the
		254	former "mark-urls" extension.
		255
		256	The default pattern to match URLs can be overridden with the
		257	C<matcher.pattern.0> resource, and additional patterns can be specified
		258	with numbered patterns, in a manner similar to the "selection" extension.
		259	The launcher can also be overridden on a per-pattern basis.
		260
		261	Example configuration:
		262
		263	URxvt.perl-ext: default,matcher
		264	URxvt.urlLauncher: sensible-browser
		265	URxvt.matcher.button: 1
		266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		268	URxvt.matcher.launcher.2: gvim +$2 $1
		269
		270	=item xim-onthespot
		271
		272	This (experimental) perl extension implements OnTheSpot editing. It does
		273	not work perfectly, and some input methods don't seem to work well with
		274	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		275	kinput2.
		276
		277	You enable it by specifying this extension and a preedit style of
		278	C<OnTheSpot>, i.e.:
		279
		280	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		281
		282	=item kuake<hotkey>
		283
		284	A very primitive quake-console-like extension. It was inspired by a
		285	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		286	user presses a global accelerator key (by default C<F10>), the terminal
		287	will show or hide itself. Another press of the accelerator key will hide
		288	or show it again.
		289
		290	Initially, the window will not be shown when using this extension.
		291
		292	This is useful if you need a single terminal thats not using any desktop
		293	space most of the time but is quickly available at the press of a key.
		294
		295	The accelerator key is grabbed regardless of any modifiers, so this
		296	extension will actually grab a physical key just for this function.
		297
		298	If you want a quake-like animation, tell your window manager to do so
		299	(fvwm can do it).
		300
		301	=item automove-background
		302
		303	This is basically a very small extension that dynamically changes the
		304	background pixmap offset to the window position, in effect creating the
		305	same effect as pseudo transparency with a custom pixmap. No scaling is
		306	supported in this mode. Example:
		307
		308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		309
91	=item block-graphics-to-ascii	310	=item block-graphics-to-ascii
92		311
93	A not very useful example of filtering all text output to the terminal,	312	A not very useful example of filtering all text output to the terminal
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	313	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	314	similar-looking ascii character.
		315
		316	=item digital-clock
		317
		318	Displays a digital clock using the built-in overlay.
		319
		320	=item remote-clipboard
		321
		322	Somewhat of a misnomer, this extension adds two menu entries to the
		323	selection popup that allows one ti run external commands to store the
		324	selection somewhere and fetch it again.
		325
		326	We use it to implement a "distributed selection mechanism", which just
		327	means that one command uploads the file to a remote server, and another
		328	reads it.
		329
		330	The commands can be set using the C<URxvt.remote-selection.store> and
		331	C<URxvt.remote-selection.fetch> resources. The first should read the
		332	selection to store from STDIN (always in UTF-8), the second should provide
		333	the selection data on STDOUT (also in UTF-8).
		334
		335	The defaults (which are likely useless to you) use rsh and cat:
		336
		337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		339
		340	=item selection-pastebin
		341
		342	This is a little rarely useful extension that Uploads the selection as
		343	textfile to a remote site (or does other things). (The implementation is
		344	not currently secure for use in a multiuser environment as it writes to
		345	F</tmp> directly.).
		346
		347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		348	i.e.
		349
		350	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		351
		352	Pressing this combination runs a command with C<%> replaced by the name of
		353	the textfile. This command can be set via a resource:
		354
		355	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		356
		357	And the default is likely not useful to anybody but the few people around
		358	here :)
		359
		360	The name of the textfile is the hex encoded md5 sum of the selection, so
		361	the same content should lead to the same filename.
		362
		363	After a successful upload the selection will be replaced by the text given
		364	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		365	for the filename):
		366
		367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		368
		369	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		370	the double C</> characters as comment start. Use C<\057\057> instead,
		371	which works regardless of wether xrdb is used to parse the resource file
		372	or not.
96		373
97	=item example-refresh-hooks	374	=item example-refresh-hooks
98		375
99	Displays a very simple digital clock in the upper right corner of the	376	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	377	window. Illustrates overwriting the refresh callbacks to create your own
…		…
140		417
141	=back	418	=back
142		419
143	=head2 Extension Objects	420	=head2 Extension Objects
144		421
145	Very perl extension is a perl class. A separate perl object is created	422	Every perl extension is a perl class. A separate perl object is created
146	for each terminal and each extension and passed as the first parameter to	423	for each terminal, and each terminal has its own set of extenion objects,
147	hooks. So extensions can use their C<$self> object without having to think	424	which are passed as the first parameter to hooks. So extensions can use
148	about other extensions, with the exception of methods and members that	425	their C<$self> object without having to think about clashes with other
		426	extensions or other terminals, with the exception of methods and members
149	begin with an underscore character C<_>: these are reserved for internal	427	that begin with an underscore character C<_>: these are reserved for
150	use.	428	internal use.
151		429
152	Although it isn't a C<urxvt::term> object, you can call all methods of the	430	Although it isn't a C<urxvt::term> object, you can call all methods of the
153	C<urxvt::term> class on this object.	431	C<urxvt::term> class on this object.
154		432
155	It has the following methods and data members:	433	It has the following methods and data members:
…		…
176	=head2 Hooks	454	=head2 Hooks
177		455
178	The following subroutines can be declared in extension files, and will be	456	The following subroutines can be declared in extension files, and will be
179	called whenever the relevant event happens.	457	called whenever the relevant event happens.
180		458
181	The first argument passed to them is an extension oject as described in	459	The first argument passed to them is an extension object as described in
182	the in the C<Extension Objects> section.	460	the in the C<Extension Objects> section.
183		461
184	B<All> of these hooks must return a boolean value. If it is true, then the	462	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	463	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	464	relevant action might not be carried out by the C++ code.
187		465
188	I<< When in doubt, return a false value (preferably C<()>). >>	466	I<< When in doubt, return a false value (preferably C<()>). >>
189		467
190	=over 4	468	=over 4
191		469
192	=item on_init $term	470	=item on_init $term
193		471
194	Called after a new terminal object has been initialized, but before	472	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	473	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	474	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	475	have not yet been determined. You can safely query and change resources
198	though.	476	and options, though. For many purposes the C<on_start> hook is a better
		477	place.
		478
		479	=item on_start $term
		480
		481	Called at the very end of initialisation of a new terminal, just before
		482	trying to map (display) the toplevel and returning to the main loop.
		483
		484	=item on_destroy $term
		485
		486	Called whenever something tries to destroy terminal, when the terminal is
		487	still fully functional (not for long, though).
199		488
200	=item on_reset $term	489	=item on_reset $term
201		490
202	Called after the screen is "reset" for any reason, such as resizing or	491	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	492	control sequences. Here is where you can react on changes to size-related
204	variables.	493	variables.
205		494
206	=item on_start $term	495	=item on_child_start $term, $pid
207		496
208	Called at the very end of initialisation of a new terminal, just before	497	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	498
		499	=item on_child_exit $term, $status
		500
		501	Called just after the child process has exited. C<$status> is the status
		502	from C<waitpid>.
210		503
211	=item on_sel_make $term, $eventtime	504	=item on_sel_make $term, $eventtime
212		505
213	Called whenever a selection has been made by the user, but before the	506	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	507	selection text is copied, so changes to the beginning, end or type of the
…		…
221		514
222	Called whenever a selection has been copied, but before the selection is	515	Called whenever a selection has been copied, but before the selection is
223	requested from the server. The selection text can be queried and changed	516	requested from the server. The selection text can be queried and changed
224	by calling C<< $term->selection >>.	517	by calling C<< $term->selection >>.
225		518
226	Returning a true value aborts selection grabbing. It will still be hilighted.	519	Returning a true value aborts selection grabbing. It will still be highlighted.
227		520
228	=item on_sel_extend $term	521	=item on_sel_extend $term
229		522
230	Called whenever the user tries to extend the selection (e.g. with a double	523	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	524	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	525	should extend the selection itself and return true to suppress the built-in
233	processing.	526	processing. This can happen multiple times, as long as the callback
		527	returns true, it will be called on every further click by the user and is
		528	supposed to enlarge the selection more and more, if possible.
234		529
235	See the F<selection> example extension.	530	See the F<selection> example extension.
236		531
237	=item on_view_change $term, $offset	532	=item on_view_change $term, $offset
238		533
239	Called whenever the view offset changes, i..e the user or program	534	Called whenever the view offset changes, i.e. the user or program
240	scrolls. Offset C<0> means display the normal terminal, positive values	535	scrolls. Offset C<0> means display the normal terminal, positive values
241	show this many lines of scrollback.	536	show this many lines of scrollback.
242		537
243	=item on_scroll_back $term, $lines, $saved	538	=item on_scroll_back $term, $lines, $saved
244		539
…		…
248		543
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	544	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	545	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251	number of lines that will be in the scrollback buffer.	546	number of lines that will be in the scrollback buffer.
252		547
		548	=item on_osc_seq $term, $op, $args
		549
		550	Called on every OSC sequence and can be used to suppress it or modify its
		551	behaviour. The default should be to return an empty list. A true value
		552	suppresses execution of the request completely. Make sure you don't get
		553	confused by recursive invocations when you output an osc sequence within
		554	this callback.
		555
		556	C<on_osc_seq_perl> should be used for new behaviour.
		557
253	=item on_osc_seq $term, $string	558	=item on_osc_seq_perl $term, $string
254		559
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	561	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	562	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	563	string should start with the extension name and a colon, to distinguish
259	it from commands for other extensions, and this might be enforced in the	564	it from commands for other extensions, and this might be enforced in the
260	future.	565	future.
261		566
262	Be careful not ever to trust (in a security sense) the data you receive,	567	Be careful not ever to trust (in a security sense) the data you receive,
263	as its source can not easily be controleld (e-mail content, messages from	568	as its source can not easily be controlled (e-mail content, messages from
264	other users on the same system etc.).	569	other users on the same system etc.).
265		570
266	=item on_add_lines $term, $string	571	=item on_add_lines $term, $string
267		572
268	Called whenever text is about to be output, with the text as argument. You	573	Called whenever text is about to be output, with the text as argument. You
…		…
299		604
300	=item on_refresh_end $term	605	=item on_refresh_end $term
301		606
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	607	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		608
304	=item on_keyboard_command $term, $string	609	=item on_user_command $term, $string
305		610
306	Called whenever the user presses a key combination that has a	611	Called whenever a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	612	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	613	resource in the @@RXVT_NAME@@(1) manpage).
		614
		615	The event is simply the action string. This interface is assumed to change
		616	slightly in the future.
		617
		618	=item on_resize_all_windows $tern, $new_width, $new_height
		619
		620	Called just after the new window size has been calculated, but before
		621	windows are actually being resized or hints are being set. If this hook
		622	returns TRUE, setting of the window hints is being skipped.
		623
		624	=item on_x_event $term, $event
		625
		626	Called on every X event received on the vt window (and possibly other
		627	windows). Should only be used as a last resort. Most event structure
		628	members are not passed.
		629
		630	=item on_root_event $term, $event
		631
		632	Like C<on_x_event>, but is called for events on the root window.
309		633
310	=item on_focus_in $term	634	=item on_focus_in $term
311		635
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	636	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	637	does focus in processing.
314		638
315	=item on_focus_out $term	639	=item on_focus_out $term
316		640
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	641	Called whenever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	642	focus out processing.
		643
		644	=item on_configure_notify $term, $event
		645
		646	=item on_property_notify $term, $event
319		647
320	=item on_key_press $term, $event, $keysym, $octets	648	=item on_key_press $term, $event, $keysym, $octets
321		649
322	=item on_key_release $term, $event, $keysym	650	=item on_key_release $term, $event, $keysym
323		651
…		…
333		661
334	Called whenever the corresponding X event is received for the terminal If	662	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	663	the hook returns true, then the even will be ignored by rxvt-unicode.
336		664
337	The event is a hash with most values as named by Xlib (see the XEvent	665	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	666	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	667	(real, not screen-based) row and column under the mouse cursor.
340		668
341	C<on_key_press> additionally receives the string rxvt-unicode would	669	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	670	output, if any, in locale-specific encoding.
343		671
344	subwindow.	672	subwindow.
		673
		674	=item on_client_message $term, $event
		675
		676	=item on_wm_protocols $term, $event
		677
		678	=item on_wm_delete_window $term, $event
		679
		680	Called when various types of ClientMessage events are received (all with
		681	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345		682
346	=back	683	=back
347		684
348	=cut	685	=cut
349		686
…		…
355	use Scalar::Util ();	692	use Scalar::Util ();
356	use List::Util ();	693	use List::Util ();
357		694
358	our $VERSION = 1;	695	our $VERSION = 1;
359	our $TERM;	696	our $TERM;
		697	our @TERM_INIT;
		698	our @TERM_EXT;
360	our @HOOKNAME;	699	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	700	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	701	our %OPTION;
363		702
364	our $LIBDIR;	703	our $LIBDIR;
365	our $RESNAME;	704	our $RESNAME;
366	our $RESCLASS;	705	our $RESCLASS;
367	our $RXVTNAME;	706	our $RXVTNAME;
368		707
		708	our $NOCHAR = chr 0xffff;
		709
369	=head2 Variables in the C<urxvt> Package	710	=head2 Variables in the C<urxvt> Package
370		711
371	=over 4	712	=over 4
372		713
373	=item $urxvt::LIBDIR	714	=item $urxvt::LIBDIR
…		…
385		726
386	=item $urxvt::TERM	727	=item $urxvt::TERM
387		728
388	The current terminal. This variable stores the current C<urxvt::term>	729	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	730	object, whenever a callback/hook is executing.
		731
		732	=item @urxvt::TERM_INIT
		733
		734	All code references in this array will be called as methods of the next newly
		735	created C<urxvt::term> object (during the C<on_init> phase). The array
		736	gets cleared before the code references that were in it are being executed,
		737	so references can push themselves onto it again if they so desire.
		738
		739	This complements to the perl-eval command line option, but gets executed
		740	first.
		741
		742	=item @urxvt::TERM_EXT
		743
		744	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		745	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		746	but before other extensions. Gets cleared just like C<@TERM_INIT>.
390		747
391	=back	748	=back
392		749
393	=head2 Functions in the C<urxvt> Package	750	=head2 Functions in the C<urxvt> Package
394		751
…		…
409	Using this function has the advantage that its output ends up in the	766	Using this function has the advantage that its output ends up in the
410	correct place, e.g. on stderr of the connecting urxvtc client.	767	correct place, e.g. on stderr of the connecting urxvtc client.
411		768
412	Messages have a size limit of 1023 bytes currently.	769	Messages have a size limit of 1023 bytes currently.
413		770
414	=item $is_safe = urxvt::safe	771	=item @terms = urxvt::termlist
415		772
416	Returns true when it is safe to do potentially unsafe things, such as	773	Returns all urxvt::term objects that exist in this process, regardless of
417	evaluating perl code specified by the user. This is true when urxvt was	774	whether they are started, being destroyed etc., so be careful. Only term
418	started setuid or setgid.	775	objects that have perl extensions attached will be returned (because there
		776	is no urxvt::term objet associated with others).
419		777
420	=item $time = urxvt::NOW	778	=item $time = urxvt::NOW
421		779
422	Returns the "current time" (as per the event loop).	780	Returns the "current time" (as per the event loop).
423		781
424	=item urxvt::CurrentTime	782	=item urxvt::CurrentTime
425		783
426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	784	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	785	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428	Button4Mask, Button5Mask, AnyModifier	786	Button4Mask, Button5Mask, AnyModifier
		787
		788	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		789	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		790	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		791	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		792	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		793	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		794	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		795
		796	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		797	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		798	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		799	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		800	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		801	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		802	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429		803
430	Various constants for use in X calls and event processing.	804	Various constants for use in X calls and event processing.
431		805
432	=back	806	=back
433		807
…		…
466		840
467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	841	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
468		842
469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	843	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
470		844
		845	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		846
471	Replace the foreground/background colour in the rendition mask with the	847	Replace the foreground/background colour in the rendition mask with the
472	specified one.	848	specified one.
473		849
474	=item $value = urxvt::GET_CUSTOM $rend	850	=item $value = urxvt::GET_CUSTOM $rend
475		851
…		…
484	=back	860	=back
485		861
486	=cut	862	=cut
487		863
488	BEGIN {	864	BEGIN {
489	urxvt->bootstrap;
490
491	# overwrite perl's warn	865	# overwrite perl's warn
492	*CORE::GLOBAL::warn = sub {	866	*CORE::GLOBAL::warn = sub {
493	my $msg = join "", @_;	867	my $msg = join "", @_;
494	$msg .= "\n"	868	$msg .= "\n"
495	unless $msg =~ /\n$/;	869	unless $msg =~ /\n$/;
496	urxvt::warn ($msg);	870	urxvt::warn ($msg);
497	};	871	};
498
499	delete $ENV{IFS};
500	delete $ENV{CDPATH};
501	delete $ENV{BASH_ENV};
502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503	}	872	}
504		873
505	my @hook_count;	874	no warnings 'utf8';
		875
506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	876	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507		877
508	sub verbose {	878	sub verbose {
509	my ($level, $msg) = @_;	879	my ($level, $msg) = @_;
510	warn "$msg\n" if $level <= $verbosity;	880	warn "$msg\n" if $level <= $verbosity;
511	}	881	}
512		882
513	my $extension_pkg = "extension0000";
514	my %extension_pkg;	883	my %extension_pkg;
515		884
516	# load a single script into its own package, once only	885	# load a single script into its own package, once only
517	sub extension_package($) {	886	sub extension_package($) {
518	my ($path) = @_;	887	my ($path) = @_;
519		888
520	$extension_pkg{$path} ||= do {	889	$extension_pkg{$path} ||= do {
521	my $pkg = "urxvt::" . ($extension_pkg++);	890	$path =~ /([^\/\\]+)$/;
		891	my $pkg = $1;
		892	$pkg =~ s/[^[:word:]]/_/g;
		893	$pkg = "urxvt::ext::$pkg";
522		894
523	verbose 3, "loading extension '$path' into package '$pkg'";	895	verbose 3, "loading extension '$path' into package '$pkg'";
524		896
525	open my $fh, "<:raw", $path	897	open my $fh, "<:raw", $path
526	or die "$path: $!";	898	or die "$path: $!";
527		899
528	my $source = untaint	900	my $source =
529	"package $pkg; use strict; use utf8;\n"	901	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
530	. "use base urxvt::term::extension::;\n"
531	. "#line 1 \"$path\"\n{\n"	902	. "#line 1 \"$path\"\n{\n"
532	. (do { local $/; <$fh> })	903	. (do { local $/; <$fh> })
533	. "\n};\n1";	904	. "\n};\n1";
534		905
535	eval $source	906	eval $source
…		…
549	if ($htype == 0) { # INIT	920	if ($htype == 0) { # INIT
550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
551		922
552	my %ext_arg;	923	my %ext_arg;
553		924
		925	{
		926	my @init = @TERM_INIT;
		927	@TERM_INIT = ();
		928	$_->($TERM) for @init;
		929	my @pkg = @TERM_EXT;
		930	@TERM_EXT = ();
		931	$TERM->register_package ($_) for @pkg;
		932	}
		933
554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	934	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
555	if ($_ eq "default") {	935	if ($_ eq "default") {
556	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	936	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
557	} elsif (/^-(.*)$/) {	937	} elsif (/^-(.*)$/) {
558	delete $ext_arg{$1};	938	delete $ext_arg{$1};
559	} elsif (/^([^<]+)<(.*)>$/) {	939	} elsif (/^([^<]+)<(.*)>$/) {
560	push @{ $ext_arg{$1} }, $2;	940	push @{ $ext_arg{$1} }, $2;
561	} else {	941	} else {
562	$ext_arg{$_} ||= [];	942	$ext_arg{$_} ||= [];
563	}	943	}
564	}	944	}
565		945
566	while (my ($ext, $argv) = each %ext_arg) {	946	for my $ext (sort keys %ext_arg) {
567	my @files = grep -f $_, map "$_/$ext", @dirs;	947	my @files = grep -f $_, map "$_/$ext", @dirs;
568		948
569	if (@files) {	949	if (@files) {
570	$TERM->register_package (extension_package $files[0], $argv);	950	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
571	} else {	951	} else {
572	warn "perl extension '$ext' not found in perl library search path\n";	952	warn "perl extension '$ext' not found in perl library search path\n";
573	}	953	}
574	}	954	}
575		955
…		…
581		961
582	if (my $cb = $TERM->{_hook}[$htype]) {	962	if (my $cb = $TERM->{_hook}[$htype]) {
583	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	963	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
584	if $verbosity >= 10;	964	if $verbosity >= 10;
585		965
586	keys %$cb;	966	for my $pkg (keys %$cb) {
587
588	while (my ($pkg, $cb) = each %$cb) {
589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	967	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
590	and last;	968	$retval ||= $retval_;
591		969
592	if ($@) {	970	if ($@) {
593	$TERM->ungrab; # better to lose the grab than the session	971	$TERM->ungrab; # better to lose the grab than the session
594	warn $@;	972	warn $@;
595	}	973	}
596	}	974	}
		975
		976	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		977	if $verbosity >= 11;
597	}	978	}
598		979
599	if ($htype == 1) { # DESTROY	980	if ($htype == 1) { # DESTROY
600	if (my $hook = delete $TERM->{_hook}) {
601	for my $htype (0..$#$hook) {
602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
603	or set_should_invoke $htype, 0;
604	}
605	}
606
607	# clear package objects	981	# clear package objects
608	%$_ = () for values %{ $TERM->{_pkg} };	982	%$_ = () for values %{ $TERM->{_pkg} };
609		983
610	# clear package	984	# clear package
611	%$TERM = ();	985	%$TERM = ();
612	}	986	}
613		987
614	$retval	988	$retval
		989	}
		990
		991	sub SET_COLOR($$$) {
		992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
615	}	993	}
616		994
617	# urxvt::term::extension	995	# urxvt::term::extension
618		996
619	package urxvt::term::extension;	997	package urxvt::term::extension;
…		…
625	while (my ($name, $cb) = each %hook) {	1003	while (my ($name, $cb) = each %hook) {
626	my $htype = $HOOKTYPE{uc $name};	1004	my $htype = $HOOKTYPE{uc $name};
627	defined $htype	1005	defined $htype
628	or Carp::croak "unsupported hook type '$name'";	1006	or Carp::croak "unsupported hook type '$name'";
629		1007
		1008	$self->set_should_invoke ($htype, +1)
630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1009	unless exists $self->{term}{_hook}[$htype]{$pkg};
631	$hook_count[$htype]++
632	or urxvt::set_should_invoke $htype, 1;
633	}
634		1010
635	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1011	$self->{term}{_hook}[$htype]{$pkg} = $cb;
636	}	1012	}
637	}	1013	}
638		1014
…		…
643	for my $name (@hook) {	1019	for my $name (@hook) {
644	my $htype = $HOOKTYPE{uc $name};	1020	my $htype = $HOOKTYPE{uc $name};
645	defined $htype	1021	defined $htype
646	or Carp::croak "unsupported hook type '$name'";	1022	or Carp::croak "unsupported hook type '$name'";
647		1023
		1024	$self->set_should_invoke ($htype, -1)
648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1025	if delete $self->{term}{_hook}[$htype]{$pkg};
649	--$hook_count[$htype]
650	or urxvt::set_should_invoke $htype, 0;
651	}
652	}	1026	}
653	}	1027	}
654		1028
655	our $AUTOLOAD;	1029	our $AUTOLOAD;
656		1030
…		…
736	sub DESTROY {	1110	sub DESTROY {
737	$_[0][1]->stop;	1111	$_[0][1]->stop;
738	}	1112	}
739		1113
740	sub condvar {	1114	sub condvar {
741	bless \my $flag, urxvt::anyevent::condvar::	1115	bless \my $flag, urxvt::anyevent::
742	}	1116	}
743		1117
744	sub urxvt::anyevent::condvar::broadcast {	1118	sub broadcast {
745	${$_[0]}++;	1119	${$_[0]}++;
746	}	1120	}
747		1121
748	sub urxvt::anyevent::condvar::wait {	1122	sub wait {
749	unless (${$_[0]}) {	1123	unless (${$_[0]}) {
750	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1124	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
751	}	1125	}
		1126	}
		1127
		1128	sub one_event {
		1129	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
752	}	1130	}
753		1131
754	package urxvt::term;	1132	package urxvt::term;
755		1133
756	=head2 The C<urxvt::term> Class	1134	=head2 The C<urxvt::term> Class
…		…
761		1139
762	# find on_xxx subs in the package and register them	1140	# find on_xxx subs in the package and register them
763	# as hooks	1141	# as hooks
764	sub register_package {	1142	sub register_package {
765	my ($self, $pkg, $argv) = @_;	1143	my ($self, $pkg, $argv) = @_;
		1144
		1145	no strict 'refs';
		1146
		1147	urxvt::verbose 6, "register package $pkg to $self";
		1148
		1149	@{"$pkg\::ISA"} = urxvt::term::extension::;
766		1150
767	my $proxy = bless {	1151	my $proxy = bless {
768	_pkg => $pkg,	1152	_pkg => $pkg,
769	argv => $argv,	1153	argv => $argv,
770	}, $pkg;	1154	}, $pkg;
…		…
786	hash which defines the environment of the new terminal.	1170	hash which defines the environment of the new terminal.
787		1171
788	Croaks (and probably outputs an error message) if the new instance	1172	Croaks (and probably outputs an error message) if the new instance
789	couldn't be created. Returns C<undef> if the new instance didn't	1173	couldn't be created. Returns C<undef> if the new instance didn't
790	initialise perl, and the terminal object otherwise. The C<init> and	1174	initialise perl, and the terminal object otherwise. The C<init> and
791	C<start> hooks will be called during this call.	1175	C<start> hooks will be called before this call returns, and are free to
		1176	refer to global data (which is race free).
792		1177
793	=cut	1178	=cut
794		1179
795	sub new {	1180	sub new {
796	my ($class, $env, @args) = @_;	1181	my ($class, $env, @args) = @_;
797		1182
		1183	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1184	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1185
798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1186	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
799	}	1187	}
800		1188
801	=item $term->destroy	1189	=item $term->destroy
802		1190
803	Destroy the terminal object (close the window, free resources	1191	Destroy the terminal object (close the window, free resources
804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1192	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805	watchers (timers, io watchers) are still active.	1193	watchers (timers, io watchers) are still active.
806		1194
		1195	=item $term->exec_async ($cmd[, @args])
		1196
		1197	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1198	("starts") programs in the background. This function takes care of setting
		1199	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1200	be preferred over explicit calls to C<exec> or C<system>.
		1201
		1202	Returns the pid of the subprocess or C<undef> on error.
		1203
		1204	=cut
		1205
		1206	sub exec_async {
		1207	my $self = shift;
		1208
		1209	my $pid = fork;
		1210
		1211	return $pid
		1212	if !defined $pid or $pid;
		1213
		1214	%ENV = %{ $self->env };
		1215
		1216	exec @_;
		1217	urxvt::_exit 255;
		1218	}
		1219
807	=item $isset = $term->option ($optval[, $set])	1220	=item $isset = $term->option ($optval[, $set])
808		1221
809	Returns true if the option specified by C<$optval> is enabled, and	1222	Returns true if the option specified by C<$optval> is enabled, and
810	optionally change it. All option values are stored by name in the hash	1223	optionally change it. All option values are stored by name in the hash
811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1224	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
812		1225
813	Here is a a likely non-exhaustive list of option names, please see the	1226	Here is a likely non-exhaustive list of option names, please see the
814	source file F</src/optinc.h> to see the actual list:	1227	source file F</src/optinc.h> to see the actual list:
815		1228
816	borderLess console cursorBlink cursorUnderline hold iconic insecure	1229	borderLess console cursorBlink cursorUnderline hold iconic insecure
817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1230	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1231	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1232	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1233	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821	tripleclickwords utmpInhibit visualBell	1234	transparent tripleclickwords utmpInhibit visualBell
822		1235
823	=item $value = $term->resource ($name[, $newval])	1236	=item $value = $term->resource ($name[, $newval])
824		1237
825	Returns the current resource value associated with a given name and	1238	Returns the current resource value associated with a given name and
826	optionally sets a new value. Setting values is most useful in the C<init>	1239	optionally sets a new value. Setting values is most useful in the C<init>
…		…
835	likely change).	1248	likely change).
836		1249
837	Please note that resource strings will currently only be freed when the	1250	Please note that resource strings will currently only be freed when the
838	terminal is destroyed, so changing options frequently will eat memory.	1251	terminal is destroyed, so changing options frequently will eat memory.
839		1252
840	Here is a a likely non-exhaustive list of resource names, not all of which	1253	Here is a likely non-exhaustive list of resource names, not all of which
841	are supported in every build, please see the source file F</src/rsinc.h>	1254	are supported in every build, please see the source file F</src/rsinc.h>
842	to see the actual list:	1255	to see the actual list:
843		1256
844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845	borderLess color cursorBlink cursorUnderline cutchars delete_key	1258	borderLess color cursorBlink cursorUnderline cutchars delete_key
846	display_name embed ext_bwidth fade font geometry hold iconName	1259	display_name embed ext_bwidth fade font geometry hold iconName
847	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1260	imFont imLocale inputMethod insecure int_bwidth intensityStyles
848	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1261	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1262	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1263	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1264	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1265	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854	shade term_name title transparent transparent_all tripleclickwords	1267	secondaryScreen secondaryScroll selectstyle shade term_name title
855	utmpInhibit visualBell	1268	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1269	visualBell
856		1270
857	=cut	1271	=cut
858		1272
859	sub resource($$;$) {	1273	sub resource($$;$) {
860	my ($self, $name) = (shift, shift);	1274	my ($self, $name) = (shift, shift);
861	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1275	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
862	&urxvt::term::_resource	1276	&urxvt::term::_resource
863	}	1277	}
864		1278
		1279	=item $value = $term->x_resource ($pattern)
		1280
		1281	Returns the X-Resource for the given pattern, excluding the program or
		1282	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1283	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1284	resource with that pattern exists.
		1285
		1286	This method should only be called during the C<on_start> hook, as there is
		1287	only one resource database per display, and later invocations might return
		1288	the wrong resources.
		1289
865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1290	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866		1291
867	Adds a keymap translation exactly as specified via a resource. See the	1292	Adds a keymap translation exactly as specified via a resource. See the
868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1293	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869		1294
…		…
884	=item ($row, $col) = $term->selection_end ([$row, $col])	1309	=item ($row, $col) = $term->selection_end ([$row, $col])
885		1310
886	Return the current values of the selection mark, begin or end positions,	1311	Return the current values of the selection mark, begin or end positions,
887	and optionally set them to new values.	1312	and optionally set them to new values.
888		1313
		1314	=item $term->selection_make ($eventtime[, $rectangular])
		1315
		1316	Tries to make a selection as set by C<selection_beg> and
		1317	C<selection_end>. If C<$rectangular> is true (default: false), a
		1318	rectangular selection will be made. This is the prefered function to make
		1319	a selection.
		1320
889	=item $success = $term->selection_grab ($eventtime)	1321	=item $success = $term->selection_grab ($eventtime)
890		1322
891	Try to request the primary selection from the server (for example, as set	1323	Try to request the primary selection text from the server (for example, as
892	by the next method).	1324	set by the next method). No visual feedback will be given. This function
		1325	is mostly useful from within C<on_sel_grab> hooks.
893		1326
894	=item $oldtext = $term->selection ([$newtext])	1327	=item $oldtext = $term->selection ([$newtext])
895		1328
896	Return the current selection text and optionally replace it by C<$newtext>.	1329	Return the current selection text and optionally replace it by C<$newtext>.
897		1330
…		…
990	Convert the given locale-encoded octets into a perl string.	1423	Convert the given locale-encoded octets into a perl string.
991		1424
992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1425	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993		1426
994	XORs the rendition values in the given span with the provided value	1427	XORs the rendition values in the given span with the provided value
995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1428	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996	to the selection.	1429	refresh hooks to provide effects similar to the selection.
997		1430
998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1431	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999		1432
1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1433	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1434	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1435	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1003	it instead.	1436	it instead. Both styles I<MUST NOT> contain font styles.
1004		1437
1005	=item $term->scr_bell	1438	=item $term->scr_bell
1006		1439
1007	Ring the bell!	1440	Ring the bell!
1008		1441
…		…
1015		1448
1016	Normally its not a good idea to use this function, as programs might be	1449	Normally its not a good idea to use this function, as programs might be
1017	confused by changes in cursor position or scrolling. Its useful inside a	1450	confused by changes in cursor position or scrolling. Its useful inside a
1018	C<on_add_lines> hook, though.	1451	C<on_add_lines> hook, though.
1019		1452
		1453	=item $term->scr_change_screen ($screen)
		1454
		1455	Switch to given screen - 0 primary, 1 secondary.
		1456
1020	=item $term->cmd_parse ($octets)	1457	=item $term->cmd_parse ($octets)
1021		1458
1022	Similar to C<scr_add_lines>, but the argument must be in the	1459	Similar to C<scr_add_lines>, but the argument must be in the
1023	locale-specific encoding of the terminal and can contain command sequences	1460	locale-specific encoding of the terminal and can contain command sequences
1024	(escape codes) that will be interpreted.	1461	(escape codes) that will be interpreted.
…		…
1034	Replaces the event mask of the pty watcher by the given event mask. Can	1471	Replaces the event mask of the pty watcher by the given event mask. Can
1035	be used to suppress input and output handling to the pty/tty. See the	1472	be used to suppress input and output handling to the pty/tty. See the
1036	description of C<< urxvt::timer->events >>. Make sure to always restore	1473	description of C<< urxvt::timer->events >>. Make sure to always restore
1037	the previous value.	1474	the previous value.
1038		1475
		1476	=item $fd = $term->pty_fd
		1477
		1478	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1479	is used.
		1480
1039	=item $windowid = $term->parent	1481	=item $windowid = $term->parent
1040		1482
1041	Return the window id of the toplevel window.	1483	Return the window id of the toplevel window.
1042		1484
1043	=item $windowid = $term->vt	1485	=item $windowid = $term->vt
1044		1486
1045	Return the window id of the terminal window.	1487	Return the window id of the terminal window.
1046		1488
		1489	=item $term->vt_emask_add ($x_event_mask)
		1490
		1491	Adds the specified events to the vt event mask. Useful e.g. when you want
		1492	to receive pointer events all the times:
		1493
		1494	$term->vt_emask_add (urxvt::PointerMotionMask);
		1495
		1496	=item $term->focus_in
		1497
		1498	=item $term->focus_out
		1499
		1500	=item $term->key_press ($state, $keycode[, $time])
		1501
		1502	=item $term->key_release ($state, $keycode[, $time])
		1503
		1504	Deliver various fake events to to terminal.
		1505
1047	=item $window_width = $term->width	1506	=item $window_width = $term->width
1048		1507
1049	=item $window_height = $term->height	1508	=item $window_height = $term->height
1050		1509
1051	=item $font_width = $term->fwidth	1510	=item $font_width = $term->fwidth
…		…
1064		1523
1065	=item $max_scrollback = $term->saveLines	1524	=item $max_scrollback = $term->saveLines
1066		1525
1067	=item $nrow_plus_saveLines = $term->total_rows	1526	=item $nrow_plus_saveLines = $term->total_rows
1068		1527
1069	=item $lines_in_scrollback = $term->nsaved	1528	=item $topmost_scrollback_row = $term->top_row
1070		1529
1071	Return various integers describing terminal characteristics.	1530	Return various integers describing terminal characteristics.
1072		1531
1073	=item $x_display = $term->display_id	1532	=item $x_display = $term->display_id
1074		1533
…		…
1081	=item $env = $term->env	1540	=item $env = $term->env
1082		1541
1083	Returns a copy of the environment in effect for the terminal as a hashref	1542	Returns a copy of the environment in effect for the terminal as a hashref
1084	similar to C<\%ENV>.	1543	similar to C<\%ENV>.
1085		1544
		1545	=item @envv = $term->envv
		1546
		1547	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1548
		1549	=item @argv = $term->argv
		1550
		1551	Return the argument vector as this terminal, similar to @ARGV, but
		1552	includes the program name as first element.
		1553
1086	=cut	1554	=cut
1087		1555
1088	sub env {	1556	sub env {
1089	if (my $env = $_[0]->_env) {
1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1557	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1091	} else {
1092	+{ %ENV }
1093	}
1094	}	1558	}
1095		1559
1096	=item $modifiermask = $term->ModLevel3Mask	1560	=item $modifiermask = $term->ModLevel3Mask
1097		1561
1098	=item $modifiermask = $term->ModMetaMask	1562	=item $modifiermask = $term->ModMetaMask
…		…
1100	=item $modifiermask = $term->ModNumLockMask	1564	=item $modifiermask = $term->ModNumLockMask
1101		1565
1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1566	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1567	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104		1568
		1569	=item $screen = $term->current_screen
		1570
		1571	Returns the currently displayed screen (0 primary, 1 secondary).
		1572
		1573	=item $cursor_is_hidden = $term->hidden_cursor
		1574
		1575	Returns whether the cursor is currently hidden or not.
		1576
1105	=item $view_start = $term->view_start ([$newvalue])	1577	=item $view_start = $term->view_start ([$newvalue])
1106		1578
1107	Returns the negative row number of the topmost line. Minimum value is	1579	Returns the row number of the topmost displayed line. Maximum value is
1108	C<0>, which displays the normal terminal contents. Larger values scroll	1580	C<0>, which displays the normal terminal contents. Lower values scroll
1109	this many lines into the scrollback buffer.	1581	this many lines into the scrollback buffer.
1110		1582
1111	=item $term->want_refresh	1583	=item $term->want_refresh
1112		1584
1113	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1585	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1128	line, starting at column C<$start_col> (default C<0>), which is useful	1600	line, starting at column C<$start_col> (default C<0>), which is useful
1129	to replace only parts of a line. The font index in the rendition will	1601	to replace only parts of a line. The font index in the rendition will
1130	automatically be updated.	1602	automatically be updated.
1131		1603
1132	C<$text> is in a special encoding: tabs and wide characters that use more	1604	C<$text> is in a special encoding: tabs and wide characters that use more
1133	than one cell when displayed are padded with urxvt::NOCHAR characters	1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1134	(C<chr 65535>). Characters with combining characters and other characters	1606	characters. Characters with combining characters and other characters that
1135	that do not fit into the normal tetx encoding will be replaced with	1607	do not fit into the normal tetx encoding will be replaced with characters
1136	characters in the private use area.	1608	in the private use area.
1137		1609
1138	You have to obey this encoding when changing text. The advantage is	1610	You have to obey this encoding when changing text. The advantage is
1139	that C<substr> and similar functions work on screen cells and not on	1611	that C<substr> and similar functions work on screen cells and not on
1140	characters.	1612	characters.
1141		1613
…		…
1192	Return the row number of the first/last row of the line, respectively.	1664	Return the row number of the first/last row of the line, respectively.
1193		1665
1194	=item $offset = $line->offset_of ($row, $col)	1666	=item $offset = $line->offset_of ($row, $col)
1195		1667
1196	Returns the character offset of the given row|col pair within the logical	1668	Returns the character offset of the given row|col pair within the logical
1197	line.	1669	line. Works for rows outside the line, too, and returns corresponding
		1670	offsets outside the string.
1198		1671
1199	=item ($row, $col) = $line->coord_of ($offset)	1672	=item ($row, $col) = $line->coord_of ($offset)
1200		1673
1201	Translates a string offset into terminal coordinates again.	1674	Translates a string offset into terminal coordinates again.
1202		1675
…		…
1284	where one character corresponds to one screen cell. See	1757	where one character corresponds to one screen cell. See
1285	C<< $term->ROW_t >> for details.	1758	C<< $term->ROW_t >> for details.
1286		1759
1287	=item $string = $term->special_decode $text	1760	=item $string = $term->special_decode $text
1288		1761
1289	Converts rxvt-unicodes text reprsentation into a perl string. See	1762	Converts rxvt-unicodes text representation into a perl string. See
1290	C<< $term->ROW_t >> for details.	1763	C<< $term->ROW_t >> for details.
1291		1764
1292	=item $success = $term->grab_button ($button, $modifiermask)	1765	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1293		1766
		1767	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1768
1294	Registers a synchronous button grab. See the XGrabButton manpage.	1769	Register/unregister a synchronous button grab. See the XGrabButton
		1770	manpage.
1295		1771
1296	=item $success = $term->grab ($eventtime[, $sync])	1772	=item $success = $term->grab ($eventtime[, $sync])
1297		1773
1298	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1774	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1299	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1775	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1300		1776
1301	=item $term->allow_events_async	1777	=item $term->allow_events_async
1302		1778
1303	Calls XAllowEvents with AsyncBoth for the most recent grab.	1779	Calls XAllowEvents with AsyncBoth for the most recent grab.
1304		1780
…		…
1314	=item $term->ungrab	1790	=item $term->ungrab
1315		1791
1316	Calls XUngrab for the most recent grab. Is called automatically on	1792	Calls XUngrab for the most recent grab. Is called automatically on
1317	evaluation errors, as it is better to lose the grab in the error case as	1793	evaluation errors, as it is better to lose the grab in the error case as
1318	the session.	1794	the session.
		1795
		1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1797
		1798	=item $atom_name = $term->XGetAtomName ($atom)
		1799
		1800	=item @atoms = $term->XListProperties ($window)
		1801
		1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1803
		1804	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1805
		1806	=item $term->XDeleteProperty ($window, $property)
		1807
		1808	=item $window = $term->DefaultRootWindow
		1809
		1810	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1811
		1812	=item $term->XMapWindow ($window)
		1813
		1814	=item $term->XUnmapWindow ($window)
		1815
		1816	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1817
		1818	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1819
		1820	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1821
		1822	Various X or X-related functions. The C<$term> object only serves as
		1823	the source of the display, otherwise those functions map more-or-less
		1824	directory onto the X functions of the same name.
1319		1825
1320	=back	1826	=back
1321		1827
1322	=cut	1828	=cut
1323		1829
…		…
1387	my ($self, $text, $cb) = @_;	1893	my ($self, $text, $cb) = @_;
1388		1894
1389	$self->add_item ({ type => "button", text => $text, activate => $cb});	1895	$self->add_item ({ type => "button", text => $text, activate => $cb});
1390	}	1896	}
1391		1897
1392	=item $popup->add_toggle ($text, $cb, $initial_value)	1898	=item $popup->add_toggle ($text, $initial_value, $cb)
1393		1899
1394	Adds a toggle/checkbox item to the popup. Teh callback gets called	1900	Adds a toggle/checkbox item to the popup. The callback gets called
1395	whenever it gets toggled, with a boolean indicating its value as its first	1901	whenever it gets toggled, with a boolean indicating its new value as its
1396	argument.	1902	first argument.
1397		1903
1398	=cut	1904	=cut
1399		1905
1400	sub add_toggle {	1906	sub add_toggle {
1401	my ($self, $text, $cb, $value) = @_;	1907	my ($self, $text, $value, $cb) = @_;
1402		1908
1403	my $item; $item = {	1909	my $item; $item = {
1404	type => "button",	1910	type => "button",
1405	text => " $text",	1911	text => " $text",
1406	value => $value,	1912	value => $value,
…		…
1425	my $env = $self->{term}->env;	1931	my $env = $self->{term}->env;
1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1932	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427	delete $env->{LC_ALL};	1933	delete $env->{LC_ALL};
1428	$env->{LC_CTYPE} = $self->{term}->locale;	1934	$env->{LC_CTYPE} = $self->{term}->locale;
1429		1935
1430	urxvt::term->new ($env, $self->{term}->resource ("name"),	1936	urxvt::term->new ($env, "popup",
1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1937	"--perl-lib" => "", "--perl-ext-common" => "",
		1938	"-pty-fd" => -1, "-sl" => 0,
		1939	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432	"--transient-for" => $self->{term}->parent,	1940	"--transient-for" => $self->{term}->parent,
1433	"-display" => $self->{term}->display_id,	1941	"-display" => $self->{term}->display_id,
1434	"-pe" => "urxvt-popup")	1942	"-pe" => "urxvt-popup")
1435	or die "unable to create popup window\n";	1943	or die "unable to create popup window\n";
1436	}	1944	}
…		…
1441	delete $self->{term}{_destroy}{$self};	1949	delete $self->{term}{_destroy}{$self};
1442	$self->{term}->ungrab;	1950	$self->{term}->ungrab;
1443	}	1951	}
1444		1952
1445	=back	1953	=back
		1954
		1955	=cut
		1956
		1957	package urxvt::watcher;
		1958
		1959	@urxvt::timer::ISA = __PACKAGE__;
		1960	@urxvt::iow::ISA = __PACKAGE__;
		1961	@urxvt::pw::ISA = __PACKAGE__;
		1962	@urxvt::iw::ISA = __PACKAGE__;
1446		1963
1447	=head2 The C<urxvt::timer> Class	1964	=head2 The C<urxvt::timer> Class
1448		1965
1449	This class implements timer watchers/events. Time is represented as a	1966	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	1967	fractional number of seconds since the epoch. Example:
…		…
1488	Start the timer.	2005	Start the timer.
1489		2006
1490	=item $timer = $timer->start ($tstamp)	2007	=item $timer = $timer->start ($tstamp)
1491		2008
1492	Set the event trigger time to C<$tstamp> and start the timer.	2009	Set the event trigger time to C<$tstamp> and start the timer.
		2010
		2011	=item $timer = $timer->after ($delay)
		2012
		2013	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		2014
1494	=item $timer = $timer->stop	2015	=item $timer = $timer->stop
1495		2016
1496	Stop the timer.	2017	Stop the timer.
1497		2018
…		…
1526	Set the callback to be called when io events are triggered. C<$reventmask>	2047	Set the callback to be called when io events are triggered. C<$reventmask>
1527	is a bitset as described in the C<events> method.	2048	is a bitset as described in the C<events> method.
1528		2049
1529	=item $iow = $iow->fd ($fd)	2050	=item $iow = $iow->fd ($fd)
1530		2051
1531	Set the filedescriptor (not handle) to watch.	2052	Set the file descriptor (not handle) to watch.
1532		2053
1533	=item $iow = $iow->events ($eventmask)	2054	=item $iow = $iow->events ($eventmask)
1534		2055
1535	Set the event mask to watch. The only allowed values are	2056	Set the event mask to watch. The only allowed values are
1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2057	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1540		2061
1541	Start watching for requested events on the given handle.	2062	Start watching for requested events on the given handle.
1542		2063
1543	=item $iow = $iow->stop	2064	=item $iow = $iow->stop
1544		2065
1545	Stop watching for events on the given filehandle.	2066	Stop watching for events on the given file handle.
		2067
		2068	=back
		2069
		2070	=head2 The C<urxvt::iw> Class
		2071
		2072	This class implements idle watchers, that get called automatically when
		2073	the process is idle. They should return as fast as possible, after doing
		2074	some useful work.
		2075
		2076	=over 4
		2077
		2078	=item $iw = new urxvt::iw
		2079
		2080	Create a new idle watcher object in stopped state.
		2081
		2082	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2083
		2084	Set the callback to be called when the watcher triggers.
		2085
		2086	=item $timer = $timer->start
		2087
		2088	Start the watcher.
		2089
		2090	=item $timer = $timer->stop
		2091
		2092	Stop the watcher.
		2093
		2094	=back
		2095
		2096	=head2 The C<urxvt::pw> Class
		2097
		2098	This class implements process watchers. They create an event whenever a
		2099	process exits, after which they stop automatically.
		2100
		2101	my $pid = fork;
		2102	...
		2103	$term->{pw} = urxvt::pw
		2104	->new
		2105	->start ($pid)
		2106	->cb (sub {
		2107	my ($pw, $exit_status) = @_;
		2108	...
		2109	});
		2110
		2111	=over 4
		2112
		2113	=item $pw = new urxvt::pw
		2114
		2115	Create a new process watcher in stopped state.
		2116
		2117	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2118
		2119	Set the callback to be called when the timer triggers.
		2120
		2121	=item $pw = $timer->start ($pid)
		2122
		2123	Tells the watcher to start watching for process C<$pid>.
		2124
		2125	=item $pw = $pw->stop
		2126
		2127	Stop the watcher.
1546		2128
1547	=back	2129	=back
1548		2130
1549	=head1 ENVIRONMENT	2131	=head1 ENVIRONMENT
1550		2132
…		…
1557		2139
1558	=item == 0 - fatal messages	2140	=item == 0 - fatal messages
1559		2141
1560	=item >= 3 - script loading and management	2142	=item >= 3 - script loading and management
1561		2143
1562	=item >=10 - all events received	2144	=item >=10 - all called hooks
		2145
		2146	=item >=11 - hook return values
1563		2147
1564	=back	2148	=back
1565		2149
1566	=head1 AUTHOR	2150	=head1 AUTHOR
1567		2151

Diff Legend

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