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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.10 by root, Wed Jan 4 05:35:34 2006 UTC vs. Revision 1.43 by root, Mon Jul 17 19:20:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.10 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.43 by root, Mon Jul 17 19:20:29 2006 UTC