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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.5 by root, Tue Jan 3 01:45:12 2006 UTC vs. Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.5 by root, Tue Jan 3 01:45:12 2006 UTC vs.
Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC