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

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

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

Diff Legend

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

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

Diff Legend

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