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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.15 by root, Mon Jan 9 01:36: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	PACKAGED EXTENSIONS	26	Prepackaged Extensions
27	This section describes the extensiosn delivered with this version. You	27	This section describes the extensiosn delivered with this version. 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	Intelligent selection. This extension tries to be more intelligent
		36	when the user extends selections (double-click). Right now, it tries
		37	to select urls and complete shell-quoted arguments, which is very
		38	convenient, too, if your ls supports "--quoting-style=shell".
		39
		40	It also offers the following bindable event:
36		41
37	rot13	42	rot13
38	Rot-13 the selection when activated. Used via keyboard trigger:	43	Rot-13 the selection when activated. Used via keyboard trigger:
39		44
40	URxvt.keysym.C-M-r: perl:selection:rot13	45	URxvt.keysym.C-M-r: perl:selection:rot13
41		46
		47	option-popup (enabled by default)
		48	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		49	options at runtime.
		50
		51	selection-popup (enabled by default)
		52	Binds a popup menu to Ctrl-Button3 that lets you convert the
		53	selection text into various other formats/action.
		54
42	digital-clock	55	digital-clock
		56	Displays a digital clock using the built-in overlay.
		57
		58	mark-urls
		59	Uses per-line display filtering ("on_line_update") to underline
		60	urls.
		61
		62	block-graphics-to-ascii
		63	A not very useful example of filtering all text output to the
		64	terminal, by replacing all line-drawing characters (U+2500 ..
		65	U+259F) by a similar-looking ascii character.
		66
		67	example-refresh-hooks
43	Displays a very simple digital clock in the upper right corner of	68	Displays a very simple digital clock in the upper right corner of
44	the window. Illustrates overwriting the refresh callbacks to create	69	the window. Illustrates overwriting the refresh callbacks to create
45	your own overlays or changes.	70	your own overlays or changes.
46
47	simple-overlay-clock
48	Displays a digital clock using the built-in overlay (colorful,
49	useless).
50		71
51	General API Considerations	72	General API Considerations
52	All objects (such as terminals, time watchers etc.) are typical	73	All objects (such as terminals, time watchers etc.) are typical
53	reference-to-hash objects. The hash can be used to store anything you	74	reference-to-hash objects. The hash can be used to store anything you
54	like. All members starting with an underscore (such as "_ptr" or	75	like. All members starting with an underscore (such as "_ptr" or
55	"_hook") are reserved for internal uses and must not be accessed or	76	"_hook") are reserved for internal uses and MUST NOT be accessed or
56	modified).	77	modified).
57		78
58	When objects are destroyed on the C++ side, the perl object hashes are	79	When objects are destroyed on the C++ side, the perl object hashes are
59	emptied, so its best to store related objects such as time watchers and	80	emptied, so its best to store related objects such as time watchers and
60	the like inside the terminal object so they get destroyed as soon as the	81	the like inside the terminal object so they get destroyed as soon as the
61	terminal is destroyed.	82	terminal is destroyed.
62		83
		84	Argument names also often indicate the type of a parameter. Here are
		85	some hints on what they mean:
		86
		87	$text
		88	Rxvt-unicodes special way of encoding text, where one "unicode"
		89	character always represents one screen cell. See row_t for a
		90	discussion of this format.
		91
		92	$string
		93	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
		95	specific encoding (often locale-specific) and binary data.
		96
		97	$octets
		98	Either binary data or - more common - a text string encoded in a
		99	locale-specific way.
		100
63	Hooks	101	Hooks
64	The following subroutines can be declared in loaded scripts, and will be	102	The following subroutines can be declared in extension files, and will
65	called whenever the relevant event happens.	103	be called whenever the relevant event happens.
		104
		105	The first argument passed to them is an object private to each terminal
		106	and extension package. You can call all "urxvt::term" methods on it, but
		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.
66		112
67	All of them must return a boolean value. If it is true, then the event	113	All of them must return a boolean value. If it is true, then the event
68	counts as being consumed, and the invocation of other hooks is	114	counts as being consumed, and the invocation of other hooks is
69	skipped, and the relevant action might not be carried out by the C++	115	skipped, and the relevant action might not be carried out by the C++
70	code.	116	code.
71		117
72	When in doubt, return a false value (preferably "()").	118	When in doubt, return a false value (preferably "()").
73		119
74	on_init $term	120	on_init $term
75	Called after a new terminal object has been initialized, but before	121	Called after a new terminal object has been initialized, but before
76	windows are created or the command gets run.	122	windows are created or the command gets run. Most methods are unsafe
		123	to call or deliver senseless data, as terminal size and other
		124	characteristics have not yet been determined. You can safely query
		125	and change resources, though.
77		126
78	on_reset $term	127	on_reset $term
79	Called after the screen is "reset" for any reason, such as resizing	128	Called after the screen is "reset" for any reason, such as resizing
80	or control sequences. Here is where you can react on changes to	129	or control sequences. Here is where you can react on changes to
81	size-related variables.	130	size-related variables.
…		…
99	queried and changed by calling "$term->selection".	148	queried and changed by calling "$term->selection".
100		149
101	Returning a true value aborts selection grabbing. It will still be	150	Returning a true value aborts selection grabbing. It will still be
102	hilighted.	151	hilighted.
103		152
104	on_focus_in $term	153	on_sel_extend $term
105	Called whenever the window gets the keyboard focus, before urxvt	154	Called whenever the user tries to extend the selection (e.g. with a
106	does focus in processing.	155	double click) and is either supposed to return false (normal
		156	operation), or should extend the selection itelf and return true to
		157	suppress the built-in processing.
107		158
108	on_focus_out $term	159	See the selection example extension.
109	Called wheneever the window loses keyboard focus, before urxvt does
110	focus out processing.
111		160
112	on_view_change $term, $offset	161	on_view_change $term, $offset
113	Called whenever the view offset changes, i..e the user or program	162	Called whenever the view offset changes, i..e the user or program
114	scrolls. Offset 0 means display the normal terminal, positive values	163	scrolls. Offset 0 means display the normal terminal, positive values
115	show this many lines of scrollback.	164	show this many lines of scrollback.
…		…
121		170
122	It is called before lines are scrolled out (so rows 0 .. min ($lines	171	It is called before lines are scrolled out (so rows 0 .. min ($lines
123	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	172	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
124	the total number of lines that will be in the scrollback buffer.	173	the total number of lines that will be in the scrollback buffer.
125		174
126	on_tty_activity $term NYI	175	on_osc_seq $term, $string
127	Called whenever the program(s) running in the urxvt window send	176	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
128	output.	177	operating system command) is processed. Cursor position and other
		178	state information is up-to-date when this happens. For
		179	interoperability, the string should start with the extension name
		180	and a colon, to distinguish it from commands for other extensions,
		181	and this might be enforced in the future.
		182
		183	Be careful not ever to trust (in a security sense) the data you
		184	receive, as its source can not easily be controleld (e-mail content,
		185	messages from other users on the same system etc.).
		186
		187	on_add_lines $term, $string
		188	Called whenever text is about to be output, with the text as
		189	argument. You can filter/change and output the text yourself by
		190	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
		192	called for all text being output.
		193
		194	on_line_update $term, $row
		195	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
		197	lines that are being shown will be filtered, and, due to performance
		198	reasons, not always immediately.
		199
		200	The row number is always the topmost row of the line if the line
		201	spans multiple rows.
		202
		203	Please note that, if you change the line, then the hook might get
		204	called later with the already-modified line (e.g. if unrelated parts
		205	change), so you cannot just toggle rendition bits, but only set
		206	them.
129		207
130	on_refresh_begin $term	208	on_refresh_begin $term
131	Called just before the screen gets redrawn. Can be used for overlay	209	Called just before the screen gets redrawn. Can be used for overlay
132	or similar effects by modify terminal contents in refresh_begin, and	210	or similar effects by modify terminal contents in refresh_begin, and
133	restoring them in refresh_end. The built-in overlay and selection	211	restoring them in refresh_end. The built-in overlay and selection
…		…
139	on_keyboard_command $term, $string	217	on_keyboard_command $term, $string
140	Called whenever the user presses a key combination that has a	218	Called whenever the user presses a key combination that has a
141	"perl:string" action bound to it (see description of the keysym	219	"perl:string" action bound to it (see description of the keysym
142	resource in the rxvt(1) manpage).	220	resource in the rxvt(1) manpage).
143		221
		222	on_focus_in $term
		223	Called whenever the window gets the keyboard focus, before
		224	rxvt-unicode does focus in processing.
		225
		226	on_focus_out $term
		227	Called wheneever the window loses keyboard focus, before
		228	rxvt-unicode does focus out processing.
		229
		230	on_key_press $term, $event, $octets
		231	on_key_release $term, $event
		232	on_button_press $term, $event
		233	on_button_release $term, $event
		234	on_motion_notify $term, $event
		235	on_map_notify $term, $event
		236	on_unmap_notify $term, $event
		237	Called whenever the corresponding X event is received for the
		238	terminal If the hook returns true, then the even will be ignored by
		239	rxvt-unicode.
		240
		241	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
		243	are the row and column under the mouse cursor.
		244
		245	"on_key_press" additionally receives the string rxvt-unicode would
		246	output, if any, in locale-specific encoding.
		247
		248	subwindow.
		249
		250	Variables in the "urxvt" Package
		251	$urxvt::TERM
		252	The current terminal. This variable stores the current "urxvt::term"
		253	object, whenever a callback/hook is executing.
		254
144	Functions in the "urxvt" Package	255	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
145	urxvt::fatal $errormessage	264	urxvt::fatal $errormessage
146	Fatally aborts execution with the given error message. Avoid at all	265	Fatally aborts execution with the given error message. Avoid at all
147	costs! The only time this is acceptable is when the terminal process	266	costs! The only time this is acceptable is when the terminal process
148	starts up.	267	starts up.
149		268
…		…
156	correct place, e.g. on stderr of the connecting urxvtc client.	275	correct place, e.g. on stderr of the connecting urxvtc client.
157		276
158	$time = urxvt::NOW	277	$time = urxvt::NOW
159	Returns the "current time" (as per the event loop).	278	Returns the "current time" (as per the event loop).
160		279
		280	urxvt::CurrentTime
		281	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
		282	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
		283	Button5Mask, AnyModifier
		284	Various constants for use in X calls and event processing.
		285
		286	RENDITION
		287	Rendition bitsets contain information about colour, font, font styles
		288	and similar information for each screen cell.
		289
		290	The following "macros" deal with changes in rendition sets. You should
		291	never just create a bitset, you should always modify an existing one, as
		292	they contain important information required for correct operation of
		293	rxvt-unicode.
		294
		295	$rend = urxvt::DEFAULT_RSTYLE
		296	Returns the default rendition, as used when the terminal is starting
		297	up or being reset. Useful as a base to start when creating
		298	renditions.
		299
		300	$rend = urxvt::OVERLAY_RSTYLE
		301	Return the rendition mask used for overlays by default.
		302
		303	$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		304	Return the bit that enabled bold, italic, blink, reverse-video and
		305	underline, respectively. To enable such a style, just logically OR
		306	it into the bitset.
		307
		308	$foreground = urxvt::GET_BASEFG $rend
		309	$background = urxvt::GET_BASEBG $rend
		310	Return the foreground/background colour index, respectively.
		311
		312	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		313	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		314	Replace the foreground/background colour in the rendition mask with
		315	the specified one.
		316
		317	$value = urxvt::GET_CUSTOM ($rend)
		318	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
		320	initially zero.
		321
		322	$rend = urxvt::SET_CUSTOM ($rend, $new_value)
		323	Change the custom value.
		324
		325	The "urxvt::anyevent" Class
		326	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
		328	further work. The only exception is that you cannot wait on condition
		329	variables, but non-blocking condvar use is ok. What this means is that
		330	you cannot use blocking APIs, but the non-blocking variant should work.
		331
161	The "urxvt::term" Class	332	The "urxvt::term" Class
		333	$term->destroy
		334	Destroy the terminal object (close the window, free resources etc.).
		335
		336	$isset = $term->option ($optval[, $set])
		337	Returns true if the option specified by $optval is enabled, and
		338	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
		340	the hash.
		341
		342	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:
		344
		345	borderLess console cursorBlink cursorUnderline hold iconic insecure
		346	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		347	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		348	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		349	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		350	tripleclickwords utmpInhibit visualBell
		351
162	$value = $term->resource ($name[, $newval])	352	$value = $term->resource ($name[, $newval])
163	Returns the current resource value associated with a given name and	353	Returns the current resource value associated with a given name and
164	optionally sets a new value. Setting values is most useful in the	354	optionally sets a new value. Setting values is most useful in the
165	"init" hook. Unset resources are returned and accepted as "undef".	355	"init" hook. Unset resources are returned and accepted as "undef".
166		356
…		…
175	Please note that resource strings will currently only be freed when	365	Please note that resource strings will currently only be freed when
176	the terminal is destroyed, so changing options frequently will eat	366	the terminal is destroyed, so changing options frequently will eat
177	memory.	367	memory.
178		368
179	Here is a a likely non-exhaustive list of resource names, not all of	369	Here is a a likely non-exhaustive list of resource names, not all of
180	which are supported in every build, please see the source to see the	370	which are supported in every build, please see the source file
181	actual list:	371	/src/rsinc.h to see the actual list:
182		372
183	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	373	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
184	borderLess color cursorBlink cursorUnderline cutchars delete_key	374	borderLess color cursorBlink cursorUnderline cutchars delete_key
185	display_name embed ext_bwidth fade font geometry hold iconName	375	display_name embed ext_bwidth fade font geometry hold iconName
186	imFont imLocale inputMethod insecure int_bwidth intensityStyles	376	imFont imLocale inputMethod insecure int_bwidth intensityStyles
187	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	377	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
188	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	378	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
189	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	379	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
190	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	380	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
191	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	381	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
192	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	382	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
193	shade term_name title transparent transparent_all tripleclickwords	383	shade term_name title transparent transparent_all tripleclickwords
194	utmpInhibit visualBell	384	utmpInhibit visualBell
195		385
		386	$rend = $term->rstyle ([$new_rstyle])
		387	Return and optionally change the current rendition. Text that is
		388	output by the terminal application will use this style.
		389
		390	($row, $col) = $term->screen_cur ([$row, $col])
		391	Return the current coordinates of the text cursor position and
		392	optionally set it (which is usually bad as applications don't expect
		393	that).
		394
196	($row, $col) = $term->selection_mark ([$row, $col])	395	($row, $col) = $term->selection_mark ([$row, $col])
197	($row, $col) = $term->selection_beg ([$row, $col])	396	($row, $col) = $term->selection_beg ([$row, $col])
198	($row, $col) = $term->selection_end ([$row, $col])	397	($row, $col) = $term->selection_end ([$row, $col])
199	Return the current values of the selection mark, begin or end	398	Return the current values of the selection mark, begin or end
200	positions, and optionally set them to new values.	399	positions, and optionally set them to new values.
…		…
205		404
206	$oldtext = $term->selection ([$newtext])	405	$oldtext = $term->selection ([$newtext])
207	Return the current selection text and optionally replace it by	406	Return the current selection text and optionally replace it by
208	$newtext.	407	$newtext.
209		408
210	$term->scr_overlay ($x, $y, $text)	409	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line
211	Create a simple multi-line overlay box. See the next method for	410	overlay box. See the next method for details. # #=cut # #sub
212	details.	411	urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my
		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; #}
213		416
214	$term->scr_overlay_new ($x, $y, $width, $height)	417	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
215	Create a new (empty) overlay at the given position with the given	418	Create a new (empty) overlay at the given position with the given
216	width/height. A border will be put around the box. If either $x or	419	width/height. $rstyle defines the initial rendition style (default:
		420	"OVERLAY_RSTYLE").
		421
		422	If $border is 2 (default), then a decorative border will be put
		423	around the box.
		424
217	$y is negative, then this is counted from the right/bottom side,	425	If either $x or $y is negative, then this is counted from the
218	respectively.	426	right/bottom side, respectively.
219		427
220	$term->scr_overlay_off	428	This method returns an urxvt::overlay object. The overlay will be
221	Switch the overlay off again.	429	visible as long as the perl object is referenced.
222		430
223	$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	431	The methods currently supported on "urxvt::overlay" objects are:
224	Put a single character (specified numerically) at the given overlay
225	position.
226		432
227	$term->scr_overlay_set ($x, $y, $text)	433	$overlay->set ($x, $y, $text, $rend)
228	Write a string at the given position into the overlay.	434	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
		435	text in rxvt-unicode's special encoding and an array of
		436	rendition values at a specific position inside the overlay.
229		437
		438	$overlay->hide
		439	If visible, hide the overlay, but do not destroy it.
		440
		441	$overlay->show
		442	If hidden, display the overlay again.
		443
		444	$popup = $term->popup ($event)
		445	Creates a new "urxvt::popup" object that implements a popup menu.
		446	The $event must be the event causing the menu to pop up (a button
		447	event, currently).
		448
230	$cellwidth = $term->strwidth $string	449	$cellwidth = $term->strwidth ($string)
231	Returns the number of screen-cells this string would need. Correctly	450	Returns the number of screen-cells this string would need. Correctly
232	accounts for wide and combining characters.	451	accounts for wide and combining characters.
233		452
234	$octets = $term->locale_encode $string	453	$octets = $term->locale_encode ($string)
235	Convert the given text string into the corresponding locale	454	Convert the given text string into the corresponding locale
236	encoding.	455	encoding.
237		456
238	$string = $term->locale_decode $octets	457	$string = $term->locale_decode ($octets)
239	Convert the given locale-encoded octets into a perl string.	458	Convert the given locale-encoded octets into a perl string.
		459
		460	$term->scr_add_lines ($string)
		461	Write the given text string to the screen, as if output by the
		462	application running inside the terminal. It may not contain command
		463	sequences (escape codes), but is free to use line feeds, carriage
		464	returns and tabs. The string is a normal text string, not in
		465	locale-dependent encoding.
		466
		467	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
		469	inside a "on_add_lines" hook, though.
		470
		471	$term->cmd_parse ($octets)
		472	Similar to "scr_add_lines", but the argument must be in the
		473	locale-specific encoding of the terminal and can contain command
		474	sequences (escape codes) that will be interpreted.
240		475
241	$term->tt_write ($octets)	476	$term->tt_write ($octets)
242	Write the octets given in $data to the tty (i.e. as program input).	477	Write the octets given in $data to the tty (i.e. as program input).
243	To pass characters instead of octets, you should convert your	478	To pass characters instead of octets, you should convert your
244	strings first to the locale-specific encoding using	479	strings first to the locale-specific encoding using
245	"$term->locale_encode".	480	"$term->locale_encode".
246		481
		482	$windowid = $term->parent
		483	Return the window id of the toplevel window.
		484
		485	$windowid = $term->vt
		486	Return the window id of the terminal window.
		487
		488	$window_width = $term->width
		489	$window_height = $term->height
		490	$font_width = $term->fwidth
		491	$font_height = $term->fheight
		492	$font_ascent = $term->fbase
247	$nrow = $term->nrow	493	$terminal_rows = $term->nrow
248	$ncol = $term->ncol	494	$terminal_columns = $term->ncol
249	Return the number of rows/columns of the terminal window (i.e. as	495	$has_focus = $term->focus
250	specified by "-geometry", excluding any scrollback).
251
252	$nsaved = $term->nsaved	496	$is_mapped = $term->mapped
253	Returns the number of lines in the scrollback buffer.	497	$max_scrollback = $term->saveLines
		498	$nrow_plus_saveLines = $term->total_rows
		499	$lines_in_scrollback = $term->nsaved
		500	Return various integers describing terminal characteristics.
		501
		502	$modifiermask = $term->ModLevel3Mask
		503	$modifiermask = $term->ModMetaMask
		504	$modifiermask = $term->ModNumLockMask
		505	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
		507	applicable.
254		508
255	$view_start = $term->view_start ([$newvalue])	509	$view_start = $term->view_start ([$newvalue])
256	Returns the negative row number of the topmost line. Minimum value	510	Returns the negative row number of the topmost line. Minimum value
257	is 0, which displays the normal terminal contents. Larger values	511	is 0, which displays the normal terminal contents. Larger values
258	scroll this many lines into the scrollback buffer.	512	scroll this many lines into the scrollback buffer.
…		…
266		520
267	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	521	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
268	Returns the text of the entire row with number $row_number. Row 0 is	522	Returns the text of the entire row with number $row_number. Row 0 is
269	the topmost terminal line, row "$term->$ncol-1" is the bottommost	523	the topmost terminal line, row "$term->$ncol-1" is the bottommost
270	terminal line. The scrollback buffer starts at line -1 and extends	524	terminal line. The scrollback buffer starts at line -1 and extends
271	to line "-$term->nsaved".	525	to line "-$term->nsaved". Nothing will be returned if a nonexistent
		526	line is requested.
272		527
273	If $new_text is specified, it will replace characters in the current	528	If $new_text is specified, it will replace characters in the current
274	line, starting at column $start_col (default 0), which is useful to	529	line, starting at column $start_col (default 0), which is useful to
275	replace only parts of a line. The font iindex in the rendition will	530	replace only parts of a line. The font index in the rendition will
276	automatically be updated.	531	automatically be updated.
277		532
278	$text is in a special encoding: tabs and wide characters that use	533	$text is in a special encoding: tabs and wide characters that use
279	more than one cell when displayed are padded with urxvt::NOCHAR	534	more than one cell when displayed are padded with urxvt::NOCHAR
280	characters ("chr 65535"). Characters with combining characters and	535	characters ("chr 65535"). Characters with combining characters and
…		…
293	Rendition bitsets contain information about colour, font, font	548	Rendition bitsets contain information about colour, font, font
294	styles and similar information. See also "$term->ROW_t".	549	styles and similar information. See also "$term->ROW_t".
295		550
296	When setting rendition, the font mask will be ignored.	551	When setting rendition, the font mask will be ignored.
297		552
298	See the section on RENDITION, below.	553	See the section on RENDITION, above.
299		554
300	$length = $term->ROW_l ($row_number[, $new_length])	555	$length = $term->ROW_l ($row_number[, $new_length])
301	Returns the number of screen cells that are in use ("the line	556	Returns the number of screen cells that are in use ("the line
302	length"). If it is -1, then the line is part of a multiple-row	557	length"). Unlike the urxvt core, this returns "$term->ncol" if the
303	logical "line", which means all characters are in use and it is	558	line is joined with the following one.
304	continued on the next row.	559
		560	$bool = $term->is_longer ($row_number)
		561	Returns true if the row is part of a multiple-row logical "line"
		562	(i.e. joined with the following row), which means all characters are
		563	in use and it is continued on the next row (and possibly a
		564	continuation of the previous row(s)).
		565
		566	$line = $term->line ($row_number)
		567	Create and return a new "urxvt::line" object that stores information
		568	about the logical line that row $row_number is part of. It supports
		569	the following methods:
		570
		571	$text = $line->t ([$new_text])
		572	Returns or replaces the full text of the line, similar to
		573	"ROW_t"
		574
		575	$rend = $line->r ([$new_rend])
		576	Returns or replaces the full rendition array of the line,
		577	similar to "ROW_r"
		578
		579	$length = $line->l
		580	Returns the length of the line in cells, similar to "ROW_l".
		581
		582	$rownum = $line->beg
		583	$rownum = $line->end
		584	Return the row number of the first/last row of the line,
		585	respectively.
		586
		587	$offset = $line->offset_of ($row, $col)
		588	Returns the character offset of the given row\|col pair within
		589	the logical line.
		590
		591	($row, $col) = $line->coord_of ($offset)
		592	Translates a string offset into terminal coordinates again.
305		593
306	$text = $term->special_encode $string	594	$text = $term->special_encode $string
307	Converts a perl string into the special encoding used by	595	Converts a perl string into the special encoding used by
308	rxvt-unicode, where one character corresponds to one screen cell.	596	rxvt-unicode, where one character corresponds to one screen cell.
309	See "$term->ROW_t" for details.	597	See "$term->ROW_t" for details.
310		598
311	$string = $term->special_decode $text	599	$string = $term->special_decode $text
312	Converts rxvt-unicodes text reprsentation into a perl string. See	600	Converts rxvt-unicodes text reprsentation into a perl string. See
313	"$term->ROW_t" for details.	601	"$term->ROW_t" for details.
314		602
315	RENDITION	603	$success = $term->grab_button ($button, $modifiermask)
316	Rendition bitsets contain information about colour, font, font styles	604	Registers a synchronous button grab. See XGrabButton.
317	and similar information for each screen cell.
318		605
319	The following "macros" deal with changes in rendition sets. You should	606	$success = $term->grab ($eventtime[, $sync])
320	never just create a bitset, you should always modify an existing one, as	607	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
321	they contain important information required for correct operation of	608	synchronous ($sync is true). Also remembers the grab timestampe.
322	rxvt-unicode.
323		609
324	$rend = urxvt::DEFAULT_RSTYLE	610	$term->allow_events_async
325	Returns the default rendition, as used when the terminal is starting	611	Calls XAllowEvents with AsyncBoth for the most recent grab.
326	up or being reset. Useful as a base
327		612
		613	$term->allow_events_sync
		614	Calls XAllowEvents with SyncBoth for the most recent grab.
		615
		616	$term->allow_events_replay
		617	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		618	the most recent grab.
		619
		620	$term->ungrab
		621	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
		623	case as the session.
		624
		625	The "urxvt::popup" Class
328	The "urxvt::timer" Class	626	The "urxvt::timer" Class
329	This class implements timer watchers/events. Time is represented as a	627	This class implements timer watchers/events. Time is represented as
330	fractional number of seconds since the epoch. Example:	628	a fractional number of seconds since the epoch. Example:
331		629
332	# create a digital clock display in upper right corner	630	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
333	$term->{timer} = urxvt::timer	631	$term->{timer} = urxvt::timer
334	->new	632	->new
335	->start (urxvt::NOW)	633	->interval (1)
336	->cb (sub {	634	->cb (sub {
337	my ($timer) = @_;
338	my $time = $timer->at;
339	$timer->start ($time + 1);
340	$self->scr_overlay (-1, 0,	635	$term->{overlay}->set (0, 0,
341	POSIX::strftime "%H:%M:%S", localtime $time);	636	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
342	});	637	});
343		638
344	$timer = new urxvt::timer	639	$timer = new urxvt::timer
345	Create a new timer object in stopped state.	640	Create a new timer object in started state. It is scheduled to
		641	fire immediately.
346		642
347	$timer = $timer->cb (sub { my ($timer) = @_; ... })	643	$timer = $timer->cb (sub { my ($timer) = @_; ... })
348	Set the callback to be called when the timer triggers.	644	Set the callback to be called when the timer triggers.
349		645
350	$tstamp = $timer->at	646	$tstamp = $timer->at
351	Return the time this watcher will fire next.	647	Return the time this watcher will fire next.
352		648
353	$timer = $timer->set ($tstamp)	649	$timer = $timer->set ($tstamp)
354	Set the time the event is generated to $tstamp.	650	Set the time the event is generated to $tstamp.
355		651
		652	$timer = $timer->interval ($interval)
		653	Normally (and when $interval is 0), the timer will automatically
		654	stop after it has fired once. If $interval is non-zero, then the
		655	timer is automatically rescheduled at the given intervals.
		656
356	$timer = $timer->start	657	$timer = $timer->start
357	Start the timer.	658	Start the timer.
358		659
359	$timer = $timer->start ($tstamp)	660	$timer = $timer->start ($tstamp)
360	Set the event trigger time to $tstamp and start the timer.	661	Set the event trigger time to $tstamp and start the timer.
361		662
362	$timer = $timer->stop	663	$timer = $timer->stop
363	Stop the timer.	664	Stop the timer.
364		665
365	The "urxvt::iow" Class	666	The "urxvt::iow" Class
366	This class implements io watchers/events. Example:	667	This class implements io watchers/events. Example:
367		668
368	$term->{socket} = ...	669	$term->{socket} = ...
369	$term->{iow} = urxvt::iow	670	$term->{iow} = urxvt::iow
370	->new	671	->new
371	->fd (fileno $term->{socket})	672	->fd (fileno $term->{socket})
372	->events (1) # wait for read data	673	->events (1) # wait for read data
373	->start	674	->start
374	->cb (sub {	675	->cb (sub {
375	my ($iow, $revents) = @_;	676	my ($iow, $revents) = @_;
376	# $revents must be 1 here, no need to check	677	# $revents must be 1 here, no need to check
377	sysread $term->{socket}, my $buf, 8192	678	sysread $term->{socket}, my $buf, 8192
378	or end-of-file;	679	or end-of-file;
379	});	680	});
380		681
381	$iow = new urxvt::iow	682	$iow = new urxvt::iow
382	Create a new io watcher object in stopped state.	683	Create a new io watcher object in stopped state.
383		684
384	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	685	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
385	Set the callback to be called when io events are triggered.	686	Set the callback to be called when io events are triggered.
386	$reventmask is a bitset as described in the "events" method.	687	$reventmask is a bitset as described in the "events" method.
387		688
388	$iow = $iow->fd ($fd)	689	$iow = $iow->fd ($fd)
389	Set the filedescriptor (not handle) to watch.	690	Set the filedescriptor (not handle) to watch.
390		691
391	$iow = $iow->events ($eventmask)	692	$iow = $iow->events ($eventmask)
392	Set the event mask to watch. Bit #0 (value 1) enables watching for	693	Set the event mask to watch. Bit #0 (value 1) enables watching
393	read data, Bit #1 (value 2) enables watching for write data.	694	for read data, Bit #1 (value 2) enables watching for write data.
394		695
395	$iow = $iow->start	696	$iow = $iow->start
396	Start watching for requested events on the given handle.	697	Start watching for requested events on the given handle.
397		698
398	$iow = $iow->stop	699	$iow = $iow->stop
399	Stop watching for events on the given filehandle.	700	Stop watching for events on the given filehandle.
400		701
401	ENVIRONMENT	702	ENVIRONMENT
402	URXVT_PERL_VERBOSITY	703	URXVT_PERL_VERBOSITY
403	This variable controls the verbosity level of the perl extension. Higher	704	This variable controls the verbosity level of the perl extension.
404	numbers indicate more verbose output.	705	Higher numbers indicate more verbose output.
405		706
406	0 - only fatal messages	707	== 0 - fatal messages
407	3 - script loading and management	708	>= 3 - script loading and management
408	10 - all events received	709	>=10 - all events received
409		710
410	AUTHOR	711	AUTHOR
411	Marc Lehmann <pcg@goof.com>	712	Marc Lehmann <pcg@goof.com>
412	http://software.schmorp.de/pkg/rxvt-unicode	713	http://software.schmorp.de/pkg/rxvt-unicode
413		714

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs. Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC