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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC vs. Revision 1.40 by root, Mon Feb 6 06:14:55 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.40 by root, Mon Feb 6 06:14:55 2006 UTC