[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvtperl.3.txt

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.32 by root, Fri Jan 20 16:02:20 2006 UTC

…		…
12	# start a rxvt using it:	12	# start a rxvt using it:
13		13
14	rxvt --perl-lib $HOME -pe grab_test	14	rxvt --perl-lib $HOME -pe grab_test
15		15
16	DESCRIPTION	16	DESCRIPTION
17	Everytime a terminal object gets created, scripts specified via the	17	Everytime a terminal object gets created, extension scripts specified
18	"perl" resource are loaded and associated with it.	18	via the "perl" resource are loaded and associated with it.
19		19
20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
21	thus must be encoded as UTF-8.	21	thus must be encoded as UTF-8.
22		22
23	Each script will only ever be loaded once, even in rxvtd, where scripts	23	Each script will only ever be loaded once, even in rxvtd, where scripts
24	will be shared (but not enabled) for all terminals.	24	will be shared (but not enabled) for all terminals.
25		25
26	Prepackaged Extensions	26	PREPACKAGED EXTENSIONS
27	This section describes the extensiosn delivered with this version. You	27	This section describes the extensions delivered with this release. You
28	can find them in /opt/rxvt/lib/urxvt/perl/.	28	can find them in /opt/rxvt/lib/urxvt/perl/.
29		29
30	You can activate them like this:	30	You can activate them like this:
31		31
32	rxvt -pe <extensionname>	32	rxvt -pe <extensionname>
33		33
34	selection	34	Or by adding them to the resource for extensions loaded by default:
35	Miscellaneous selection modifications.	35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		37
		38	selection (enabled by default)
		39	(More) intelligent selection. This extension tries to be more
		40	intelligent when the user extends selections (double-click and
		41	further clicks). Right now, it tries to select words, urls and
		42	complete shell-quoted arguments, which is very convenient, too, if
		43	your ls supports "--quoting-style=shell".
		44
		45	A double-click usually selects the word under the cursor, further
		46	clicks will enlarge the selection.
		47
		48	The selection works by trying to match a number of regexes and
		49	displaying them in increasing order of length. You can add your own
		50	regexes by specifying resources of the form:
		51
		52	URxvt.selection.pattern-0: perl-regex
		53	URxvt.selection.pattern-1: perl-regex
		54	...
		55
		56	The index number (0, 1...) must not have any holes, and each regex
		57	must contain at least one pair of capturing parentheses, which will
		58	be used for the match. For example, the followign adds a regex that
		59	matches everything between two vertical bars:
		60
		61	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		62
		63	You can look at the source of the selection extension to see more
		64	interesting uses, such as parsing a line from beginning to end.
		65
		66	This extension also offers following bindable keyboard commands:
36		67
37	rot13	68	rot13
38	Rot-13 the selection when activated. Used via keyboard trigger:	69	Rot-13 the selection when activated. Used via keyboard trigger:
39		70
40	URxvt.keysym.C-M-r: perl:selection:rot13	71	URxvt.keysym.C-M-r: perl:selection:rot13
		72
		73	option-popup (enabled by default)
		74	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		75	options at runtime.
		76
		77	selection-popup (enabled by default)
		78	Binds a popup menu to Ctrl-Button3 that lets you convert the
		79	selection text into various other formats/action (such as uri
		80	unescaping, perl evalution, web-browser starting etc.), depending on
		81	content.
		82
		83	Other extensions can extend this popup menu by pushing a code
		84	reference onto "@{ $term-"{selection_popup_hook} }>, that is called
		85	whenever the popup is displayed.
		86
		87	It's sole argument is the popup menu, which can be modified. The
		88	selection is in $_, which can be used to decide wether to add
		89	something or not. It should either return nothing or a string and a
		90	code reference. The string will be used as button text and the code
		91	reference will be called when the button gets activated and should
		92	transform $_.
		93
		94	The following will add an entry "a to b" that transforms all "a"s in
		95	the selection to "b"s, but only if the selection currently contains
		96	any "a"s:
		97
		98	push @{ $self->{term}{selection_popup_hook} }, sub {
		99	/a/ ? ("a to be" => sub { s/a/b/g }
		100	: ()
		101	};
		102
		103	searchable-scrollback<hotkey> (enabled by default)
		104	Adds regex search functionality to the scrollback buffer, triggered
		105	by a hotkey (default: "M-s"). While in search mode, normal terminal
		106	input/output is suspended and a regex is displayed at the bottom of
		107	the screen.
		108
		109	Inputting characters appends them to the regex and continues
		110	incremental search. "BackSpace" removes a character from the regex,
		111	"Up" and "Down" search upwards/downwards in the scrollback buffer,
		112	"End" jumps to the bottom. "Escape" leaves search mode and returns
		113	to the point where search was started, while "Enter" or "Return"
		114	stay at the current position and additionally stores the first match
		115	in the current line into the primary selection.
		116
		117	selection-autotransform
		118	This selection allows you to do automatic transforms on a selection
		119	whenever a selection is made.
		120
		121	It works by specifying perl snippets (most useful is a single "s///"
		122	operator) that modify $_ as resources:
		123
		124	URxvt.selection-autotransform.0: transform
		125	URxvt.selection-autotransform.1: transform
		126	...
		127
		128	For example, the following will transform selections of the form
		129	"filename:number", often seen in compiler messages, into "vi
		130	+$filename $word":
		131
		132	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		133
		134	And this example matches the same,but replaces it with vi-commands
		135	you can paste directly into your (vi :) editor:
		136
		137	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		138
		139	Of course, this can be modified to suit your needs and your editor
		140	:)
		141
		142	To expand the example above to typical perl error messages ("XXX at
		143	FILENAME line YYY."), you need a slightly more elaborate solution:
		144
		145	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		146	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		147
		148	The first line tells the selection code to treat the unchanging part
		149	of every error message as a selection pattern, and the second line
		150	transforms the message into vi commands to load the file.
		151
		152	tabbed
		153	This transforms the terminal into a tabbar with additional
		154	terminals, that is, it implements what is commonly refered to as
		155	"tabbed terminal". The topmost line displays a "[NEW]" button,
		156	which, when clicked, will add a new tab, followed by one button per
		157	tab.
		158
		159	Clicking a button will activate that tab. Pressing Shift-Left and
		160	Shift-Right will switch to the tab left or right of the current one.
		161
		162	mark-urls
		163	Uses per-line display filtering ("on_line_update") to underline urls
		164	and make them clickable. When middle-clicked, the program specified
		165	in the resource "urlLauncher" (default "x-www-browser") will be
		166	started with the URL as first argument.
		167
		168	automove-background
		169	This is basically a one-line extension that dynamically changes the
		170	background pixmap offset to the window position, in effect creating
		171	the same effect as pseudo transparency with a custom pixmap. No
		172	scaling is supported in this mode. Exmaple:
		173
		174	rxvt -pixmap background.xpm -pe automove-background
		175
		176	block-graphics-to-ascii
		177	A not very useful example of filtering all text output to the
		178	terminal, by replacing all line-drawing characters (U+2500 ..
		179	U+259F) by a similar-looking ascii character.
41		180
42	digital-clock	181	digital-clock
43	Displays a digital clock using the built-in overlay.	182	Displays a digital clock using the built-in overlay.
44		183
45	example-refresh-hooks	184	example-refresh-hooks
46	Displays a very simple digital clock in the upper right corner of	185	Displays a very simple digital clock in the upper right corner of
47	the window. Illustrates overwriting the refresh callbacks to create	186	the window. Illustrates overwriting the refresh callbacks to create
48	your own overlays or changes.	187	your own overlays or changes.
49		188
		189	selection-pastebin
		190	This is a little rarely useful extension that Uploads the selection
		191	as textfile to a remote site (or does other things). (The
		192	implementation is not currently secure for use in a multiuser
		193	environment as it writes to /tmp directly.).
		194
		195	It listens to the "selection-pastebin:remote-pastebin" keyboard
		196	command, i.e.
		197
		198	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		199
		200	Pressing this combination runs a command with "%" replaced by the
		201	name of the textfile. This command can be set via a resource:
		202
		203	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		204
		205	And the default is likely not useful to anybody but the few people
		206	around here :)
		207
		208	The name of the textfile is the hex encoded md5 sum of the
		209	selection, so the same content should lead to the same filename.
		210
		211	After a successful upload the selection will be replaced by the text
		212	given in the "selection-pastebin-url" resource (again, the % is the
		213	placeholder for the filename):
		214
		215	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		216
		217	API DOCUMENTATION
