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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.1 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.18 by root, Tue Jan 10 18:09:22 2006 UTC

…		…
1	NAME	1	NAME
2	rxvtperl - rxvt-unicode's embedded perl interpreter	2	rxvtperl - rxvt-unicode's embedded perl interpreter
3		3
4	SYNOPSIS	4	SYNOPSIS
5	* Put your scripts into /opt/rxvt/lib/urxvt/perl-ext/, they will be	5	# create a file grab_test in $HOME:
6	loaded automatically.
7
8	* Scripts are evaluated in a 'use strict' and 'use utf8' environment,
9	and thus must be encoded as UTF-8.
10		6
11	sub on_sel_grab {	7	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	8	warn "you selected ", $_[0]->selection;
13	()	9	()
14	}	10	}
15		11
16	1	12	# start a rxvt using it:
		13
		14	rxvt --perl-lib $HOME -pe grab_test
17		15
18	DESCRIPTION	16	DESCRIPTION
19	On startup, rxvt will scan /opt/rxvt/lib/urxvt/perl-ext/ for files and	17	Everytime a terminal object gets created, extension scripts specified
20	will load them. Everytime a terminal object gets created, the directory	18	via the "perl" resource are loaded and associated with it.
21	specified by the "perl-lib" resource will be additionally scanned.	19
		20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		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 for all terminals.	24	will be shared (but not enabled) for all terminals.
25		25
26	Hooks in scripts specified by "perl-lib" will only be called for the	26	PREPACKAGED EXTENSIONS
27	terminals created with that specific option value.	27	This section describes the extensions delivered with this release. You
		28	can find them in /opt/rxvt/lib/urxvt/perl/.
28		29
		30	You can activate them like this:
		31
		32	rxvt -pe <extensionname>
		33
		34	selection (enabled by default)
		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:
		42
		43	rot13
		44	Rot-13 the selection when activated. Used via keyboard trigger:
		45
		46	URxvt.keysym.C-M-r: perl:selection:rot13
		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
		68	digital-clock
		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
		73	urls.
		74
		75	block-graphics-to-ascii
		76	A not very useful example of filtering all text output to the
		77	terminal, by replacing all line-drawing characters (U+2500 ..
		78	U+259F) by a similar-looking ascii character.
		79
		80	example-refresh-hooks
		81	Displays a very simple digital clock in the upper right corner of
		82	the window. Illustrates overwriting the refresh callbacks to create
		83	your own overlays or changes.
		84
		85	API DOCUMENTATION
29	General API Considerations	86	General API Considerations
30	All objects (such as terminals, time watchers etc.) are typical	87	All objects (such as terminals, time watchers etc.) are typical
31	reference-to-hash objects. The hash can be used to store anything you	88	reference-to-hash objects. The hash can be used to store anything you
32	like. All members starting with an underscore (such as "_ptr" or	89	like. All members starting with an underscore (such as "_ptr" or
33	"_hook") are reserved for internal uses and must not be accessed or	90	"_hook") are reserved for internal uses and MUST NOT be accessed or
34	modified).	91	modified).
35		92
36	When objects are destroyed on the C++ side, the perl object hashes are	93	When objects are destroyed on the C++ side, the perl object hashes are
37	emptied, so its best to store related objects such as time watchers and	94	emptied, so its best to store related objects such as time watchers and
38	the like inside the terminal object so they get destroyed as soon as the	95	the like inside the terminal object so they get destroyed as soon as the
39	terminal is destroyed.	96	terminal is destroyed.
40		97
		98	Argument names also often indicate the type of a parameter. Here are
		99	some hints on what they mean:
		100
		101	$text
		102	Rxvt-unicodes special way of encoding text, where one "unicode"
		103	character always represents one screen cell. See row_t for a
		104	discussion of this format.
		105
		106	$string
		107	A perl text string, with an emphasis on text. It can store all
		108	unicode characters and is to be distinguished with text encoded in a
		109	specific encoding (often locale-specific) and binary data.
		110
		111	$octets
		112	Either binary data or - more common - a text string encoded in a
		113	locale-specific way.
		114
		115	Extension Objects
		116	Very perl extension is a perl class. A separate perl object is created
		117	for each terminal and each extension and passed as the first parameter
		118	to hooks. So extensions can use their $self object without having to
		119	think about other extensions, with the exception of methods and members
		120	that begin with an underscore character "_": these are reserved for
		121	internal use.
		122
		123	Although it isn't a "urxvt::term" object, you can call all methods of
		124	the "urxvt::term" class on this object.
		125
		126	It has the following methods and data members:
		127
		128	$urxvt_term = $self->{term}
		129	Returns the "urxvt::term" object associated with this instance of
		130	the extension. This member must not be changed in any way.
		131
		132	$self->enable ($hook_name => $cb, [$hook_name => $cb..])
		133	Dynamically enable the given hooks (named without the "on_" prefix)
		134	for this extension, replacing any previous hook. This is useful when
		135	you want to overwrite time-critical hooks only temporarily.
		136
		137	$self->disable ($hook_name[, $hook_name..])
		138	Dynamically disable the given hooks.
		139
