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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.3 by root, Mon Jan 2 21:41:51 2006 UTC vs. Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.3 by root, Mon Jan 2 21:41:51 2006 UTC vs.
Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC