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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.42 by root, Thu Jul 6 18:56:10 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.42 by root, Thu Jul 6 18:56:10 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.42 by root, Thu Jul 6 18:56:10 2006 UTC