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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.22 by root, Wed Jan 11 02:13:56 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	selection (enabled by default)
35	Miscellaneous selection modifications.	35	(More) intelligent selection. This extension tries to be more
		36	intelligent when the user extends selections (double-click). Right
		37	now, it tries to select urls and complete shell-quoted arguments,
		38	which is very convenient, too, if your ls supports
		39	"--quoting-style=shell".
		40
		41	It also offers the following bindable keyboard command:
36		42
37	rot13	43	rot13
38	Rot-13 the selection when activated. Used via keyboard trigger:	44	Rot-13 the selection when activated. Used via keyboard trigger:
39		45
40	URxvt.keysym.C-M-r: perl:selection:rot13	46	URxvt.keysym.C-M-r: perl:selection:rot13
41		47
		48	option-popup (enabled by default)
		49	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		50	options at runtime.
		51
		52	selection-popup (enabled by default)
		53	Binds a popup menu to Ctrl-Button3 that lets you convert the
		54	selection text into various other formats/action (such as uri
		55	unescaping, perl evalution, web-browser starting etc.), depending on
		56	content.
		57
		58	searchable-scrollback<hotkey> (enabled by default)
		59	Adds regex search functionality to the scrollback buffer, triggered
		60	by a hotkey (default: "M-s"). When in search mode, normal terminal
		61	input/output is suspended.
		62
		63	"/" starts an incremental regex search, "n" searches further, "p" or
		64	"N" jump to the previous match, "G" jumps to the bottom and clears
		65	the history, "enter" leaves search mode at the current position and
		66	"escape" returns to the original position.
		67
42	digital-clock	68	digital-clock
43	Displays a digital clock using the built-in overlay.	69	Displays a digital clock using the built-in overlay.
		70
		71	mark-urls
		72	Uses per-line display filtering ("on_line_update") to underline urls
		73	and make them clickable. When clicked, the program specified in the
		74	resource "urlLauncher" (default "x-www-browser") will be started.
		75
		76	block-graphics-to-ascii
		77	A not very useful example of filtering all text output to the
		78	terminal, by replacing all line-drawing characters (U+2500 ..
		79	U+259F) by a similar-looking ascii character.
44		80
45	example-refresh-hooks	81	example-refresh-hooks
46	Displays a very simple digital clock in the upper right corner of	82	Displays a very simple digital clock in the upper right corner of
47	the window. Illustrates overwriting the refresh callbacks to create	83	the window. Illustrates overwriting the refresh callbacks to create
48	your own overlays or changes.	84	your own overlays or changes.
49		85
		86	API DOCUMENTATION
50	General API Considerations	87	General API Considerations
51	All objects (such as terminals, time watchers etc.) are typical	88	All objects (such as terminals, time watchers etc.) are typical
52	reference-to-hash objects. The hash can be used to store anything you	89	reference-to-hash objects. The hash can be used to store anything you
53	like. All members starting with an underscore (such as "_ptr" or	90	like. All members starting with an underscore (such as "_ptr" or
54	"_hook") are reserved for internal uses and must not be accessed or	91	"_hook") are reserved for internal uses and MUST NOT be accessed or
55	modified).	92	modified).
56		93
57	When objects are destroyed on the C++ side, the perl object hashes are	94	When objects are destroyed on the C++ side, the perl object hashes are
58	emptied, so its best to store related objects such as time watchers and	95	emptied, so its best to store related objects such as time watchers and
59	the like inside the terminal object so they get destroyed as soon as the	96	the like inside the terminal object so they get destroyed as soon as the
60	terminal is destroyed.	97	terminal is destroyed.
61		98
		99	Argument names also often indicate the type of a parameter. Here are
		100	some hints on what they mean:
		101
		102	$text
		103	Rxvt-unicodes special way of encoding text, where one "unicode"
		104	character always represents one screen cell. See ROW_t for a
		105	discussion of this format.
		106
		107	$string
		108	A perl text string, with an emphasis on text. It can store all
		109	unicode characters and is to be distinguished with text encoded in a
		110	specific encoding (often locale-specific) and binary data.
		111
		112	$octets
		113	Either binary data or - more common - a text string encoded in a
		114	locale-specific way.
		115
		116	Extension Objects
		117	Very perl extension is a perl class. A separate perl object is created
		118	for each terminal and each extension and passed as the first parameter
		119	to hooks. So extensions can use their $self object without having to
		120	think about other extensions, with the exception of methods and members
		121	that begin with an underscore character "_": these are reserved for
		122	internal use.
		123
		124	Although it isn't a "urxvt::term" object, you can call all methods of
		125	the "urxvt::term" class on this object.
		126
		127	It has the following methods and data members:
		128
		129	$urxvt_term = $self->{term}
		130	Returns the "urxvt::term" object associated with this instance of
		131	the extension. This member must not be changed in any way.
		132
		133	$self->enable ($hook_name => $cb, [$hook_name => $cb..])
		134	Dynamically enable the given hooks (named without the "on_" prefix)
		135	for this extension, replacing any previous hook. This is useful when
		136	you want to overwrite time-critical hooks only temporarily.
		137
		138	$self->disable ($hook_name[, $hook_name..])
		139	Dynamically disable the given hooks.
		140
62	Hooks	141	Hooks
63	The following subroutines can be declared in loaded scripts, and will be	142	The following subroutines can be declared in extension files, and will
64	called whenever the relevant event happens.	143	be called whenever the relevant event happens.
65		144
		145	The first argument passed to them is an extension oject as described in
		146	the in the "Extension Objects" section.
		147
66	All of them must return a boolean value. If it is true, then the event	148	All of these hooks must return a boolean value. If it is true, then the
67	counts as being consumed, and the invocation of other hooks is	149	event counts as being consumed, and the invocation of other hooks is
68	skipped, and the relevant action might not be carried out by the C++	150	skipped, and the relevant action might not be carried out by the C++
69	code.	151	code.
70		152
71	When in doubt, return a false value (preferably "()").	153	When in doubt, return a false value (preferably "()").
72		154
73	on_init $term	155	on_init $term
74	Called after a new terminal object has been initialized, but before	156	Called after a new terminal object has been initialized, but before
75	windows are created or the command gets run.	157	windows are created or the command gets run. Most methods are unsafe
		158	to call or deliver senseless data, as terminal size and other
		159	characteristics have not yet been determined. You can safely query
		160	and change resources, though.
76		161
77	on_reset $term	162	on_reset $term
78	Called after the screen is "reset" for any reason, such as resizing	163	Called after the screen is "reset" for any reason, such as resizing
79	or control sequences. Here is where you can react on changes to	164	or control sequences. Here is where you can react on changes to
80	size-related variables.	165	size-related variables.
…		…
98	queried and changed by calling "$term->selection".	183	queried and changed by calling "$term->selection".
99		184
100	Returning a true value aborts selection grabbing. It will still be	185	Returning a true value aborts selection grabbing. It will still be
101	hilighted.	186	hilighted.
102		187
103	on_focus_in $term	188	on_sel_extend $term
104	Called whenever the window gets the keyboard focus, before urxvt	189	Called whenever the user tries to extend the selection (e.g. with a
105	does focus in processing.	190	double click) and is either supposed to return false (normal
		191	operation), or should extend the selection itelf and return true to
		192	suppress the built-in processing.
106		193
107	on_focus_out $term	194	See the selection example extension.
108	Called wheneever the window loses keyboard focus, before urxvt does
109	focus out processing.
110		195
111	on_view_change $term, $offset	196	on_view_change $term, $offset
112	Called whenever the view offset changes, i..e the user or program	197	Called whenever the view offset changes, i..e the user or program
113	scrolls. Offset 0 means display the normal terminal, positive values	198	scrolls. Offset 0 means display the normal terminal, positive values
114	show this many lines of scrollback.	199	show this many lines of scrollback.
…		…
120		205
121	It is called before lines are scrolled out (so rows 0 .. min ($lines	206	It is called before lines are scrolled out (so rows 0 .. min ($lines
122	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	207	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
123	the total number of lines that will be in the scrollback buffer.	208	the total number of lines that will be in the scrollback buffer.
124		209
125	on_tty_activity $term NYI	210	on_osc_seq $term, $string
126	Called whenever the program(s) running in the urxvt window send	211	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
127	output.	212	operating system command) is processed. Cursor position and other
		213	state information is up-to-date when this happens. For
		214	interoperability, the string should start with the extension name
		215	and a colon, to distinguish it from commands for other extensions,
		216	and this might be enforced in the future.
		217
		218	Be careful not ever to trust (in a security sense) the data you
		219	receive, as its source can not easily be controleld (e-mail content,
		220	messages from other users on the same system etc.).
		221
		222	on_add_lines $term, $string
		223	Called whenever text is about to be output, with the text as
		224	argument. You can filter/change and output the text yourself by
		225	returning a true value and calling "$term->scr_add_lines" yourself.
		226	Please note that this might be very slow, however, as your hook is
		227	called for all text being output.
		228
		229	on_tt_write $term, $octets
		230	Called whenever some data is written to the tty/pty and can be used
		231	to suppress or filter tty input.
		232
		233	on_line_update $term, $row
		234	Called whenever a line was updated or changed. Can be used to filter
		235	screen output (e.g. underline urls or other useless stuff). Only
		236	lines that are being shown will be filtered, and, due to performance
		237	reasons, not always immediately.
		238
		239	The row number is always the topmost row of the line if the line
		240	spans multiple rows.
		241
		242	Please note that, if you change the line, then the hook might get
		243	called later with the already-modified line (e.g. if unrelated parts
		244	change), so you cannot just toggle rendition bits, but only set
		245	them.
128		246
129	on_refresh_begin $term	247	on_refresh_begin $term
130	Called just before the screen gets redrawn. Can be used for overlay	248	Called just before the screen gets redrawn. Can be used for overlay
131	or similar effects by modify terminal contents in refresh_begin, and	249	or similar effects by modify terminal contents in refresh_begin, and
132	restoring them in refresh_end. The built-in overlay and selection	250	restoring them in refresh_end. The built-in overlay and selection
…		…
138	on_keyboard_command $term, $string	256	on_keyboard_command $term, $string
139	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
140	"perl:string" action bound to it (see description of the keysym	258	"perl:string" action bound to it (see description of the keysym
141	resource in the rxvt(1) manpage).	259	resource in the rxvt(1) manpage).
142		260
		261	on_focus_in $term
		262	Called whenever the window gets the keyboard focus, before
		263	rxvt-unicode does focus in processing.
		264
		265	on_focus_out $term
		266	Called wheneever the window loses keyboard focus, before
		267	rxvt-unicode does focus out processing.
		268
		269	on_key_press $term, $event, $keysym, $octets
		270	on_key_release $term, $event, $keysym
		271	on_button_press $term, $event
		272	on_button_release $term, $event
		273	on_motion_notify $term, $event
		274	on_map_notify $term, $event
		275	on_unmap_notify $term, $event
		276	Called whenever the corresponding X event is received for the
		277	terminal If the hook returns true, then the even will be ignored by
		278	rxvt-unicode.
		279
		280	The event is a hash with most values as named by Xlib (see the
		281	XEvent manpage), with the additional members "row" and "col", which
		282	are the row and column under the mouse cursor.
		283
		284	"on_key_press" additionally receives the string rxvt-unicode would
		285	output, if any, in locale-specific encoding.
		286
		287	subwindow.
		288
		289	Variables in the "urxvt" Package
		290	$urxvt::LIBDIR
		291	The rxvt-unicode library directory, where, among other things, the
		292	perl modules and scripts are stored.
		293
		294	$urxvt::RESCLASS, $urxvt::RESCLASS
		295	The resource class and name rxvt-unicode uses to look up X
		296	resources.
		297
		298	$urxvt::RXVTNAME
		299	The basename of the installed binaries, usually "urxvt".
		300
		301	$urxvt::TERM
		302	The current terminal. This variable stores the current "urxvt::term"
		303	object, whenever a callback/hook is executing.
		304
143	Functions in the "urxvt" Package	305	Functions in the "urxvt" Package
144	urxvt::fatal $errormessage	306	urxvt::fatal $errormessage
145	Fatally aborts execution with the given error message. Avoid at all	307	Fatally aborts execution with the given error message. Avoid at all
146	costs! The only time this is acceptable is when the terminal process	308	costs! The only time this is acceptable is when the terminal process
147	starts up.	309	starts up.
…		…
152	function that calls this function.	314	function that calls this function.
153		315
154	Using this function has the advantage that its output ends up in the	316	Using this function has the advantage that its output ends up in the
155	correct place, e.g. on stderr of the connecting urxvtc client.	317	correct place, e.g. on stderr of the connecting urxvtc client.
156		318
		319	Messages have a size limit of 1023 bytes currently.
		320
		321	$is_safe = urxvt::safe
		322	Returns true when it is safe to do potentially unsafe things, such
		323	as evaluating perl code specified by the user. This is true when
		324	urxvt was started setuid or setgid.
		325
157	$time = urxvt::NOW	326	$time = urxvt::NOW
158	Returns the "current time" (as per the event loop).	327	Returns the "current time" (as per the event loop).
		328
		329	urxvt::CurrentTime
		330	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
		331	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
		332	Button5Mask, AnyModifier
		333	Various constants for use in X calls and event processing.
159		334
160	RENDITION	335	RENDITION
161	Rendition bitsets contain information about colour, font, font styles	336	Rendition bitsets contain information about colour, font, font styles
162	and similar information for each screen cell.	337	and similar information for each screen cell.
163		338
…		…
181		356
182	$foreground = urxvt::GET_BASEFG $rend	357	$foreground = urxvt::GET_BASEFG $rend
183	$background = urxvt::GET_BASEBG $rend	358	$background = urxvt::GET_BASEBG $rend
184	Return the foreground/background colour index, respectively.	359	Return the foreground/background colour index, respectively.
185		360
186	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	361	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
187	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	362	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
188	Replace the foreground/background colour in the rendition mask with	363	Replace the foreground/background colour in the rendition mask with
189	the specified one.	364	the specified one.
190		365
191	$value = urxvt::GET_CUSTOM ($rend)	366	$value = urxvt::GET_CUSTOM $rend
192	Return the "custom" value: Every rendition has 5 bits for use by	367	Return the "custom" value: Every rendition has 5 bits for use by
193	extensions. They can be set and changed as you like and are	368	extensions. They can be set and changed as you like and are
194	initially zero.	369	initially zero.
195		370
196	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	371	$rend = urxvt::SET_CUSTOM $rend, $new_value
197	Change the custom value.	372	Change the custom value.
198		373
		374	The "urxvt::anyevent" Class
		375	The sole purpose of this class is to deliver an interface to the
		376	"AnyEvent" module - any module using it will work inside urxvt without
		377	further programming. The only exception is that you cannot wait on
		378	condition variables, but non-blocking condvar use is ok. What this means
		379	is that you cannot use blocking APIs, but the non-blocking variant
		380	should work.
		381
199	The "urxvt::term" Class	382	The "urxvt::term" Class
		383	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		384	Creates a new terminal, very similar as if you had started it with
		385	system "$rxvtname, arg...". $envhashref must be a reference to a
		386	%ENV-like hash which defines the environment of the new terminal.
		387
		388	Croaks (and probably outputs an error message) if the new instance
		389	couldn't be created. Returns "undef" if the new instance didn't
		390	initialise perl, and the terminal object otherwise. The "init" and
		391	"start" hooks will be called during this call.
		392
		393	$term->destroy
		394	Destroy the terminal object (close the window, free resources etc.).
		395	Please note that rxvt will not exit as long as any event watchers
		396	(timers, io watchers) are still active.
		397
		398	$isset = $term->option ($optval[, $set])
		399	Returns true if the option specified by $optval is enabled, and
		400	optionally change it. All option values are stored by name in the
		401	hash %urxvt::OPTION. Options not enabled in this binary are not in
		402	the hash.
		403
		404	Here is a a likely non-exhaustive list of option names, please see
		405	the source file /src/optinc.h to see the actual list:
		406
		407	borderLess console cursorBlink cursorUnderline hold iconic insecure
		408	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		409	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		410	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		411	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		412	tripleclickwords utmpInhibit visualBell
		413
200	$value = $term->resource ($name[, $newval])	414	$value = $term->resource ($name[, $newval])
201	Returns the current resource value associated with a given name and	415	Returns the current resource value associated with a given name and
202	optionally sets a new value. Setting values is most useful in the	416	optionally sets a new value. Setting values is most useful in the
203	"init" hook. Unset resources are returned and accepted as "undef".	417	"init" hook. Unset resources are returned and accepted as "undef".
204		418
…		…
213	Please note that resource strings will currently only be freed when	427	Please note that resource strings will currently only be freed when
214	the terminal is destroyed, so changing options frequently will eat	428	the terminal is destroyed, so changing options frequently will eat
215	memory.	429	memory.
216		430
217	Here is a a likely non-exhaustive list of resource names, not all of	431	Here is a a likely non-exhaustive list of resource names, not all of
218	which are supported in every build, please see the source to see the	432	which are supported in every build, please see the source file
219	actual list:	433	/src/rsinc.h to see the actual list:
220		434
221	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	435	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
222	borderLess color cursorBlink cursorUnderline cutchars delete_key	436	borderLess color cursorBlink cursorUnderline cutchars delete_key
223	display_name embed ext_bwidth fade font geometry hold iconName	437	display_name embed ext_bwidth fade font geometry hold iconName
224	imFont imLocale inputMethod insecure int_bwidth intensityStyles	438	imFont imLocale inputMethod insecure int_bwidth intensityStyles
225	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	439	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
226	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	440	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
227	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	441	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
228	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	442	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
229	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	443	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
230	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	444	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
231	shade term_name title transparent transparent_all tripleclickwords	445	shade term_name title transparent transparent_all tripleclickwords
232	utmpInhibit visualBell	446	utmpInhibit visualBell
233		447
		448	$value = $term->x_resource ($pattern)
		449	Returns the X-Resource for the given pattern, excluding the program
		450	or class name, i.e. "$term->x_resource ("boldFont")" should return
		451	the same value as used by this instance of rxvt-unicode. Returns
		452	"undef" if no resource with that pattern exists.
		453
		454	This method should only be called during the "on_start" hook, as
		455	there is only one resource database per display, and later
		456	invocations might return the wrong resources.
		457
		458	$success = $term->parse_keysym ($keysym_spec, $command_string)
		459	Adds a keymap translation exactly as specified via a resource. See
		460	the "keysym" resource in the rxvt(1) manpage.
		461
		462	$rend = $term->rstyle ([$new_rstyle])
		463	Return and optionally change the current rendition. Text that is
		464	output by the terminal application will use this style.
		465
		466	($row, $col) = $term->screen_cur ([$row, $col])
		467	Return the current coordinates of the text cursor position and
		468	optionally set it (which is usually bad as applications don't expect
		469	that).
		470
234	($row, $col) = $term->selection_mark ([$row, $col])	471	($row, $col) = $term->selection_mark ([$row, $col])
235	($row, $col) = $term->selection_beg ([$row, $col])	472	($row, $col) = $term->selection_beg ([$row, $col])
236	($row, $col) = $term->selection_end ([$row, $col])	473	($row, $col) = $term->selection_end ([$row, $col])
237	Return the current values of the selection mark, begin or end	474	Return the current values of the selection mark, begin or end
238	positions, and optionally set them to new values.	475	positions, and optionally set them to new values.
…		…
243		480
244	$oldtext = $term->selection ([$newtext])	481	$oldtext = $term->selection ([$newtext])
245	Return the current selection text and optionally replace it by	482	Return the current selection text and optionally replace it by
246	$newtext.	483	$newtext.
247		484
248	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	485	$term->overlay_simple ($x, $y, $text)
249	overlay box. See the next method for details. # #=cut	486	Create a simple multi-line overlay box. See the next method for
250		487	details.
251	sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_;
252
253	my @lines = split /\n/, $text;
254
255	my $w = 0;
256	for (map $self->strwidth ($_), @lines) {
257	$w = $_ if $w < $_;
258	}
259
260	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
261	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
262	}
263		488
264	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	489	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
265	Create a new (empty) overlay at the given position with the given	490	Create a new (empty) overlay at the given position with the given
266	width/height. $rstyle defines the initial rendition style (default:	491	width/height. $rstyle defines the initial rendition style (default:
267	"OVERLAY_RSTYLE").	492	"OVERLAY_RSTYLE").
…		…
273	right/bottom side, respectively.	498	right/bottom side, respectively.
274		499
275	This method returns an urxvt::overlay object. The overlay will be	500	This method returns an urxvt::overlay object. The overlay will be
276	visible as long as the perl object is referenced.	501	visible as long as the perl object is referenced.
277		502
278	Currently, the only method on the "urxvt::overlay" object is "set":	503	The methods currently supported on "urxvt::overlay" objects are:
279		504
280	$overlay->set ($x, $y, $text, $rend)	505	$overlay->set ($x, $y, $text, $rend)
281	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts text in	506	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
282	rxvt-unicode's special encoding and an array of rendition values at	507	text in rxvt-unicode's special encoding and an array of
283	a specific position inside the overlay.	508	rendition values at a specific position inside the overlay.
284		509
		510	$overlay->hide
		511	If visible, hide the overlay, but do not destroy it.
		512
		513	$overlay->show
		514	If hidden, display the overlay again.
		515
		516	$popup = $term->popup ($event)
		517	Creates a new "urxvt::popup" object that implements a popup menu.
		518	The $event must be the event causing the menu to pop up (a button
		519	event, currently).
		520
285	$cellwidth = $term->strwidth $string	521	$cellwidth = $term->strwidth ($string)
286	Returns the number of screen-cells this string would need. Correctly	522	Returns the number of screen-cells this string would need. Correctly
287	accounts for wide and combining characters.	523	accounts for wide and combining characters.
288		524
289	$octets = $term->locale_encode $string	525	$octets = $term->locale_encode ($string)
290	Convert the given text string into the corresponding locale	526	Convert the given text string into the corresponding locale
291	encoding.	527	encoding.
292		528
293	$string = $term->locale_decode $octets	529	$string = $term->locale_decode ($octets)
294	Convert the given locale-encoded octets into a perl string.	530	Convert the given locale-encoded octets into a perl string.
		531
		532	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		533	XORs the rendition values in the given span with the provided value
		534	(default: "RS_RVid"). Useful in refresh hooks to provide effects
		535	similar to the selection.
		536
		537	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
		538	$rstyle2]])
		539	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
		540	whitespace will additionally be xored with the $rstyle2, which
		541	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
		542	and underlines it instead.
		543
		544	$term->scr_bell
		545	Ring the bell!
		546
		547	$term->scr_add_lines ($string)
		548	Write the given text string to the screen, as if output by the
		549	application running inside the terminal. It may not contain command
		550	sequences (escape codes), but is free to use line feeds, carriage
		551	returns and tabs. The string is a normal text string, not in
		552	locale-dependent encoding.
		553
		554	Normally its not a good idea to use this function, as programs might
		555	be confused by changes in cursor position or scrolling. Its useful
		556	inside a "on_add_lines" hook, though.
		557
		558	$term->cmd_parse ($octets)
		559	Similar to "scr_add_lines", but the argument must be in the
		560	locale-specific encoding of the terminal and can contain command
		561	sequences (escape codes) that will be interpreted.
295		562
296	$term->tt_write ($octets)	563	$term->tt_write ($octets)
297	Write the octets given in $data to the tty (i.e. as program input).	564	Write the octets given in $data to the tty (i.e. as program input).
298	To pass characters instead of octets, you should convert your	565	To pass characters instead of octets, you should convert your
299	strings first to the locale-specific encoding using	566	strings first to the locale-specific encoding using
300	"$term->locale_encode".	567	"$term->locale_encode".
301		568
		569	$old_events = $term->pty_ev_events ([$new_events])
		570	Replaces the event mask of the pty watcher by the given event mask.
		571	Can be used to suppress input and output handling to the pty/tty.
		572	See the description of "urxvt::timer->events". Make sure to always
		573	restore the previous value.
		574
		575	$windowid = $term->parent
		576	Return the window id of the toplevel window.
		577
		578	$windowid = $term->vt
		579	Return the window id of the terminal window.
		580
		581	$window_width = $term->width
		582	$window_height = $term->height
		583	$font_width = $term->fwidth
		584	$font_height = $term->fheight
		585	$font_ascent = $term->fbase
302	$nrow = $term->nrow	586	$terminal_rows = $term->nrow
303	$ncol = $term->ncol	587	$terminal_columns = $term->ncol
304	Return the number of rows/columns of the terminal window (i.e. as	588	$has_focus = $term->focus
305	specified by "-geometry", excluding any scrollback).	589	$is_mapped = $term->mapped
		590	$max_scrollback = $term->saveLines
		591	$nrow_plus_saveLines = $term->total_rows
		592	$lines_in_scrollback = $term->nsaved
		593	Return various integers describing terminal characteristics.
306		594
		595	$x_display = $term->display_id
		596	Return the DISPLAY used by rxvt-unicode.
		597
		598	$lc_ctype = $term->locale
		599	Returns the LC_CTYPE category string used by this rxvt-unicode.
		600
307	$nsaved = $term->nsaved	601	$env = $term->env
308	Returns the number of lines in the scrollback buffer.	602	Returns a copy of the environment in effect for the terminal as a
		603	hashref similar to "\%ENV".
		604
		605	$modifiermask = $term->ModLevel3Mask
		606	$modifiermask = $term->ModMetaMask
		607	$modifiermask = $term->ModNumLockMask
		608	Return the modifier masks corresponding to the "ISO Level 3 Shift"
		609	(often AltGr), the meta key (often Alt) and the num lock key, if
		610	applicable.
309		611
310	$view_start = $term->view_start ([$newvalue])	612	$view_start = $term->view_start ([$newvalue])
311	Returns the negative row number of the topmost line. Minimum value	613	Returns the negative row number of the topmost line. Minimum value
312	is 0, which displays the normal terminal contents. Larger values	614	is 0, which displays the normal terminal contents. Larger values
313	scroll this many lines into the scrollback buffer.	615	scroll this many lines into the scrollback buffer.
…		…
321		623
322	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	624	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
323	Returns the text of the entire row with number $row_number. Row 0 is	625	Returns the text of the entire row with number $row_number. Row 0 is
324	the topmost terminal line, row "$term->$ncol-1" is the bottommost	626	the topmost terminal line, row "$term->$ncol-1" is the bottommost
325	terminal line. The scrollback buffer starts at line -1 and extends	627	terminal line. The scrollback buffer starts at line -1 and extends
326	to line "-$term->nsaved".	628	to line "-$term->nsaved". Nothing will be returned if a nonexistent
		629	line is requested.
327		630
328	If $new_text is specified, it will replace characters in the current	631	If $new_text is specified, it will replace characters in the current
329	line, starting at column $start_col (default 0), which is useful to	632	line, starting at column $start_col (default 0), which is useful to
330	replace only parts of a line. The font index in the rendition will	633	replace only parts of a line. The font index in the rendition will
331	automatically be updated.	634	automatically be updated.
…		…
352		655
353	See the section on RENDITION, above.	656	See the section on RENDITION, above.
354		657
355	$length = $term->ROW_l ($row_number[, $new_length])	658	$length = $term->ROW_l ($row_number[, $new_length])
356	Returns the number of screen cells that are in use ("the line	659	Returns the number of screen cells that are in use ("the line
357	length"). If it is -1, then the line is part of a multiple-row	660	length"). Unlike the urxvt core, this returns "$term->ncol" if the
358	logical "line", which means all characters are in use and it is	661	line is joined with the following one.
359	continued on the next row.	662
		663	$bool = $term->is_longer ($row_number)
		664	Returns true if the row is part of a multiple-row logical "line"
		665	(i.e. joined with the following row), which means all characters are
		666	in use and it is continued on the next row (and possibly a
		667	continuation of the previous row(s)).
		668
		669	$line = $term->line ($row_number)
		670	Create and return a new "urxvt::line" object that stores information
		671	about the logical line that row $row_number is part of. It supports
		672	the following methods:
		673
		674	$text = $line->t ([$new_text])
		675	Returns or replaces the full text of the line, similar to
		676	"ROW_t"
		677
		678	$rend = $line->r ([$new_rend])
		679	Returns or replaces the full rendition array of the line,
		680	similar to "ROW_r"
		681
		682	$length = $line->l
		683	Returns the length of the line in cells, similar to "ROW_l".
		684
		685	$rownum = $line->beg
		686	$rownum = $line->end
		687	Return the row number of the first/last row of the line,
		688	respectively.
		689
		690	$offset = $line->offset_of ($row, $col)
		691	Returns the character offset of the given row\|col pair within
		692	the logical line.
		693
		694	($row, $col) = $line->coord_of ($offset)
		695	Translates a string offset into terminal coordinates again.
360		696
361	$text = $term->special_encode $string	697	$text = $term->special_encode $string
362	Converts a perl string into the special encoding used by	698	Converts a perl string into the special encoding used by
363	rxvt-unicode, where one character corresponds to one screen cell.	699	rxvt-unicode, where one character corresponds to one screen cell.
364	See "$term->ROW_t" for details.	700	See "$term->ROW_t" for details.
365		701
366	$string = $term->special_decode $text	702	$string = $term->special_decode $text
367	Converts rxvt-unicodes text reprsentation into a perl string. See	703	Converts rxvt-unicodes text reprsentation into a perl string. See
368	"$term->ROW_t" for details.	704	"$term->ROW_t" for details.
		705
		706	$success = $term->grab_button ($button, $modifiermask)
		707	Registers a synchronous button grab. See the XGrabButton manpage.
		708
		709	$success = $term->grab ($eventtime[, $sync])
		710	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		711	synchronous ($sync is true). Also remembers the grab timestampe.
		712
		713	$term->allow_events_async
		714	Calls XAllowEvents with AsyncBoth for the most recent grab.
		715
		716	$term->allow_events_sync
		717	Calls XAllowEvents with SyncBoth for the most recent grab.
		718
		719	$term->allow_events_replay
		720	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		721	the most recent grab.
		722
		723	$term->ungrab
		724	Calls XUngrab for the most recent grab. Is called automatically on
		725	evaluation errors, as it is better to lose the grab in the error
		726	case as the session.
		727
		728	The "urxvt::popup" Class
		729	$popup->add_title ($title)
		730	Adds a non-clickable title to the popup.
		731
		732	$popup->add_separator ([$sepchr])
		733	Creates a separator, optionally using the character given as
		734	$sepchr.
		735
		736	$popup->add_button ($text, $cb)
		737	Adds a clickable button to the popup. $cb is called whenever it is
		738	selected.
		739
		740	$popup->add_toggle ($text, $cb, $initial_value)
		741	Adds a toggle/checkbox item to the popup. Teh callback gets called
		742	whenever it gets toggled, with a boolean indicating its value as its
		743	first argument.
		744
		745	$popup->show
		746	Displays the popup (which is initially hidden).