41	Hooks	140	Hooks
42	The following subroutines can be declared in loaded scripts, and will be	141	The following subroutines can be declared in extension files, and will
43	called whenever the relevant event happens.	142	be called whenever the relevant event happens.
44		143
		144	The first argument passed to them is an extension oject as described in
		145	the in the "Extension Objects" section.
		146
45	All of them must return a boolean value. If it is true, then the event	147	All of these hooks must return a boolean value. If it is true, then the
46	counts as being consumed, and the invocation of other hooks is	148	event counts as being consumed, and the invocation of other hooks is
47	skipped, and the relevant action might not be carried out by the C++	149	skipped, and the relevant action might not be carried out by the C++
48	code.	150	code.
49		151
50	When in doubt, return a false value (preferably "()").	152	When in doubt, return a false value (preferably "()").
51		153
52	on_init $term	154	on_init $term
53	Called after a new terminal object has been initialized, but before	155	Called after a new terminal object has been initialized, but before
54	windows are created or the command gets run.	156	windows are created or the command gets run. Most methods are unsafe
		157	to call or deliver senseless data, as terminal size and other
		158	characteristics have not yet been determined. You can safely query
		159	and change resources, though.
55		160
56	on_reset $term	161	on_reset $term
57	Called after the screen is "reset" for any reason, such as resizing	162	Called after the screen is "reset" for any reason, such as resizing
58	or control sequences. Here is where you can react on changes to	163	or control sequences. Here is where you can react on changes to
59	size-related variables.	164	size-related variables.
77	queried and changed by calling "$term->selection".	182	queried and changed by calling "$term->selection".
78		183
79	Returning a true value aborts selection grabbing. It will still be	184	Returning a true value aborts selection grabbing. It will still be
80	hilighted.	185	hilighted.
81		186
82	on_focus_in $term	187	on_sel_extend $term
83	Called whenever the window gets the keyboard focus, before urxvt	188	Called whenever the user tries to extend the selection (e.g. with a
84	does focus in processing.	189	double click) and is either supposed to return false (normal
		190	operation), or should extend the selection itelf and return true to
		191	suppress the built-in processing.
85		192
86	on_focus_out $term	193	See the selection example extension.
87	Called wheneever the window loses keyboard focus, before urxvt does
88	focus out processing.
89		194
90	on_view_change $term, $offset	195	on_view_change $term, $offset
91	Called whenever the view offset changes, i..e the user or program	196	Called whenever the view offset changes, i..e the user or program
92	scrolls. Offset 0 means display the normal terminal, positive values	197	scrolls. Offset 0 means display the normal terminal, positive values
93	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
99		204
100	It is called before lines are scrolled out (so rows 0 .. min ($lines	205	It is called before lines are scrolled out (so rows 0 .. min ($lines
101	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	206	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
102	the total number of lines that will be in the scrollback buffer.	207	the total number of lines that will be in the scrollback buffer.
103		208
104	on_tty_activity $term NYI	209	on_osc_seq $term, $string
105	Called whenever the program(s) running in the urxvt window send	210	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
106	output.	211	operating system command) is processed. Cursor position and other
		212	state information is up-to-date when this happens. For
		213	interoperability, the string should start with the extension name
		214	and a colon, to distinguish it from commands for other extensions,
		215	and this might be enforced in the future.
		216
		217	Be careful not ever to trust (in a security sense) the data you
		218	receive, as its source can not easily be controleld (e-mail content,
		219	messages from other users on the same system etc.).
		220
		221	on_add_lines $term, $string
		222	Called whenever text is about to be output, with the text as
		223	argument. You can filter/change and output the text yourself by
		224	returning a true value and calling "$term->scr_add_lines" yourself.
		225	Please note that this might be very slow, however, as your hook is
		226	called for all text being output.
		227
		228	on_tt_write $term, $octets
		229	Called whenever some data is written to the tty/pty and can be used
		230	to suppress or filter tty input.
		231
		232	on_line_update $term, $row
		233	Called whenever a line was updated or changed. Can be used to filter
		234	screen output (e.g. underline urls or other useless stuff). Only
		235	lines that are being shown will be filtered, and, due to performance
		236	reasons, not always immediately.
		237
		238	The row number is always the topmost row of the line if the line
		239	spans multiple rows.
		240
		241	Please note that, if you change the line, then the hook might get
		242	called later with the already-modified line (e.g. if unrelated parts
		243	change), so you cannot just toggle rendition bits, but only set
		244	them.
107		245
108	on_refresh_begin $term	246	on_refresh_begin $term
109	Called just before the screen gets redrawn. Can be used for overlay	247	Called just before the screen gets redrawn. Can be used for overlay
110	or similar effects by modify terminal contents in refresh_begin, and	248	or similar effects by modify terminal contents in refresh_begin, and
111	restoring them in refresh_end. The built-in overlay and selection	249	restoring them in refresh_end. The built-in overlay and selection
112	display code is run after this hook, and takes precedence.	250	display code is run after this hook, and takes precedence.
113		251
114	on_refresh_end $term	252	on_refresh_end $term
115	Called just after the screen gets redrawn. See "on_refresh_begin".	253	Called just after the screen gets redrawn. See "on_refresh_begin".
116		254
		255	on_keyboard_command $term, $string
		256	Called whenever the user presses a key combination that has a
		257	"perl:string" action bound to it (see description of the keysym
		258	resource in the rxvt(1) manpage).
		259
		260	on_focus_in $term
		261	Called whenever the window gets the keyboard focus, before
		262	rxvt-unicode does focus in processing.
		263
		264	on_focus_out $term
		265	Called wheneever the window loses keyboard focus, before
		266	rxvt-unicode does focus out processing.
		267
		268	on_key_press $term, $event, $keysym, $octets
		269	on_key_release $term, $event, $keysym
		270	on_button_press $term, $event
		271	on_button_release $term, $event
		272	on_motion_notify $term, $event
		273	on_map_notify $term, $event
		274	on_unmap_notify $term, $event
		275	Called whenever the corresponding X event is received for the
		276	terminal If the hook returns true, then the even will be ignored by
		277	rxvt-unicode.
		278
		279	The event is a hash with most values as named by Xlib (see the
		280	XEvent manpage), with the additional members "row" and "col", which
		281	are the row and column under the mouse cursor.
		282
		283	"on_key_press" additionally receives the string rxvt-unicode would
		284	output, if any, in locale-specific encoding.
		285
		286	subwindow.
		287
		288	Variables in the "urxvt" Package
		289	$urxvt::TERM
		290	The current terminal. This variable stores the current "urxvt::term"
		291	object, whenever a callback/hook is executing.
		292
117	Functions in the "urxvt" Package	293	Functions in the "urxvt" Package
		294	$term = new urxvt [arg...]
		295	Creates a new terminal, very similar as if you had started it with
		296	"system $binfile, arg...". Croaks (and probably outputs an error
		297	message) if the new instance couldn't be created. Returns "undef" if
		298	the new instance didn't initialise perl, and the terminal object
		299	otherwise. The "init" and "start" hooks will be called during the
		300	call.
		301
118	urxvt::fatal $errormessage	302	urxvt::fatal $errormessage
119	Fatally aborts execution with the given error message. Avoid at all	303	Fatally aborts execution with the given error message. Avoid at all
120	costs! The only time this is acceptable is when the terminal process	304	costs! The only time this is acceptable is when the terminal process
121	starts up.	305	starts up.
122		306
…		…
126	function that calls this function.	310	function that calls this function.
127		311
128	Using this function has the advantage that its output ends up in the	312	Using this function has the advantage that its output ends up in the
129	correct place, e.g. on stderr of the connecting urxvtc client.	313	correct place, e.g. on stderr of the connecting urxvtc client.
130		314
		315	$is_safe = urxvt::safe
		316	Returns true when it is safe to do potentially unsafe things, such
		317	as evaluating perl code specified by the user. This is true when
		318	urxvt was started setuid or setgid.
		319
131	$time = urxvt::NOW	320	$time = urxvt::NOW
132	Returns the "current time" (as per the event loop).	321	Returns the "current time" (as per the event loop).
133		322
		323	urxvt::CurrentTime
		324	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
		325	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
		326	Button5Mask, AnyModifier
		327	Various constants for use in X calls and event processing.
		328
		329	RENDITION
		330	Rendition bitsets contain information about colour, font, font styles
		331	and similar information for each screen cell.
		332
		333	The following "macros" deal with changes in rendition sets. You should
		334	never just create a bitset, you should always modify an existing one, as
		335	they contain important information required for correct operation of
		336	rxvt-unicode.
		337
		338	$rend = urxvt::DEFAULT_RSTYLE
		339	Returns the default rendition, as used when the terminal is starting
		340	up or being reset. Useful as a base to start when creating
		341	renditions.
		342
		343	$rend = urxvt::OVERLAY_RSTYLE
		344	Return the rendition mask used for overlays by default.
		345
		346	$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		347	Return the bit that enabled bold, italic, blink, reverse-video and
		348	underline, respectively. To enable such a style, just logically OR
		349	it into the bitset.
		350
		351	$foreground = urxvt::GET_BASEFG $rend
		352	$background = urxvt::GET_BASEBG $rend
		353	Return the foreground/background colour index, respectively.
		354
		355	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		356	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		357	Replace the foreground/background colour in the rendition mask with
		358	the specified one.
		359
		360	$value = urxvt::GET_CUSTOM ($rend)
		361	Return the "custom" value: Every rendition has 5 bits for use by
		362	extensions. They can be set and changed as you like and are
		363	initially zero.
		364
		365	$rend = urxvt::SET_CUSTOM ($rend, $new_value)
		366	Change the custom value.
		367
		368	The "urxvt::anyevent" Class
		369	The sole purpose of this class is to deliver an interface to the
		370	"AnyEvent" module - any module using it will work inside urxvt without
		371	further work. The only exception is that you cannot wait on condition
		372	variables, but non-blocking condvar use is ok. What this means is that
		373	you cannot use blocking APIs, but the non-blocking variant should work.
		374
134	The "urxvt::term" Class	375	The "urxvt::term" Class
		376	$term->destroy
		377	Destroy the terminal object (close the window, free resources etc.).
		378
		379	$isset = $term->option ($optval[, $set])
		380	Returns true if the option specified by $optval is enabled, and
		381	optionally change it. All option values are stored by name in the
		382	hash %urxvt::OPTION. Options not enabled in this binary are not in
		383	the hash.
		384
		385	Here is a a likely non-exhaustive list of option names, please see
		386	the source file /src/optinc.h to see the actual list:
		387
		388	borderLess console cursorBlink cursorUnderline hold iconic insecure
		389	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		390	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		391	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		392	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		393	tripleclickwords utmpInhibit visualBell
		394
135	$value = $term->resource ($name[, $newval])	395	$value = $term->resource ($name[, $newval])
136	Returns the current resource value associated with a given name and	396	Returns the current resource value associated with a given name and
137	optionally sets a new value. Setting values is most useful in the	397	optionally sets a new value. Setting values is most useful in the
138	"init" hook. Unset resources are returned and accepted as "undef".	398	"init" hook. Unset resources are returned and accepted as "undef".
139		399
…		…
148	Please note that resource strings will currently only be freed when	408	Please note that resource strings will currently only be freed when
149	the terminal is destroyed, so changing options frequently will eat	409	the terminal is destroyed, so changing options frequently will eat
150	memory.	410	memory.
151		411
152	Here is a a likely non-exhaustive list of resource names, not all of	412	Here is a a likely non-exhaustive list of resource names, not all of
153	which are supported in every build, please see the source to see the	413	which are supported in every build, please see the source file
154	actual list:	414	/src/rsinc.h to see the actual list:
155		415
156	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	416	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
157	borderLess color cursorBlink cursorUnderline cutchars delete_key	417	borderLess color cursorBlink cursorUnderline cutchars delete_key
158	display_name embed ext_bwidth fade font geometry hold iconName	418	display_name embed ext_bwidth fade font geometry hold iconName
159	imFont imLocale inputMethod insecure int_bwidth intensityStyles	419	imFont imLocale inputMethod insecure int_bwidth intensityStyles
160	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	420	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
161	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	421	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
162	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	422	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
163	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	423	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
164	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	424	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
165	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	425	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
166	shade term_name title transparent transparent_all tripleclickwords	426	shade term_name title transparent transparent_all tripleclickwords
167	utmpInhibit visualBell	427	utmpInhibit visualBell
168		428
		429	$success = $term->parse_keysym ($keysym_spec, $command_string)
		430	Adds a keymap translation exactly as specified via a resource. See
		431	the "keysym" resource in the rxvt(1) manpage.
		432
		433	$rend = $term->rstyle ([$new_rstyle])
		434	Return and optionally change the current rendition. Text that is
		435	output by the terminal application will use this style.
		436
		437	($row, $col) = $term->screen_cur ([$row, $col])
		438	Return the current coordinates of the text cursor position and
		439	optionally set it (which is usually bad as applications don't expect
		440	that).
		441
169	($row, $col) = $term->selection_mark ([$row, $col])	442	($row, $col) = $term->selection_mark ([$row, $col])
170	($row, $col) = $term->selection_beg ([$row, $col])	443	($row, $col) = $term->selection_beg ([$row, $col])
171	($row, $col) = $term->selection_end ([$row, $col])	444	($row, $col) = $term->selection_end ([$row, $col])
172	Return the current values of the selection mark, begin or end	445	Return the current values of the selection mark, begin or end
173	positions, and optionally set them to new values.	446	positions, and optionally set them to new values.
…		…
178		451
179	$oldtext = $term->selection ([$newtext])	452	$oldtext = $term->selection ([$newtext])
180	Return the current selection text and optionally replace it by	453	Return the current selection text and optionally replace it by
181	$newtext.	454	$newtext.
182		455
183	$term->scr_overlay ($x, $y, $text)	456	$term->overlay_simple ($x, $y, $text)
184	Create a simple multi-line overlay box. See the next method for	457	Create a simple multi-line overlay box. See the next method for
185	details.	458	details.
186		459
187	$term->scr_overlay_new ($x, $y, $width, $height)	460	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
188	Create a new (empty) overlay at the given position with the given	461	Create a new (empty) overlay at the given position with the given
189	width/height. A border will be put around the box. If either $x or	462	width/height. $rstyle defines the initial rendition style (default:
		463	"OVERLAY_RSTYLE").
		464
		465	If $border is 2 (default), then a decorative border will be put
		466	around the box.
		467
190	$y is negative, then this is counted from the right/bottom side,	468	If either $x or $y is negative, then this is counted from the
191	respectively.	469	right/bottom side, respectively.
192		470
193	$term->scr_overlay_off	471	This method returns an urxvt::overlay object. The overlay will be
194	Switch the overlay off again.	472	visible as long as the perl object is referenced.
195		473
196	$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	474	The methods currently supported on "urxvt::overlay" objects are:
197	Put a single character (specified numerically) at the given overlay
198	position.
199		475
200	$term->scr_overlay_set ($x, $y, $text)	476	$overlay->set ($x, $y, $text, $rend)
201	Write a string at the given position into the overlay.	477	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
		478	text in rxvt-unicode's special encoding and an array of
		479	rendition values at a specific position inside the overlay.
202		480
		481	$overlay->hide
		482	If visible, hide the overlay, but do not destroy it.
		483
		484	$overlay->show
		485	If hidden, display the overlay again.
		486
		487	$popup = $term->popup ($event)
		488	Creates a new "urxvt::popup" object that implements a popup menu.
		489	The $event must be the event causing the menu to pop up (a button
		490	event, currently).
		491
203	$cellwidth = $term->strwidth $string	492	$cellwidth = $term->strwidth ($string)
204	Returns the number of screen-cells this string would need. Correctly	493	Returns the number of screen-cells this string would need. Correctly
205	accounts for wide and combining characters.	494	accounts for wide and combining characters.
206		495
207	$octets = $term->locale_encode $string	496	$octets = $term->locale_encode ($string)
208	Convert the given text string into the corresponding locale	497	Convert the given text string into the corresponding locale
209	encoding.	498	encoding.
210		499
211	$string = $term->locale_decode $octets	500	$string = $term->locale_decode ($octets)
212	Convert the given locale-encoded octets into a perl string.	501	Convert the given locale-encoded octets into a perl string.
		502
		503	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		504	XORs the rendition values in the given span with the provided value
		505	(default: "RS_RVid"). Useful in refresh hooks to provide effects
		506	similar to the selection.
		507
		508	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
		509	$rstyle2]])
		510	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
		511	whitespace will additionally be xored with the $rstyle2, which
		512	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
		513	and underlines it instead.
		514
		515	$term->scr_bell
		516	Ring the bell!
		517
		518	$term->scr_add_lines ($string)
		519	Write the given text string to the screen, as if output by the
		520	application running inside the terminal. It may not contain command
		521	sequences (escape codes), but is free to use line feeds, carriage
		522	returns and tabs. The string is a normal text string, not in
		523	locale-dependent encoding.
		524
		525	Normally its not a good idea to use this function, as programs might
		526	be confused by changes in cursor position or scrolling. Its useful
		527	inside a "on_add_lines" hook, though.
		528
		529	$term->cmd_parse ($octets)
		530	Similar to "scr_add_lines", but the argument must be in the
		531	locale-specific encoding of the terminal and can contain command
		532	sequences (escape codes) that will be interpreted.
213		533
214	$term->tt_write ($octets)	534	$term->tt_write ($octets)
215	Write the octets given in $data to the tty (i.e. as program input).	535	Write the octets given in $data to the tty (i.e. as program input).
216	To pass characters instead of octets, you should convetr you strings	536	To pass characters instead of octets, you should convert your
217	first to the locale-specific encoding using "$term->locale_encode".	537	strings first to the locale-specific encoding using
		538	"$term->locale_encode".
218		539
		540	$old_events = $term->pty_ev_events ([$new_events])
		541	Replaces the event mask of the pty watcher by the given event mask.
		542	Can be used to suppress input and output handling to the pty/tty.
		543	See the description of "urxvt::timer->events". Make sure to always
		544	restore the previous value.
		545
		546	$windowid = $term->parent
		547	Return the window id of the toplevel window.
		548
		549	$windowid = $term->vt
		550	Return the window id of the terminal window.
		551
		552	$window_width = $term->width
		553	$window_height = $term->height
		554	$font_width = $term->fwidth
		555	$font_height = $term->fheight
		556	$font_ascent = $term->fbase
		557	$terminal_rows = $term->nrow
		558	$terminal_columns = $term->ncol
		559	$has_focus = $term->focus
		560	$is_mapped = $term->mapped
		561	$max_scrollback = $term->saveLines
		562	$nrow_plus_saveLines = $term->total_rows
		563	$lines_in_scrollback = $term->nsaved
		564	Return various integers describing terminal characteristics.
		565
		566	$lc_ctype = $term->locale
		567	Returns the LC_CTYPE category string used by this rxvt-unicode.
		568
		569	$x_display = $term->display_id
		570	Return the DISPLAY used by rxvt-unicode.
		571
		572	$modifiermask = $term->ModLevel3Mask
		573	$modifiermask = $term->ModMetaMask
		574	$modifiermask = $term->ModNumLockMask
		575	Return the modifier masks corresponding to the "ISO Level 3 Shift"
		576	(often AltGr), the meta key (often Alt) and the num lock key, if
		577	applicable.
		578
		579	$view_start = $term->view_start ([$newvalue])
		580	Returns the negative row number of the topmost line. Minimum value
		581	is 0, which displays the normal terminal contents. Larger values
		582	scroll this many lines into the scrollback buffer.
		583
		584	$term->want_refresh
		585	Requests a screen refresh. At the next opportunity, rxvt-unicode
		586	will compare the on-screen display with its stored representation.
		587	If they differ, it redraws the differences.
		588
		589	Used after changing terminal contents to display them.
		590
		591	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		592	Returns the text of the entire row with number $row_number. Row 0 is
		593	the topmost terminal line, row "$term->$ncol-1" is the bottommost
		594	terminal line. The scrollback buffer starts at line -1 and extends
		595	to line "-$term->nsaved". Nothing will be returned if a nonexistent
		596	line is requested.
		597
		598	If $new_text is specified, it will replace characters in the current
		599	line, starting at column $start_col (default 0), which is useful to
		600	replace only parts of a line. The font index in the rendition will
		601	automatically be updated.
		602
		603	$text is in a special encoding: tabs and wide characters that use
		604	more than one cell when displayed are padded with urxvt::NOCHAR
		605	characters ("chr 65535"). Characters with combining characters and
		606	other characters that do not fit into the normal tetx encoding will
		607	be replaced with characters in the private use area.
		608
		609	You have to obey this encoding when changing text. The advantage is
		610	that "substr" and similar functions work on screen cells and not on
		611	characters.
		612
		613	The methods "$term->special_encode" and "$term->special_decode" can
		614	be used to convert normal strings into this encoding and vice versa.
		615
		616	$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		617	Like "$term->ROW_t", but returns an arrayref with rendition bitsets.
		618	Rendition bitsets contain information about colour, font, font
		619	styles and similar information. See also "$term->ROW_t".
		620
		621	When setting rendition, the font mask will be ignored.
		622
		623	See the section on RENDITION, above.
		624
		625	$length = $term->ROW_l ($row_number[, $new_length])
		626	Returns the number of screen cells that are in use ("the line
		627	length"). Unlike the urxvt core, this returns "$term->ncol" if the
		628	line is joined with the following one.
		629
		630	$bool = $term->is_longer ($row_number)
		631	Returns true if the row is part of a multiple-row logical "line"
		632	(i.e. joined with the following row), which means all characters are
		633	in use and it is continued on the next row (and possibly a
		634	continuation of the previous row(s)).
		635
		636	$line = $term->line ($row_number)
		637	Create and return a new "urxvt::line" object that stores information
		638	about the logical line that row $row_number is part of. It supports
		639	the following methods:
		640
		641	$text = $line->t ([$new_text])
		642	Returns or replaces the full text of the line, similar to
		643	"ROW_t"
		644
		645	$rend = $line->r ([$new_rend])
		646	Returns or replaces the full rendition array of the line,
		647	similar to "ROW_r"
		648
		649	$length = $line->l
		650	Returns the length of the line in cells, similar to "ROW_l".
		651
		652	$rownum = $line->beg
		653	$rownum = $line->end
		654	Return the row number of the first/last row of the line,
		655	respectively.
		656
		657	$offset = $line->offset_of ($row, $col)
		658	Returns the character offset of the given row\|col pair within
		659	the logical line.
		660
		661	($row, $col) = $line->coord_of ($offset)
		662	Translates a string offset into terminal coordinates again.
		663
		664	$text = $term->special_encode $string
		665	Converts a perl string into the special encoding used by
		666	rxvt-unicode, where one character corresponds to one screen cell.
		667	See "$term->ROW_t" for details.
		668
		669	$string = $term->special_decode $text
		670	Converts rxvt-unicodes text reprsentation into a perl string. See
		671	"$term->ROW_t" for details.
		672
		673	$success = $term->grab_button ($button, $modifiermask)
		674	Registers a synchronous button grab. See the XGrabButton manpage.
		675
		676	$success = $term->grab ($eventtime[, $sync])
		677	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		678	synchronous ($sync is true). Also remembers the grab timestampe.
		679
		680	$term->allow_events_async
		681	Calls XAllowEvents with AsyncBoth for the most recent grab.
		682
		683	$term->allow_events_sync
		684	Calls XAllowEvents with SyncBoth for the most recent grab.
		685
		686	$term->allow_events_replay
		687	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		688	the most recent grab.
		689
		690	$term->ungrab
		691	Calls XUngrab for the most recent grab. Is called automatically on
		692	evaluation errors, as it is better to lose the grab in the error
		693	case as the session.
		694
		695	The "urxvt::popup" Class
219	The "urxvt::timer" Class	696	The "urxvt::timer" Class
220	This class implements timer watchers/events. Time is represented as a	697	This class implements timer watchers/events. Time is represented as
221	fractional number of seconds since the epoch. Example:	698	a fractional number of seconds since the epoch. Example:
222		699
223	# create a digital clock display in upper right corner	700	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
224	$term->{timer} = urxvt::timer	701	$term->{timer} = urxvt::timer
225	->new	702	->new
226	->start (urxvt::NOW)	703	->interval (1)
227	->cb (sub {	704	->cb (sub {
228	my ($timer) = @_;
229	my $time = $timer->at;
230	$timer->start ($time + 1);
231	$self->scr_overlay (-1, 0,	705	$term->{overlay}->set (0, 0,
232	POSIX::strftime "%H:%M:%S", localtime $time);	706	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
233	});	707	});
234		708
235	$timer = new urxvt::timer	709	$timer = new urxvt::timer
236	Create a new timer object in stopped state.	710	Create a new timer object in started state. It is scheduled to
		711	fire immediately.
237		712
238	$timer = $timer->cb (sub { my ($timer) = @_; ... })	713	$timer = $timer->cb (sub { my ($timer) = @_; ... })
239	Set the callback to be called when the timer triggers.	714	Set the callback to be called when the timer triggers.
240		715
241	$tstamp = $timer->at	716	$tstamp = $timer->at
242	Return the time this watcher will fire next.	717	Return the time this watcher will fire next.
243		718
244	$timer = $timer->set ($tstamp)	719	$timer = $timer->set ($tstamp)
245	Set the time the event is generated to $tstamp.	720	Set the time the event is generated to $tstamp.
246		721
		722	$timer = $timer->interval ($interval)
		723	Normally (and when $interval is 0), the timer will automatically
		724	stop after it has fired once. If $interval is non-zero, then the
		725	timer is automatically rescheduled at the given intervals.
		726
247	$timer = $timer->start	727	$timer = $timer->start
248	Start the timer.	728	Start the timer.
249		729
250	$timer = $timer->start ($tstamp)	730	$timer = $timer->start ($tstamp)
251	Set the event trigger time to $tstamp and start the timer.	731	Set the event trigger time to $tstamp and start the timer.
252		732
253	$timer = $timer->stop	733	$timer = $timer->stop
254	Stop the timer.	734	Stop the timer.
255		735
256	The "urxvt::iow" Class	736	The "urxvt::iow" Class
257	This class implements io watchers/events. Example:	737	This class implements io watchers/events. Example:
258		738
259	$term->{socket} = ...	739	$term->{socket} = ...
260	$term->{iow} = urxvt::iow	740	$term->{iow} = urxvt::iow
261	->new	741	->new
262	->fd (fileno $term->{socket})	742	->fd (fileno $term->{socket})
263	->events (1) # wait for read data	743	->events (urxvt::EVENT_READ)
264	->start	744	->start
265	->cb (sub {	745	->cb (sub {
266	my ($iow, $revents) = @_;	746	my ($iow, $revents) = @_;
267	# $revents must be 1 here, no need to check	747	# $revents must be 1 here, no need to check
268	sysread $term->{socket}, my $buf, 8192	748	sysread $term->{socket}, my $buf, 8192
269	or end-of-file;	749	or end-of-file;
270	});	750	});
271		751
272	$iow = new urxvt::iow	752	$iow = new urxvt::iow
273	Create a new io watcher object in stopped state.	753	Create a new io watcher object in stopped state.
274		754
275	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	755	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
276	Set the callback to be called when io events are triggered.	756	Set the callback to be called when io events are triggered.
277	$reventmask is a bitset as described in the "events" method.	757	$reventmask is a bitset as described in the "events" method.
278		758
279	$iow = $iow->fd ($fd)	759	$iow = $iow->fd ($fd)
280	Set the filedescriptor (not handle) to watch.	760	Set the filedescriptor (not handle) to watch.
281		761
282	$iow = $iow->events ($eventmask)	762	$iow = $iow->events ($eventmask)
283	Set the event mask to watch. Bit #0 (value 1) enables watching for	763	Set the event mask to watch. The only allowed values are
284	read data, Bit #1 (value 2) enables watching for write data.	764	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be
		765	ORed together, or "urxvt::EVENT_NONE".
285		766
286	$iow = $iow->start	767	$iow = $iow->start
287	Start watching for requested events on the given handle.	768	Start watching for requested events on the given handle.
288		769
289	$iow = $iow->stop	770	$iow = $iow->stop
290	Stop watching for events on the given filehandle.	771	Stop watching for events on the given filehandle.
291		772
292	ENVIRONMENT	773	ENVIRONMENT
293	URXVT_PERL_VERBOSITY	774	URXVT_PERL_VERBOSITY
294	This variable controls the verbosity level of the perl extension. Higher	775	This variable controls the verbosity level of the perl extension.
295	numbers indicate more verbose output.	776	Higher numbers indicate more verbose output.
296		777
297	0 - only fatal messages	778	== 0 - fatal messages
298	3 - script loading and management	779	>= 3 - script loading and management
299	10 - all events received	780	>=10 - all events received
300		781
301	AUTHOR	782	AUTHOR
302	Marc Lehmann <pcg@goof.com>	783	Marc Lehmann <pcg@goof.com>
303	http://software.schmorp.de/pkg/rxvt-unicode	784	http://software.schmorp.de/pkg/rxvt-unicode
304		785

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.1 by root, Mon Jan 2 19:36:07 2006 UTC vs. Revision 1.18 by root, Tue Jan 10 18:09:22 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.1 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.18 by root, Tue Jan 10 18:09:22 2006 UTC