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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.2 by root, Mon Jan 2 20:35:39 2006 UTC vs. Revision 1.19 by root, Tue Jan 10 19:46:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.2 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.19 by root, Tue Jan 10 19:46:28 2006 UTC