50	General API Considerations	218	General API Considerations
51	All objects (such as terminals, time watchers etc.) are typical	219	All objects (such as terminals, time watchers etc.) are typical
52	reference-to-hash objects. The hash can be used to store anything you	220	reference-to-hash objects. The hash can be used to store anything you
53	like. All members starting with an underscore (such as "_ptr" or	221	like. All members starting with an underscore (such as "_ptr" or
54	"_hook") are reserved for internal uses and must not be accessed or	222	"_hook") are reserved for internal uses and MUST NOT be accessed or
55	modified).	223	modified).
56		224
57	When objects are destroyed on the C++ side, the perl object hashes are	225	When objects are destroyed on the C++ side, the perl object hashes are
58	emptied, so its best to store related objects such as time watchers and	226	emptied, so its best to store related objects such as time watchers and
59	the like inside the terminal object so they get destroyed as soon as the	227	the like inside the terminal object so they get destroyed as soon as the
60	terminal is destroyed.	228	terminal is destroyed.
61		229
		230	Argument names also often indicate the type of a parameter. Here are
		231	some hints on what they mean:
		232
		233	$text
		234	Rxvt-unicodes special way of encoding text, where one "unicode"
		235	character always represents one screen cell. See ROW_t for a
		236	discussion of this format.
		237
		238	$string
		239	A perl text string, with an emphasis on text. It can store all
		240	unicode characters and is to be distinguished with text encoded in a
		241	specific encoding (often locale-specific) and binary data.
		242
		243	$octets
		244	Either binary data or - more common - a text string encoded in a
		245	locale-specific way.
		246
		247	Extension Objects
		248	Very perl extension is a perl class. A separate perl object is created
		249	for each terminal and each extension and passed as the first parameter
		250	to hooks. So extensions can use their $self object without having to
		251	think about other extensions, with the exception of methods and members
		252	that begin with an underscore character "_": these are reserved for
		253	internal use.
		254
		255	Although it isn't a "urxvt::term" object, you can call all methods of
		256	the "urxvt::term" class on this object.
		257
		258	It has the following methods and data members:
		259
		260	$urxvt_term = $self->{term}
		261	Returns the "urxvt::term" object associated with this instance of
		262	the extension. This member must not be changed in any way.
		263
		264	$self->enable ($hook_name => $cb, [$hook_name => $cb..])
		265	Dynamically enable the given hooks (named without the "on_" prefix)
		266	for this extension, replacing any previous hook. This is useful when
		267	you want to overwrite time-critical hooks only temporarily.
		268
		269	$self->disable ($hook_name[, $hook_name..])
		270	Dynamically disable the given hooks.
		271
62	Hooks	272	Hooks
63	The following subroutines can be declared in loaded scripts, and will be	273	The following subroutines can be declared in extension files, and will
64	called whenever the relevant event happens.	274	be called whenever the relevant event happens.
65		275
66	All of them must return a boolean value. If it is true, then the event	276	The first argument passed to them is an extension oject as described in
67	counts as being consumed, and the invocation of other hooks is	277	the in the "Extension Objects" section.
		278
		279	All of these hooks must return a boolean value. If any of the called
		280	hooks returns true, then the event counts as being consumed, and the
68	skipped, and the relevant action might not be carried out by the C++	281	relevant action might not be carried out by the C++ code.
69	code.
70		282
71	When in doubt, return a false value (preferably "()").	283	When in doubt, return a false value (preferably "()").
72		284
73	on_init $term	285	on_init $term
74	Called after a new terminal object has been initialized, but before	286	Called after a new terminal object has been initialized, but before
75	windows are created or the command gets run.	287	windows are created or the command gets run. Most methods are unsafe
		288	to call or deliver senseless data, as terminal size and other
		289	characteristics have not yet been determined. You can safely query
		290	and change resources and options, though. For many purposes the
		291	"on_start" hook is a better place.
		292
		293	on_start $term
		294	Called at the very end of initialisation of a new terminal, just
		295	before trying to map (display) the toplevel and returning to the
		296	mainloop.
		297
		298	on_destroy $term
		299	Called whenever something tries to destroy terminal, before doing
		300	anything yet. If this hook returns true, then destruction is
		301	skipped, but this is rarely a good idea.
76		302
77	on_reset $term	303	on_reset $term
78	Called after the screen is "reset" for any reason, such as resizing	304	Called after the screen is "reset" for any reason, such as resizing
79	or control sequences. Here is where you can react on changes to	305	or control sequences. Here is where you can react on changes to
80	size-related variables.	306	size-related variables.
81		307
82	on_start $term	308	on_child_start $term, $pid
83	Called at the very end of initialisation of a new terminal, just	309	Called just after the child process has been "fork"ed.
84	before returning to the mainloop.	310
		311	on_child_exit $term, $status
		312	Called just after the child process has exited. $status is the
		313	status from "waitpid".
85		314
86	on_sel_make $term, $eventtime	315	on_sel_make $term, $eventtime
87	Called whenever a selection has been made by the user, but before	316	Called whenever a selection has been made by the user, but before
88	the selection text is copied, so changes to the beginning, end or	317	the selection text is copied, so changes to the beginning, end or
89	type of the selection will be honored.	318	type of the selection will be honored.
…		…
98	queried and changed by calling "$term->selection".	327	queried and changed by calling "$term->selection".
99		328
100	Returning a true value aborts selection grabbing. It will still be	329	Returning a true value aborts selection grabbing. It will still be
101	hilighted.	330	hilighted.
102		331
103	on_focus_in $term	332	on_sel_extend $term
104	Called whenever the window gets the keyboard focus, before urxvt	333	Called whenever the user tries to extend the selection (e.g. with a
105	does focus in processing.	334	double click) and is either supposed to return false (normal
		335	operation), or should extend the selection itelf and return true to
		336	suppress the built-in processing. This can happen multiple times, as
		337	long as the callback returns true, it will be called on every
		338	further click by the user and is supposed to enlarge the selection
		339	more and more, if possible.
106		340
107	on_focus_out $term	341	See the selection example extension.
108	Called wheneever the window loses keyboard focus, before urxvt does
109	focus out processing.
110		342
111	on_view_change $term, $offset	343	on_view_change $term, $offset
112	Called whenever the view offset changes, i..e the user or program	344	Called whenever the view offset changes, i..e the user or program
113	scrolls. Offset 0 means display the normal terminal, positive values	345	scrolls. Offset 0 means display the normal terminal, positive values
114	show this many lines of scrollback.	346	show this many lines of scrollback.
…		…
120		352
121	It is called before lines are scrolled out (so rows 0 .. min ($lines	353	It is called before lines are scrolled out (so rows 0 .. min ($lines
122	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	354	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
123	the total number of lines that will be in the scrollback buffer.	355	the total number of lines that will be in the scrollback buffer.
124		356
125	on_tty_activity $term NYI	357	on_osc_seq $term, $string
126	Called whenever the program(s) running in the urxvt window send	358	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
127	output.	359	operating system command) is processed. Cursor position and other
		360	state information is up-to-date when this happens. For
		361	interoperability, the string should start with the extension name
		362	and a colon, to distinguish it from commands for other extensions,
		363	and this might be enforced in the future.
		364
		365	Be careful not ever to trust (in a security sense) the data you
		366	receive, as its source can not easily be controleld (e-mail content,
		367	messages from other users on the same system etc.).
		368
		369	on_add_lines $term, $string
		370	Called whenever text is about to be output, with the text as
		371	argument. You can filter/change and output the text yourself by
		372	returning a true value and calling "$term->scr_add_lines" yourself.
		373	Please note that this might be very slow, however, as your hook is
		374	called for all text being output.
		375
		376	on_tt_write $term, $octets
		377	Called whenever some data is written to the tty/pty and can be used
		378	to suppress or filter tty input.
		379
		380	on_line_update $term, $row
		381	Called whenever a line was updated or changed. Can be used to filter
		382	screen output (e.g. underline urls or other useless stuff). Only
		383	lines that are being shown will be filtered, and, due to performance
		384	reasons, not always immediately.
		385
		386	The row number is always the topmost row of the line if the line
		387	spans multiple rows.
		388
		389	Please note that, if you change the line, then the hook might get
		390	called later with the already-modified line (e.g. if unrelated parts
		391	change), so you cannot just toggle rendition bits, but only set
		392	them.
128		393
129	on_refresh_begin $term	394	on_refresh_begin $term
130	Called just before the screen gets redrawn. Can be used for overlay	395	Called just before the screen gets redrawn. Can be used for overlay
131	or similar effects by modify terminal contents in refresh_begin, and	396	or similar effects by modify terminal contents in refresh_begin, and
132	restoring them in refresh_end. The built-in overlay and selection	397	restoring them in refresh_end. The built-in overlay and selection
…		…
138	on_keyboard_command $term, $string	403	on_keyboard_command $term, $string
139	Called whenever the user presses a key combination that has a	404	Called whenever the user presses a key combination that has a
140	"perl:string" action bound to it (see description of the keysym	405	"perl:string" action bound to it (see description of the keysym
141	resource in the rxvt(1) manpage).	406	resource in the rxvt(1) manpage).
142		407
		408	on_x_event $term, $event
		409	Called on every X event received on the vt window (and possibly
		410	other windows). Should only be used as a last resort. Most event
		411	structure members are not passed.
		412
		413	on_focus_in $term
		414	Called whenever the window gets the keyboard focus, before
		415	rxvt-unicode does focus in processing.
		416
		417	on_focus_out $term
		418	Called wheneever the window loses keyboard focus, before
		419	rxvt-unicode does focus out processing.
		420
		421	on_configure_notify $term, $event
		422	on_key_press $term, $event, $keysym, $octets
		423	on_key_release $term, $event, $keysym
		424	on_button_press $term, $event
		425	on_button_release $term, $event
		426	on_motion_notify $term, $event
		427	on_map_notify $term, $event
		428	on_unmap_notify $term, $event
		429	Called whenever the corresponding X event is received for the
		430	terminal If the hook returns true, then the even will be ignored by
		431	rxvt-unicode.
		432
		433	The event is a hash with most values as named by Xlib (see the
		434	XEvent manpage), with the additional members "row" and "col", which
		435	are the row and column under the mouse cursor.
		436
		437	"on_key_press" additionally receives the string rxvt-unicode would
		438	output, if any, in locale-specific encoding.
		439
		440	subwindow.
		441
		442	on_client_message $term, $event
		443	on_wm_protocols $term, $event
		444	on_wm_delete_window $term, $event
		445	Called when various types of ClientMessage events are received (all
		446	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		447
		448	Variables in the "urxvt" Package
		449	$urxvt::LIBDIR
		450	The rxvt-unicode library directory, where, among other things, the
		451	perl modules and scripts are stored.
		452
		453	$urxvt::RESCLASS, $urxvt::RESCLASS
		454	The resource class and name rxvt-unicode uses to look up X
		455	resources.
		456
		457	$urxvt::RXVTNAME
		458	The basename of the installed binaries, usually "urxvt".
		459
		460	$urxvt::TERM
		461	The current terminal. This variable stores the current "urxvt::term"
		462	object, whenever a callback/hook is executing.
		463
		464	@urxvt::TERM_INIT
		465	All coderefs in this array will be called as methods of the next
		466	newly created "urxvt::term" object (during the "on_init" phase). The
		467	array gets cleared before the codereferences that were in it are
		468	being executed, so coderefs can push themselves onto it again if
		469	they so desire.
		470
		471	This complements to the perl-eval commandline option, but gets
		472	executed first.
		473
		474	@urxvt::TERM_EXT
		475	Works similar to @TERM_INIT, but contains perl package/class names,
		476	which get registered as normal extensions after calling the hooks in
		477	@TERM_INIT but before other extensions. Gets cleared just like
		478	@TERM_INIT.
		479
143	Functions in the "urxvt" Package	480	Functions in the "urxvt" Package
144	urxvt::fatal $errormessage	481	urxvt::fatal $errormessage
145	Fatally aborts execution with the given error message. Avoid at all	482	Fatally aborts execution with the given error message. Avoid at all
146	costs! The only time this is acceptable is when the terminal process	483	costs! The only time this is acceptable is when the terminal process
147	starts up.	484	starts up.
…		…
152	function that calls this function.	489	function that calls this function.
153		490
154	Using this function has the advantage that its output ends up in the	491	Using this function has the advantage that its output ends up in the
155	correct place, e.g. on stderr of the connecting urxvtc client.	492	correct place, e.g. on stderr of the connecting urxvtc client.
156		493
		494	Messages have a size limit of 1023 bytes currently.
		495
157	$time = urxvt::NOW	496	$time = urxvt::NOW
158	Returns the "current time" (as per the event loop).	497	Returns the "current time" (as per the event loop).
		498
		499	urxvt::CurrentTime
		500	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
		501	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
		502	Button5Mask, AnyModifier
		503	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		504	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		505	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		506	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		507	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		508	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		509	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		510	ColormapChangeMask, OwnerGrabButtonMask
		511	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		512	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		513	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		514	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		515	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		516	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		517	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		518	Various constants for use in X calls and event processing.
159		519
160	RENDITION	520	RENDITION
161	Rendition bitsets contain information about colour, font, font styles	521	Rendition bitsets contain information about colour, font, font styles
162	and similar information for each screen cell.	522	and similar information for each screen cell.
163		523
…		…
181		541
182	$foreground = urxvt::GET_BASEFG $rend	542	$foreground = urxvt::GET_BASEFG $rend
183	$background = urxvt::GET_BASEBG $rend	543	$background = urxvt::GET_BASEBG $rend
184	Return the foreground/background colour index, respectively.	544	Return the foreground/background colour index, respectively.
185		545
186	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	546	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
187	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	547	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
188	Replace the foreground/background colour in the rendition mask with	548	Replace the foreground/background colour in the rendition mask with
189	the specified one.	549	the specified one.
190		550
191	$value = urxvt::GET_CUSTOM ($rend)	551	$value = urxvt::GET_CUSTOM $rend
192	Return the "custom" value: Every rendition has 5 bits for use by	552	Return the "custom" value: Every rendition has 5 bits for use by
193	extensions. They can be set and changed as you like and are	553	extensions. They can be set and changed as you like and are
194	initially zero.	554	initially zero.
195		555
196	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	556	$rend = urxvt::SET_CUSTOM $rend, $new_value
197	Change the custom value.	557	Change the custom value.
198		558
		559	The "urxvt::anyevent" Class
		560	The sole purpose of this class is to deliver an interface to the
		561	"AnyEvent" module - any module using it will work inside urxvt without
		562	further programming. The only exception is that you cannot wait on
		563	condition variables, but non-blocking condvar use is ok. What this means
		564	is that you cannot use blocking APIs, but the non-blocking variant
		565	should work.
		566
199	The "urxvt::term" Class	567	The "urxvt::term" Class
		568	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		569	Creates a new terminal, very similar as if you had started it with
		570	system "$rxvtname, arg...". $envhashref must be a reference to a
		571	%ENV-like hash which defines the environment of the new terminal.
		572
		573	Croaks (and probably outputs an error message) if the new instance
		574	couldn't be created. Returns "undef" if the new instance didn't
		575	initialise perl, and the terminal object otherwise. The "init" and
		576	"start" hooks will be called during this call.
		577
		578	$term->destroy
		579	Destroy the terminal object (close the window, free resources etc.).
		580	Please note that rxvt will not exit as long as any event watchers
		581	(timers, io watchers) are still active.
		582
		583	$term->exec_async ($cmd[, @args])
		584	Works like the combination of the "fork"/"exec" builtins, which
		585	executes ("starts") programs in the background. This function takes
		586	care of setting the user environment before exec'ing the command
		587	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		588	or "system".
		589
		590	Returns the pid of the subprocess or "undef" on error.
		591
		592	$isset = $term->option ($optval[, $set])
		593	Returns true if the option specified by $optval is enabled, and
		594	optionally change it. All option values are stored by name in the
		595	hash %urxvt::OPTION. Options not enabled in this binary are not in
		596	the hash.
		597
		598	Here is a a likely non-exhaustive list of option names, please see
		599	the source file /src/optinc.h to see the actual list:
		600
		601	borderLess console cursorBlink cursorUnderline hold iconic insecure
		602	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		603	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		604	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		605	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		606	transparent tripleclickwords utmpInhibit visualBell
		607
200	$value = $term->resource ($name[, $newval])	608	$value = $term->resource ($name[, $newval])
201	Returns the current resource value associated with a given name and	609	Returns the current resource value associated with a given name and
202	optionally sets a new value. Setting values is most useful in the	610	optionally sets a new value. Setting values is most useful in the
203	"init" hook. Unset resources are returned and accepted as "undef".	611	"init" hook. Unset resources are returned and accepted as "undef".
204		612
…		…
213	Please note that resource strings will currently only be freed when	621	Please note that resource strings will currently only be freed when
214	the terminal is destroyed, so changing options frequently will eat	622	the terminal is destroyed, so changing options frequently will eat
215	memory.	623	memory.
216		624
217	Here is a a likely non-exhaustive list of resource names, not all of	625	Here is a a likely non-exhaustive list of resource names, not all of
218	which are supported in every build, please see the source to see the	626	which are supported in every build, please see the source file
219	actual list:	627	/src/rsinc.h to see the actual list:
220		628
221	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	629	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
222	borderLess color cursorBlink cursorUnderline cutchars delete_key	630	borderLess color cursorBlink cursorUnderline cutchars delete_key
223	display_name embed ext_bwidth fade font geometry hold iconName	631	display_name embed ext_bwidth fade font geometry hold iconName
224	imFont imLocale inputMethod insecure int_bwidth intensityStyles	632	imFont imLocale inputMethod insecure int_bwidth intensityStyles
225	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	633	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
226	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	634	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
227	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	635	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
228	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	636	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
229	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	637	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
230	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	638	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		639	secondaryScreen secondaryScroll selectstyle shade term_name title
231	shade term_name title transparent transparent_all tripleclickwords	640	transient_for transparent transparent_all tripleclickwords utmpInhibit
232	utmpInhibit visualBell	641	visualBell
		642
		643	$value = $term->x_resource ($pattern)
		644	Returns the X-Resource for the given pattern, excluding the program
		645	or class name, i.e. "$term->x_resource ("boldFont")" should return
		646	the same value as used by this instance of rxvt-unicode. Returns
		647	"undef" if no resource with that pattern exists.
		648
		649	This method should only be called during the "on_start" hook, as
		650	there is only one resource database per display, and later
		651	invocations might return the wrong resources.
		652
		653	$success = $term->parse_keysym ($keysym_spec, $command_string)
		654	Adds a keymap translation exactly as specified via a resource. See
		655	the "keysym" resource in the rxvt(1) manpage.
		656
		657	$rend = $term->rstyle ([$new_rstyle])
		658	Return and optionally change the current rendition. Text that is
		659	output by the terminal application will use this style.
		660
		661	($row, $col) = $term->screen_cur ([$row, $col])
		662	Return the current coordinates of the text cursor position and
		663	optionally set it (which is usually bad as applications don't expect
		664	that).
233		665
234	($row, $col) = $term->selection_mark ([$row, $col])	666	($row, $col) = $term->selection_mark ([$row, $col])
235	($row, $col) = $term->selection_beg ([$row, $col])	667	($row, $col) = $term->selection_beg ([$row, $col])
236	($row, $col) = $term->selection_end ([$row, $col])	668	($row, $col) = $term->selection_end ([$row, $col])
237	Return the current values of the selection mark, begin or end	669	Return the current values of the selection mark, begin or end
238	positions, and optionally set them to new values.	670	positions, and optionally set them to new values.
239		671
		672	$term->selection_make ($eventtime[, $rectangular])
		673	Tries to make a selection as set by "selection_beg" and
		674	"selection_end". If $rectangular is true (default: false), a
		675	rectangular selection will be made. This is the prefered function to
		676	make a selection.
		677
240	$success = $term->selection_grab ($eventtime)	678	$success = $term->selection_grab ($eventtime)
241	Try to request the primary selection from the server (for example,	679	Try to request the primary selection text from the server (for
242	as set by the next method).	680	example, as set by the next method). No visual feedback will be
		681	given. This function is mostly useful from within "on_sel_grab"
		682	hooks.
243		683
244	$oldtext = $term->selection ([$newtext])	684	$oldtext = $term->selection ([$newtext])
245	Return the current selection text and optionally replace it by	685	Return the current selection text and optionally replace it by
246	$newtext.	686	$newtext.
247		687
248	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	688	$term->overlay_simple ($x, $y, $text)
249	overlay box. See the next method for details. # #=cut	689	Create a simple multi-line overlay box. See the next method for
250		690	details.
251	sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_;
252
253	my @lines = split /\n/, $text;
254
255	my $w = 0;
256	for (map $self->strwidth ($_), @lines) {
257	$w = $_ if $w < $_;
258	}
259
260	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
261	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
262	}
263		691
264	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	692	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
265	Create a new (empty) overlay at the given position with the given	693	Create a new (empty) overlay at the given position with the given
266	width/height. $rstyle defines the initial rendition style (default:	694	width/height. $rstyle defines the initial rendition style (default:
267	"OVERLAY_RSTYLE").	695	"OVERLAY_RSTYLE").
…		…
273	right/bottom side, respectively.	701	right/bottom side, respectively.
274		702
275	This method returns an urxvt::overlay object. The overlay will be	703	This method returns an urxvt::overlay object. The overlay will be
276	visible as long as the perl object is referenced.	704	visible as long as the perl object is referenced.
277		705
278	Currently, the only method on the "urxvt::overlay" object is "set":	706	The methods currently supported on "urxvt::overlay" objects are:
279		707
280	$overlay->set ($x, $y, $text, $rend)	708	$overlay->set ($x, $y, $text, $rend)
281	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts text in	709	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
282	rxvt-unicode's special encoding and an array of rendition values at	710	text in rxvt-unicode's special encoding and an array of
283	a specific position inside the overlay.	711	rendition values at a specific position inside the overlay.
284		712
		713	$overlay->hide
		714	If visible, hide the overlay, but do not destroy it.
		715
		716	$overlay->show
		717	If hidden, display the overlay again.
		718
		719	$popup = $term->popup ($event)
		720	Creates a new "urxvt::popup" object that implements a popup menu.
		721	The $event must be the event causing the menu to pop up (a button
		722	event, currently).
		723
285	$cellwidth = $term->strwidth $string	724	$cellwidth = $term->strwidth ($string)
286	Returns the number of screen-cells this string would need. Correctly	725	Returns the number of screen-cells this string would need. Correctly
287	accounts for wide and combining characters.	726	accounts for wide and combining characters.
288		727
289	$octets = $term->locale_encode $string	728	$octets = $term->locale_encode ($string)
290	Convert the given text string into the corresponding locale	729	Convert the given text string into the corresponding locale
291	encoding.	730	encoding.
292		731
293	$string = $term->locale_decode $octets	732	$string = $term->locale_decode ($octets)
294	Convert the given locale-encoded octets into a perl string.	733	Convert the given locale-encoded octets into a perl string.
		734
		735	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		736	XORs the rendition values in the given span with the provided value
		737	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
		738	in refresh hooks to provide effects similar to the selection.
		739
		740	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
		741	$rstyle2]])
		742	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
		743	whitespace will additionally be xored with the $rstyle2, which
		744	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
		745	and underlines it instead. Both styles MUST NOT contain font
		746	styles.
		747
		748	$term->scr_bell
		749	Ring the bell!
		750
		751	$term->scr_add_lines ($string)
		752	Write the given text string to the screen, as if output by the
		753	application running inside the terminal. It may not contain command
		754	sequences (escape codes), but is free to use line feeds, carriage
		755	returns and tabs. The string is a normal text string, not in
		756	locale-dependent encoding.
		757
		758	Normally its not a good idea to use this function, as programs might
		759	be confused by changes in cursor position or scrolling. Its useful
		760	inside a "on_add_lines" hook, though.
		761
		762	$term->cmd_parse ($octets)
		763	Similar to "scr_add_lines", but the argument must be in the
		764	locale-specific encoding of the terminal and can contain command
		765	sequences (escape codes) that will be interpreted.
295		766
296	$term->tt_write ($octets)	767	$term->tt_write ($octets)
297	Write the octets given in $data to the tty (i.e. as program input).	768	Write the octets given in $data to the tty (i.e. as program input).
298	To pass characters instead of octets, you should convert your	769	To pass characters instead of octets, you should convert your
299	strings first to the locale-specific encoding using	770	strings first to the locale-specific encoding using
300	"$term->locale_encode".	771	"$term->locale_encode".
301		772
		773	$old_events = $term->pty_ev_events ([$new_events])
		774	Replaces the event mask of the pty watcher by the given event mask.
		775	Can be used to suppress input and output handling to the pty/tty.
		776	See the description of "urxvt::timer->events". Make sure to always
		777	restore the previous value.
		778
		779	$windowid = $term->parent
		780	Return the window id of the toplevel window.
		781
		782	$windowid = $term->vt
		783	Return the window id of the terminal window.
		784
		785	$term->vt_emask_add ($x_event_mask)
		786	Adds the specified events to the vt event mask. Useful e.g. when you
		787	want to receive pointer events all the times:
		788
		789	$term->vt_emask_add (urxvt::PointerMotionMask);
		790
		791	$window_width = $term->width
		792	$window_height = $term->height
		793	$font_width = $term->fwidth
		794	$font_height = $term->fheight
		795	$font_ascent = $term->fbase
302	$nrow = $term->nrow	796	$terminal_rows = $term->nrow
303	$ncol = $term->ncol	797	$terminal_columns = $term->ncol
304	Return the number of rows/columns of the terminal window (i.e. as	798	$has_focus = $term->focus
305	specified by "-geometry", excluding any scrollback).	799	$is_mapped = $term->mapped
		800	$max_scrollback = $term->saveLines
		801	$nrow_plus_saveLines = $term->total_rows
		802	$topmost_scrollback_row = $term->top_row
		803	Return various integers describing terminal characteristics.
306		804
		805	$x_display = $term->display_id
		806	Return the DISPLAY used by rxvt-unicode.
		807
		808	$lc_ctype = $term->locale
		809	Returns the LC_CTYPE category string used by this rxvt-unicode.
		810
307	$nsaved = $term->nsaved	811	$env = $term->env
308	Returns the number of lines in the scrollback buffer.	812	Returns a copy of the environment in effect for the terminal as a
		813	hashref similar to "\%ENV".
		814
		815	$modifiermask = $term->ModLevel3Mask
		816	$modifiermask = $term->ModMetaMask
		817	$modifiermask = $term->ModNumLockMask
		818	Return the modifier masks corresponding to the "ISO Level 3 Shift"
		819	(often AltGr), the meta key (often Alt) and the num lock key, if
		820	applicable.
309		821
310	$view_start = $term->view_start ([$newvalue])	822	$view_start = $term->view_start ([$newvalue])
311	Returns the negative row number of the topmost line. Minimum value	823	Returns the row number of the topmost displayed line. Maximum value
312	is 0, which displays the normal terminal contents. Larger values	824	is 0, which displays the normal terminal contents. Lower values
313	scroll this many lines into the scrollback buffer.	825	scroll this many lines into the scrollback buffer.
314		826
315	$term->want_refresh	827	$term->want_refresh
316	Requests a screen refresh. At the next opportunity, rxvt-unicode	828	Requests a screen refresh. At the next opportunity, rxvt-unicode
317	will compare the on-screen display with its stored representation.	829	will compare the on-screen display with its stored representation.
…		…
321		833
322	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	834	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
323	Returns the text of the entire row with number $row_number. Row 0 is	835	Returns the text of the entire row with number $row_number. Row 0 is
324	the topmost terminal line, row "$term->$ncol-1" is the bottommost	836	the topmost terminal line, row "$term->$ncol-1" is the bottommost
325	terminal line. The scrollback buffer starts at line -1 and extends	837	terminal line. The scrollback buffer starts at line -1 and extends
326	to line "-$term->nsaved".	838	to line "-$term->nsaved". Nothing will be returned if a nonexistent
		839	line is requested.
327		840
328	If $new_text is specified, it will replace characters in the current	841	If $new_text is specified, it will replace characters in the current
329	line, starting at column $start_col (default 0), which is useful to	842	line, starting at column $start_col (default 0), which is useful to
330	replace only parts of a line. The font index in the rendition will	843	replace only parts of a line. The font index in the rendition will
331	automatically be updated.	844	automatically be updated.
…		…
352		865
353	See the section on RENDITION, above.	866	See the section on RENDITION, above.
354		867
355	$length = $term->ROW_l ($row_number[, $new_length])	868	$length = $term->ROW_l ($row_number[, $new_length])
356	Returns the number of screen cells that are in use ("the line	869	Returns the number of screen cells that are in use ("the line
357	length"). If it is -1, then the line is part of a multiple-row	870	length"). Unlike the urxvt core, this returns "$term->ncol" if the
358	logical "line", which means all characters are in use and it is	871	line is joined with the following one.
359	continued on the next row.	872
		873	$bool = $term->is_longer ($row_number)
		874	Returns true if the row is part of a multiple-row logical "line"
		875	(i.e. joined with the following row), which means all characters are
		876	in use and it is continued on the next row (and possibly a
		877	continuation of the previous row(s)).
		878
		879	$line = $term->line ($row_number)
		880	Create and return a new "urxvt::line" object that stores information
		881	about the logical line that row $row_number is part of. It supports
		882	the following methods:
		883
		884	$text = $line->t ([$new_text])
		885	Returns or replaces the full text of the line, similar to
		886	"ROW_t"
		887
		888	$rend = $line->r ([$new_rend])
		889	Returns or replaces the full rendition array of the line,
		890	similar to "ROW_r"
		891
		892	$length = $line->l
		893	Returns the length of the line in cells, similar to "ROW_l".
		894
		895	$rownum = $line->beg
		896	$rownum = $line->end
		897	Return the row number of the first/last row of the line,
		898	respectively.
		899
		900	$offset = $line->offset_of ($row, $col)
		901	Returns the character offset of the given row\|col pair within
		902	the logical line. Works for rows outside the line, too, and
		903	returns corresponding offsets outside the string.
		904
		905	($row, $col) = $line->coord_of ($offset)
		906	Translates a string offset into terminal coordinates again.
360		907
361	$text = $term->special_encode $string	908	$text = $term->special_encode $string
362	Converts a perl string into the special encoding used by	909	Converts a perl string into the special encoding used by
363	rxvt-unicode, where one character corresponds to one screen cell.	910	rxvt-unicode, where one character corresponds to one screen cell.
364	See "$term->ROW_t" for details.	911	See "$term->ROW_t" for details.
365		912
366	$string = $term->special_decode $text	913	$string = $term->special_decode $text
367	Converts rxvt-unicodes text reprsentation into a perl string. See	914	Converts rxvt-unicodes text reprsentation into a perl string. See
368	"$term->ROW_t" for details.	915	"$term->ROW_t" for details.
		916
		917	$success = $term->grab_button ($button, $modifiermask)
		918	Registers a synchronous button grab. See the XGrabButton manpage.
		919
		920	$success = $term->grab ($eventtime[, $sync])
		921	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		922	synchronous ($sync is true). Also remembers the grab timestampe.
		923
		924	$term->allow_events_async
		925	Calls XAllowEvents with AsyncBoth for the most recent grab.
		926
		927	$term->allow_events_sync
		928	Calls XAllowEvents with SyncBoth for the most recent grab.
		929
		930	$term->allow_events_replay
		931	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		932	the most recent grab.
		933
		934	$term->ungrab
		935	Calls XUngrab for the most recent grab. Is called automatically on
		936	evaluation errors, as it is better to lose the grab in the error
		937	case as the session.
		938
		939	The "urxvt::popup" Class
		940	$popup->add_title ($title)
		941	Adds a non-clickable title to the popup.
		942
		943	$popup->add_separator ([$sepchr])
		944	Creates a separator, optionally using the character given as
		945	$sepchr.
		946
		947	$popup->add_button ($text, $cb)
		948	Adds a clickable button to the popup. $cb is called whenever it is
		949	selected.
		950
		951	$popup->add_toggle ($text, $cb, $initial_value)
		952	Adds a toggle/checkbox item to the popup. Teh callback gets called
		953	whenever it gets toggled, with a boolean indicating its value as its
		954	first argument.
		955
		956	$popup->show
		957	Displays the popup (which is initially hidden).