369		747
370	The "urxvt::timer" Class	748	The "urxvt::timer" Class
371	This class implements timer watchers/events. Time is represented as a	749	This class implements timer watchers/events. Time is represented as a
372	fractional number of seconds since the epoch. Example:	750	fractional number of seconds since the epoch. Example:
373		751
…		…
412		790
413	$term->{socket} = ...	791	$term->{socket} = ...
414	$term->{iow} = urxvt::iow	792	$term->{iow} = urxvt::iow
415	->new	793	->new
416	->fd (fileno $term->{socket})	794	->fd (fileno $term->{socket})
417	->events (1) # wait for read data	795	->events (urxvt::EVENT_READ)
418	->start	796	->start
419	->cb (sub {	797	->cb (sub {
420	my ($iow, $revents) = @_;	798	my ($iow, $revents) = @_;
421	# $revents must be 1 here, no need to check	799	# $revents must be 1 here, no need to check
422	sysread $term->{socket}, my $buf, 8192	800	sysread $term->{socket}, my $buf, 8192
…		…
432		810
433	$iow = $iow->fd ($fd)	811	$iow = $iow->fd ($fd)
434	Set the filedescriptor (not handle) to watch.	812	Set the filedescriptor (not handle) to watch.
435		813
436	$iow = $iow->events ($eventmask)	814	$iow = $iow->events ($eventmask)
437	Set the event mask to watch. Bit #0 (value 1) enables watching for	815	Set the event mask to watch. The only allowed values are
438	read data, Bit #1 (value 2) enables watching for write data.	816	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		817	together, or "urxvt::EVENT_NONE".
439		818
440	$iow = $iow->start	819	$iow = $iow->start
441	Start watching for requested events on the given handle.	820	Start watching for requested events on the given handle.
442		821
443	$iow = $iow->stop	822	$iow = $iow->stop
…		…
446	ENVIRONMENT	825	ENVIRONMENT
447	URXVT_PERL_VERBOSITY	826	URXVT_PERL_VERBOSITY
448	This variable controls the verbosity level of the perl extension. Higher	827	This variable controls the verbosity level of the perl extension. Higher
449	numbers indicate more verbose output.	828	numbers indicate more verbose output.
450		829
451	0 - only fatal messages	830	== 0 - fatal messages
452	3 - script loading and management	831	>= 3 - script loading and management
453	10 - all events received	832	>=10 - all events received
454		833
455	AUTHOR	834	AUTHOR
456	Marc Lehmann <pcg@goof.com>	835	Marc Lehmann <pcg@goof.com>
457	http://software.schmorp.de/pkg/rxvt-unicode	836	http://software.schmorp.de/pkg/rxvt-unicode
458		837

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC