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

Diff Legend

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