369		958
370	The "urxvt::timer" Class	959	The "urxvt::timer" Class
371	This class implements timer watchers/events. Time is represented as a	960	This class implements timer watchers/events. Time is represented as a
372	fractional number of seconds since the epoch. Example:	961	fractional number of seconds since the epoch. Example:
373		962
…		…
402	Start the timer.	991	Start the timer.
403		992
404	$timer = $timer->start ($tstamp)	993	$timer = $timer->start ($tstamp)
405	Set the event trigger time to $tstamp and start the timer.	994	Set the event trigger time to $tstamp and start the timer.
406		995
		996	$timer = $timer->after ($delay)
		997	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
		998
407	$timer = $timer->stop	999	$timer = $timer->stop
408	Stop the timer.	1000	Stop the timer.
409		1001
410	The "urxvt::iow" Class	1002	The "urxvt::iow" Class
411	This class implements io watchers/events. Example:	1003	This class implements io watchers/events. Example:
412		1004
413	$term->{socket} = ...	1005	$term->{socket} = ...
414	$term->{iow} = urxvt::iow	1006	$term->{iow} = urxvt::iow
415	->new	1007	->new
416	->fd (fileno $term->{socket})	1008	->fd (fileno $term->{socket})
417	->events (1) # wait for read data	1009	->events (urxvt::EVENT_READ)
418	->start	1010	->start
419	->cb (sub {	1011	->cb (sub {
420	my ($iow, $revents) = @_;	1012	my ($iow, $revents) = @_;
421	# $revents must be 1 here, no need to check	1013	# $revents must be 1 here, no need to check
422	sysread $term->{socket}, my $buf, 8192	1014	sysread $term->{socket}, my $buf, 8192
…		…
432		1024
433	$iow = $iow->fd ($fd)	1025	$iow = $iow->fd ($fd)
434	Set the filedescriptor (not handle) to watch.	1026	Set the filedescriptor (not handle) to watch.
435		1027
436	$iow = $iow->events ($eventmask)	1028	$iow = $iow->events ($eventmask)
437	Set the event mask to watch. Bit #0 (value 1) enables watching for	1029	Set the event mask to watch. The only allowed values are
438	read data, Bit #1 (value 2) enables watching for write data.	1030	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1031	together, or "urxvt::EVENT_NONE".
439		1032
440	$iow = $iow->start	1033	$iow = $iow->start
441	Start watching for requested events on the given handle.	1034	Start watching for requested events on the given handle.
442		1035
443	$iow = $iow->stop	1036	$iow = $iow->stop
444	Stop watching for events on the given filehandle.	1037	Stop watching for events on the given filehandle.
		1038
		1039	The "urxvt::iw" Class
		1040	This class implements idle watchers, that get called automatically when
		1041	the process is idle. They should return as fast as possible, after doing
		1042	some useful work.
		1043
		1044	$iw = new urxvt::iw
		1045	Create a new idle watcher object in stopped state.
		1046
		1047	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1048	Set the callback to be called when the watcher triggers.
		1049
		1050	$timer = $timer->start
		1051	Start the watcher.
		1052
		1053	$timer = $timer->stop
		1054	Stop the watcher.
		1055
		1056	The "urxvt::pw" Class
		1057	This class implements process watchers. They create an event whenever a
		1058	process exits, after which they stop automatically.
		1059
		1060	my $pid = fork;
		1061	...
		1062	$term->{pw} = urxvt::pw
		1063	->new
		1064	->start ($pid)
		1065	->cb (sub {
		1066	my ($pw, $exit_status) = @_;
		1067	...
		1068	});
		1069
		1070	$pw = new urxvt::pw
		1071	Create a new process watcher in stopped state.
		1072
		1073	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1074	Set the callback to be called when the timer triggers.
		1075
		1076	$pw = $timer->start ($pid)
		1077	Tells the wqtcher to start watching for process $pid.
		1078
		1079	$pw = $pw->stop
		1080	Stop the watcher.
445		1081
446	ENVIRONMENT	1082	ENVIRONMENT
447	URXVT_PERL_VERBOSITY	1083	URXVT_PERL_VERBOSITY
448	This variable controls the verbosity level of the perl extension. Higher	1084	This variable controls the verbosity level of the perl extension. Higher
449	numbers indicate more verbose output.	1085	numbers indicate more verbose output.
450		1086
451	0 - only fatal messages	1087	== 0 - fatal messages
452	3 - script loading and management	1088	>= 3 - script loading and management
453	10 - all events received	1089	>=10 - all called hooks
		1090	>=11 - hook reutrn values
454		1091
455	AUTHOR	1092	AUTHOR
456	Marc Lehmann <pcg@goof.com>	1093	Marc Lehmann <pcg@goof.com>
457	http://software.schmorp.de/pkg/rxvt-unicode	1094	http://software.schmorp.de/pkg/rxvt-unicode
458		1095

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.32 by root, Fri Jan 20 16:02:20 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.32 by root, Fri Jan 20 16:02:20 2006 UTC