ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC

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

Diff Legend

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