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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC

…		…
12	# start a rxvt using it:	12	# start a rxvt using it:
13		13
14	rxvt --perl-lib $HOME -pe grab_test	14	rxvt --perl-lib $HOME -pe grab_test
15		15
16	DESCRIPTION	16	DESCRIPTION
17	Everytime a terminal object gets created, scripts specified via the	17	Everytime a terminal object gets created, extension scripts specified
18	"perl" resource are loaded and associated with it.	18	via the "perl" resource are loaded and associated with it.
19		19
20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
21	thus must be encoded as UTF-8.	21	thus must be encoded as UTF-8.
22		22
23	Each script will only ever be loaded once, even in rxvtd, where scripts	23	Each script will only ever be loaded once, even in rxvtd, where scripts
…		…
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	Intelligent selection. This extension tries to be more intelligent	35	Intelligent selection. This extension tries to be more intelligent
36	when the user extends selections (double-click). Right now, it tries	36	when the user extends selections (double-click). Right now, it tries
37	to select urls and complete shell-quoted arguments, which is very	37	to select urls and complete shell-quoted arguments, which is very
38	convenient, too, if your ls supports "--quoting-style=shell".	38	convenient, too, if your ls supports "--quoting-style=shell".
39		39
…		…
42	rot13	42	rot13
43	Rot-13 the selection when activated. Used via keyboard trigger:	43	Rot-13 the selection when activated. Used via keyboard trigger:
44		44
45	URxvt.keysym.C-M-r: perl:selection:rot13	45	URxvt.keysym.C-M-r: perl:selection:rot13
46		46
		47	option-popup (enabled by default)
		48	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		49	options at runtime.
		50
		51	selection-popup (enabled by default)
		52	Binds a popup menu to Ctrl-Button3 that lets you convert the
		53	selection text into various other formats/action.
		54
47	digital-clock	55	digital-clock
48	Displays a digital clock using the built-in overlay.	56	Displays a digital clock using the built-in overlay.
		57
		58	mark-urls
		59	Uses per-line display filtering ("on_line_update") to underline
		60	urls.
		61
		62	block-graphics-to-ascii
		63	A not very useful example of filtering all text output to the
		64	terminal, by replacing all line-drawing characters (U+2500 ..
		65	U+259F) by a similar-looking ascii character.
49		66
50	example-refresh-hooks	67	example-refresh-hooks
51	Displays a very simple digital clock in the upper right corner of	68	Displays a very simple digital clock in the upper right corner of
52	the window. Illustrates overwriting the refresh callbacks to create	69	the window. Illustrates overwriting the refresh callbacks to create
53	your own overlays or changes.	70	your own overlays or changes.
…		…
62	When objects are destroyed on the C++ side, the perl object hashes are	79	When objects are destroyed on the C++ side, the perl object hashes are
63	emptied, so its best to store related objects such as time watchers and	80	emptied, so its best to store related objects such as time watchers and
64	the like inside the terminal object so they get destroyed as soon as the	81	the like inside the terminal object so they get destroyed as soon as the
65	terminal is destroyed.	82	terminal is destroyed.
66		83
		84	Argument names also often indicate the type of a parameter. Here are
		85	some hints on what they mean:
		86
		87	$text
		88	Rxvt-unicodes special way of encoding text, where one "unicode"
		89	character always represents one screen cell. See row_t for a
		90	discussion of this format.
		91
		92	$string
		93	A perl text string, with an emphasis on text. It can store all
		94	unicode characters and is to be distinguished with text encoded in a
		95	specific encoding (often locale-specific) and binary data.
		96
		97	$octets
		98	Either binary data or - more common - a text string encoded in a
		99	locale-specific way.
		100
67	Hooks	101	Hooks
68	The following subroutines can be declared in loaded scripts, and will be	102	The following subroutines can be declared in extension files, and will
69	called whenever the relevant event happens.	103	be called whenever the relevant event happens.
70		104
71	The first argument passed to them is an object private to each terminal	105	The first argument passed to them is an object private to each terminal
72	and extension package. You can call all "urxvt::term" methods on it, but	106	and extension package. You can call all "urxvt::term" methods on it, but
73	its not a real "urxvt::term" object. Instead, the real "urxvt::term"	107	its not a real "urxvt::term" object. Instead, the real "urxvt::term"
74	object that is shared between all packages is stored in the "term"	108	object that is shared between all packages is stored in the "term"
75	member.	109	member. It is, however, blessed intot he package of the extension
		110	script, so for all practical purposes you can treat an extension script
		111	as a class.
76		112
77	All of them must return a boolean value. If it is true, then the event	113	All of them must return a boolean value. If it is true, then the event
78	counts as being consumed, and the invocation of other hooks is	114	counts as being consumed, and the invocation of other hooks is
79	skipped, and the relevant action might not be carried out by the C++	115	skipped, and the relevant action might not be carried out by the C++
80	code.	116	code.
81		117
82	When in doubt, return a false value (preferably "()").	118	When in doubt, return a false value (preferably "()").
83		119
84	on_init $term	120	on_init $term
85	Called after a new terminal object has been initialized, but before	121	Called after a new terminal object has been initialized, but before
86	windows are created or the command gets run.	122	windows are created or the command gets run. Most methods are unsafe
		123	to call or deliver senseless data, as terminal size and other
		124	characteristics have not yet been determined. You can safely query
		125	and change resources, though.
87		126
88	on_reset $term	127	on_reset $term
89	Called after the screen is "reset" for any reason, such as resizing	128	Called after the screen is "reset" for any reason, such as resizing
90	or control sequences. Here is where you can react on changes to	129	or control sequences. Here is where you can react on changes to
91	size-related variables.	130	size-related variables.
…		…
117	operation), or should extend the selection itelf and return true to	156	operation), or should extend the selection itelf and return true to
118	suppress the built-in processing.	157	suppress the built-in processing.
119		158
120	See the selection example extension.	159	See the selection example extension.
121		160
122	on_focus_in $term
123	Called whenever the window gets the keyboard focus, before urxvt
124	does focus in processing.
125
126	on_focus_out $term
127	Called wheneever the window loses keyboard focus, before urxvt does
128	focus out processing.
129
130	on_view_change $term, $offset	161	on_view_change $term, $offset
131	Called whenever the view offset changes, i..e the user or program	162	Called whenever the view offset changes, i..e the user or program
132	scrolls. Offset 0 means display the normal terminal, positive values	163	scrolls. Offset 0 means display the normal terminal, positive values
133	show this many lines of scrollback.	164	show this many lines of scrollback.
134		165
…		…
138	may be larger than the scroll back buffer or the terminal.	169	may be larger than the scroll back buffer or the terminal.
139		170
140	It is called before lines are scrolled out (so rows 0 .. min ($lines	171	It is called before lines are scrolled out (so rows 0 .. min ($lines
141	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	172	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
142	the total number of lines that will be in the scrollback buffer.	173	the total number of lines that will be in the scrollback buffer.
143
144	on_tty_activity $term NYI
145	Called whenever the program(s) running in the urxvt window send
146	output.
147		174
148	on_osc_seq $term, $string	175	on_osc_seq $term, $string
149	Called whenever the ESC ] 777 ; string ST command sequence (OSC =	176	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
150	operating system command) is processed. Cursor position and other	177	operating system command) is processed. Cursor position and other
151	state information is up-to-date when this happens. For	178	state information is up-to-date when this happens. For
…		…
155		182
156	Be careful not ever to trust (in a security sense) the data you	183	Be careful not ever to trust (in a security sense) the data you
157	receive, as its source can not easily be controleld (e-mail content,	184	receive, as its source can not easily be controleld (e-mail content,
158	messages from other users on the same system etc.).	185	messages from other users on the same system etc.).
159		186
		187	on_add_lines $term, $string
		188	Called whenever text is about to be output, with the text as
		189	argument. You can filter/change and output the text yourself by
		190	returning a true value and calling "$term->scr_add_lines" yourself.
		191	Please note that this might be very slow, however, as your hook is
		192	called for all text being output.
		193
		194	on_line_update $term, $row
		195	Called whenever a line was updated or changed. Can be used to filter
		196	screen output (e.g. underline urls or other useless stuff). Only
		197	lines that are being shown will be filtered, and, due to performance
		198	reasons, not always immediately.
		199
		200	The row number is always the topmost row of the line if the line
		201	spans multiple rows.
		202
		203	Please note that, if you change the line, then the hook might get
		204	called later with the already-modified line (e.g. if unrelated parts
		205	change), so you cannot just toggle rendition bits, but only set
		206	them.
		207
160	on_refresh_begin $term	208	on_refresh_begin $term
161	Called just before the screen gets redrawn. Can be used for overlay	209	Called just before the screen gets redrawn. Can be used for overlay
162	or similar effects by modify terminal contents in refresh_begin, and	210	or similar effects by modify terminal contents in refresh_begin, and
163	restoring them in refresh_end. The built-in overlay and selection	211	restoring them in refresh_end. The built-in overlay and selection
164	display code is run after this hook, and takes precedence.	212	display code is run after this hook, and takes precedence.
…		…
169	on_keyboard_command $term, $string	217	on_keyboard_command $term, $string
170	Called whenever the user presses a key combination that has a	218	Called whenever the user presses a key combination that has a
171	"perl:string" action bound to it (see description of the keysym	219	"perl:string" action bound to it (see description of the keysym
172	resource in the rxvt(1) manpage).	220	resource in the rxvt(1) manpage).
173		221
		222	on_focus_in $term
		223	Called whenever the window gets the keyboard focus, before
		224	rxvt-unicode does focus in processing.
		225
		226	on_focus_out $term
		227	Called wheneever the window loses keyboard focus, before
		228	rxvt-unicode does focus out processing.
		229
		230	on_key_press $term, $event, $octets
		231	on_key_release $term, $event
		232	on_button_press $term, $event
		233	on_button_release $term, $event
		234	on_motion_notify $term, $event
		235	on_map_notify $term, $event
		236	on_unmap_notify $term, $event
		237	Called whenever the corresponding X event is received for the
		238	terminal If the hook returns true, then the even will be ignored by
		239	rxvt-unicode.
		240
		241	The event is a hash with most values as named by Xlib (see the
		242	XEvent manpage), with the additional members "row" and "col", which
		243	are the row and column under the mouse cursor.
		244
		245	"on_key_press" additionally receives the string rxvt-unicode would
		246	output, if any, in locale-specific encoding.
		247
		248	subwindow.
		249
174	Variables in the "urxvt" Package	250	Variables in the "urxvt" Package
175	$urxvt::TERM	251	$urxvt::TERM
176	The current terminal. Whenever a callback/Hook is bein executed,
177	this variable stores the current "urxvt::term" object.	252	The current terminal. This variable stores the current "urxvt::term"
		253	object, whenever a callback/hook is executing.
178		254
179	Functions in the "urxvt" Package	255	Functions in the "urxvt" Package
		256	$term = new urxvt [arg...]
		257	Creates a new terminal, very similar as if you had started it with
		258	"system $binfile, arg...". Croaks (and probably outputs an error
		259	message) if the new instance couldn't be created. Returns "undef" if
		260	the new instance didn't initialise perl, and the terminal object
		261	otherwise. The "init" and "start" hooks will be called during the
		262	call.
		263
180	urxvt::fatal $errormessage	264	urxvt::fatal $errormessage
181	Fatally aborts execution with the given error message. Avoid at all	265	Fatally aborts execution with the given error message. Avoid at all
182	costs! The only time this is acceptable is when the terminal process	266	costs! The only time this is acceptable is when the terminal process
183	starts up.	267	starts up.
184		268
…		…
191	correct place, e.g. on stderr of the connecting urxvtc client.	275	correct place, e.g. on stderr of the connecting urxvtc client.
192		276
193	$time = urxvt::NOW	277	$time = urxvt::NOW
194	Returns the "current time" (as per the event loop).	278	Returns the "current time" (as per the event loop).
195		279
		280	urxvt::CurrentTime
		281	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
		282	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
		283	Button5Mask, AnyModifier
		284	Various constants for use in X calls and event processing.
		285
196	RENDITION	286	RENDITION
197	Rendition bitsets contain information about colour, font, font styles	287	Rendition bitsets contain information about colour, font, font styles
198	and similar information for each screen cell.	288	and similar information for each screen cell.
199		289
200	The following "macros" deal with changes in rendition sets. You should	290	The following "macros" deal with changes in rendition sets. You should
…		…
230	initially zero.	320	initially zero.
231		321
232	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	322	$rend = urxvt::SET_CUSTOM ($rend, $new_value)
233	Change the custom value.	323	Change the custom value.
234		324
		325	The "urxvt::anyevent" Class
		326	The sole purpose of this class is to deliver an interface to the
		327	"AnyEvent" module - any module using it will work inside urxvt without
		328	further work. The only exception is that you cannot wait on condition
		329	variables, but non-blocking condvar use is ok. What this means is that
		330	you cannot use blocking APIs, but the non-blocking variant should work.
		331
235	The "urxvt::term" Class	332	The "urxvt::term" Class
		333	$term->destroy
		334	Destroy the terminal object (close the window, free resources etc.).
		335
		336	$isset = $term->option ($optval[, $set])
		337	Returns true if the option specified by $optval is enabled, and
		338	optionally change it. All option values are stored by name in the
		339	hash %urxvt::OPTION. Options not enabled in this binary are not in
		340	the hash.
		341
		342	Here is a a likely non-exhaustive list of option names, please see
		343	the source file /src/optinc.h to see the actual list:
		344
		345	borderLess console cursorBlink cursorUnderline hold iconic insecure
		346	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		347	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		348	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		349	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		350	tripleclickwords utmpInhibit visualBell
		351
236	$value = $term->resource ($name[, $newval])	352	$value = $term->resource ($name[, $newval])
237	Returns the current resource value associated with a given name and	353	Returns the current resource value associated with a given name and
238	optionally sets a new value. Setting values is most useful in the	354	optionally sets a new value. Setting values is most useful in the
239	"init" hook. Unset resources are returned and accepted as "undef".	355	"init" hook. Unset resources are returned and accepted as "undef".
240		356
…		…
249	Please note that resource strings will currently only be freed when	365	Please note that resource strings will currently only be freed when
250	the terminal is destroyed, so changing options frequently will eat	366	the terminal is destroyed, so changing options frequently will eat
251	memory.	367	memory.
252		368
253	Here is a a likely non-exhaustive list of resource names, not all of	369	Here is a a likely non-exhaustive list of resource names, not all of
254	which are supported in every build, please see the source to see the	370	which are supported in every build, please see the source file
255	actual list:	371	/src/rsinc.h to see the actual list:
256		372
257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	373	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
258	borderLess color cursorBlink cursorUnderline cutchars delete_key	374	borderLess color cursorBlink cursorUnderline cutchars delete_key
259	display_name embed ext_bwidth fade font geometry hold iconName	375	display_name embed ext_bwidth fade font geometry hold iconName
260	imFont imLocale inputMethod insecure int_bwidth intensityStyles	376	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
265	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	381	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
266	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	382	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
267	shade term_name title transparent transparent_all tripleclickwords	383	shade term_name title transparent transparent_all tripleclickwords
268	utmpInhibit visualBell	384	utmpInhibit visualBell
269		385
270	$rend = $term->screen_rstyle ([$new_rstyle])	386	$rend = $term->rstyle ([$new_rstyle])
271	Return and optionally change the current rendition. Text thta is	387	Return and optionally change the current rendition. Text that is
272	output by the temrianl application will use this style.	388	output by the terminal application will use this style.
273		389
274	($row, $col) = $term->screen_cur ([$row, $col])	390	($row, $col) = $term->screen_cur ([$row, $col])
275	Return the current coordinates of the text cursor position and	391	Return the current coordinates of the text cursor position and
276	optionally set it (which is usually bad as applications don't expect	392	optionally set it (which is usually bad as applications don't expect
277	that).	393	that).
…		…
289	$oldtext = $term->selection ([$newtext])	405	$oldtext = $term->selection ([$newtext])
290	Return the current selection text and optionally replace it by	406	Return the current selection text and optionally replace it by
291	$newtext.	407	$newtext.
292		408
293	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	409	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line
294	overlay box. See the next method for details. # #=cut	410	overlay box. See the next method for details. # #=cut # #sub
295
296	sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_;	411	urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my
297		412	@lines = split /\n/, $text; # # my $w = 0; # for (map
298	my @lines = split /\n/, $text;	413	$self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # #
299
300	my $w = 0;
301	for (map $self->strwidth ($_), @lines) {
302	$w = $_ if $w < $_;
303	}
304
305	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	414	$self->scr_overlay_new ($x, $y, $w, scalar @lines); #
306	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	415	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #}
307	}
308		416
309	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	417	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
310	Create a new (empty) overlay at the given position with the given	418	Create a new (empty) overlay at the given position with the given
311	width/height. $rstyle defines the initial rendition style (default:	419	width/height. $rstyle defines the initial rendition style (default:
312	"OVERLAY_RSTYLE").	420	"OVERLAY_RSTYLE").
…		…
331	If visible, hide the overlay, but do not destroy it.	439	If visible, hide the overlay, but do not destroy it.
332		440
333	$overlay->show	441	$overlay->show
334	If hidden, display the overlay again.	442	If hidden, display the overlay again.
335		443
		444	$popup = $term->popup ($event)
		445	Creates a new "urxvt::popup" object that implements a popup menu.
		446	The $event must be the event causing the menu to pop up (a button
		447	event, currently).
		448
336	$cellwidth = $term->strwidth $string	449	$cellwidth = $term->strwidth ($string)
337	Returns the number of screen-cells this string would need. Correctly	450	Returns the number of screen-cells this string would need. Correctly
338	accounts for wide and combining characters.	451	accounts for wide and combining characters.
339		452
340	$octets = $term->locale_encode $string	453	$octets = $term->locale_encode ($string)
341	Convert the given text string into the corresponding locale	454	Convert the given text string into the corresponding locale
342	encoding.	455	encoding.
343		456
344	$string = $term->locale_decode $octets	457	$string = $term->locale_decode ($octets)
345	Convert the given locale-encoded octets into a perl string.	458	Convert the given locale-encoded octets into a perl string.
		459
		460	$term->scr_add_lines ($string)
		461	Write the given text string to the screen, as if output by the
		462	application running inside the terminal. It may not contain command
		463	sequences (escape codes), but is free to use line feeds, carriage
		464	returns and tabs. The string is a normal text string, not in
		465	locale-dependent encoding.
		466
		467	Normally its not a good idea to use this function, as programs might
		468	be confused by changes in cursor position or scrolling. Its useful
		469	inside a "on_add_lines" hook, though.
		470
		471	$term->cmd_parse ($octets)
		472	Similar to "scr_add_lines", but the argument must be in the
		473	locale-specific encoding of the terminal and can contain command
		474	sequences (escape codes) that will be interpreted.
346		475
347	$term->tt_write ($octets)	476	$term->tt_write ($octets)
348	Write the octets given in $data to the tty (i.e. as program input).	477	Write the octets given in $data to the tty (i.e. as program input).
349	To pass characters instead of octets, you should convert your	478	To pass characters instead of octets, you should convert your
350	strings first to the locale-specific encoding using	479	strings first to the locale-specific encoding using
351	"$term->locale_encode".	480	"$term->locale_encode".
		481
		482	$windowid = $term->parent
		483	Return the window id of the toplevel window.
		484
		485	$windowid = $term->vt
		486	Return the window id of the terminal window.
352		487
353	$window_width = $term->width	488	$window_width = $term->width
354	$window_height = $term->height	489	$window_height = $term->height
355	$font_width = $term->fwidth	490	$font_width = $term->fwidth
356	$font_height = $term->fheight	491	$font_height = $term->fheight
…		…
362	$max_scrollback = $term->saveLines	497	$max_scrollback = $term->saveLines
363	$nrow_plus_saveLines = $term->total_rows	498	$nrow_plus_saveLines = $term->total_rows
364	$lines_in_scrollback = $term->nsaved	499	$lines_in_scrollback = $term->nsaved
365	Return various integers describing terminal characteristics.	500	Return various integers describing terminal characteristics.
366		501
		502	$modifiermask = $term->ModLevel3Mask
		503	$modifiermask = $term->ModMetaMask
		504	$modifiermask = $term->ModNumLockMask
		505	Return the modifier masks corresponding to the "ISO Level 3 Shift"
		506	(often AltGr), the meta key (often Alt) and the num lock key, if
		507	applicable.
		508
367	$view_start = $term->view_start ([$newvalue])	509	$view_start = $term->view_start ([$newvalue])
368	Returns the negative row number of the topmost line. Minimum value	510	Returns the negative row number of the topmost line. Minimum value
369	is 0, which displays the normal terminal contents. Larger values	511	is 0, which displays the normal terminal contents. Larger values
370	scroll this many lines into the scrollback buffer.	512	scroll this many lines into the scrollback buffer.
371		513
…		…
424	$line = $term->line ($row_number)	566	$line = $term->line ($row_number)
425	Create and return a new "urxvt::line" object that stores information	567	Create and return a new "urxvt::line" object that stores information
426	about the logical line that row $row_number is part of. It supports	568	about the logical line that row $row_number is part of. It supports
427	the following methods:	569	the following methods:
428		570
429	$text = $line->t	571	$text = $line->t ([$new_text])
430	Returns the full text of the line, similar to "ROW_t"	572	Returns or replaces the full text of the line, similar to
		573	"ROW_t"
431		574
432	$rend = $line->r	575	$rend = $line->r ([$new_rend])
433	Returns the full rendition array of the line, similar to "ROW_r"	576	Returns or replaces the full rendition array of the line,
		577	similar to "ROW_r"
434		578
435	$length = $line->l	579	$length = $line->l
436	Returns the length of the line in cells, similar to "ROW_l".	580	Returns the length of the line in cells, similar to "ROW_l".
437		581
438	$rownum = $line->beg	582	$rownum = $line->beg
…		…
445	the logical line.	589	the logical line.
446		590
447	($row, $col) = $line->coord_of ($offset)	591	($row, $col) = $line->coord_of ($offset)
448	Translates a string offset into terminal coordinates again.	592	Translates a string offset into terminal coordinates again.
449		593
450	($row, $col) = $line->coord_of ($offset) =item $text =
451	$term->special_encode $string	594	$text = $term->special_encode $string
452	Converts a perl string into the special encoding used by	595	Converts a perl string into the special encoding used by
453	rxvt-unicode, where one character corresponds to one screen cell.	596	rxvt-unicode, where one character corresponds to one screen cell.
454	See "$term->ROW_t" for details.	597	See "$term->ROW_t" for details.
455		598
456	$string = $term->special_decode $text	599	$string = $term->special_decode $text
457	Converts rxvt-unicodes text reprsentation into a perl string. See	600	Converts rxvt-unicodes text reprsentation into a perl string. See
458	"$term->ROW_t" for details.	601	"$term->ROW_t" for details.
459		602
		603	$success = $term->grab_button ($button, $modifiermask)
		604	Registers a synchronous button grab. See XGrabButton.
		605
		606	$success = $term->grab ($eventtime[, $sync])
		607	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		608	synchronous ($sync is true). Also remembers the grab timestampe.
		609
		610	$term->allow_events_async
		611	Calls XAllowEvents with AsyncBoth for the most recent grab.
		612
		613	$term->allow_events_sync
		614	Calls XAllowEvents with SyncBoth for the most recent grab.
		615
		616	$term->allow_events_replay
		617	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		618	the most recent grab.
		619
		620	$term->ungrab
		621	Calls XUngrab for the most recent grab. Is called automatically on
		622	evaluation errors, as it is better to lose the grab in the error
		623	case as the session.
		624
		625	The "urxvt::popup" Class
460	The "urxvt::timer" Class	626	The "urxvt::timer" Class
461	This class implements timer watchers/events. Time is represented as a	627	This class implements timer watchers/events. Time is represented as
462	fractional number of seconds since the epoch. Example:	628	a fractional number of seconds since the epoch. Example:
463		629
464	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);	630	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
465	$term->{timer} = urxvt::timer	631	$term->{timer} = urxvt::timer
466	->new	632	->new
467	->interval (1)	633	->interval (1)
468	->cb (sub {	634	->cb (sub {
469	$term->{overlay}->set (0, 0,	635	$term->{overlay}->set (0, 0,
470	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	636	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
471	});	637	});
472		638
473	$timer = new urxvt::timer	639	$timer = new urxvt::timer
474	Create a new timer object in started state. It is scheduled to fire	640	Create a new timer object in started state. It is scheduled to
475	immediately.	641	fire immediately.
476		642
477	$timer = $timer->cb (sub { my ($timer) = @_; ... })	643	$timer = $timer->cb (sub { my ($timer) = @_; ... })
478	Set the callback to be called when the timer triggers.	644	Set the callback to be called when the timer triggers.
479		645
480	$tstamp = $timer->at	646	$tstamp = $timer->at
481	Return the time this watcher will fire next.	647	Return the time this watcher will fire next.
482		648
483	$timer = $timer->set ($tstamp)	649	$timer = $timer->set ($tstamp)
484	Set the time the event is generated to $tstamp.	650	Set the time the event is generated to $tstamp.
485		651
486	$timer = $timer->interval ($interval)	652	$timer = $timer->interval ($interval)
487	Normally (and when $interval is 0), the timer will automatically	653	Normally (and when $interval is 0), the timer will automatically
488	stop after it has fired once. If $interval is non-zero, then the	654	stop after it has fired once. If $interval is non-zero, then the
489	timer is automatically rescheduled at the given intervals.	655	timer is automatically rescheduled at the given intervals.
490		656
491	$timer = $timer->start	657	$timer = $timer->start
492	Start the timer.	658	Start the timer.
493		659
494	$timer = $timer->start ($tstamp)	660	$timer = $timer->start ($tstamp)
495	Set the event trigger time to $tstamp and start the timer.	661	Set the event trigger time to $tstamp and start the timer.
496		662
497	$timer = $timer->stop	663	$timer = $timer->stop
498	Stop the timer.	664	Stop the timer.
499		665
500	The "urxvt::iow" Class	666	The "urxvt::iow" Class
501	This class implements io watchers/events. Example:	667	This class implements io watchers/events. Example:
502		668
503	$term->{socket} = ...	669	$term->{socket} = ...
504	$term->{iow} = urxvt::iow	670	$term->{iow} = urxvt::iow
505	->new	671	->new
506	->fd (fileno $term->{socket})	672	->fd (fileno $term->{socket})
507	->events (1) # wait for read data	673	->events (1) # wait for read data
508	->start	674	->start
509	->cb (sub {	675	->cb (sub {
510	my ($iow, $revents) = @_;	676	my ($iow, $revents) = @_;
511	# $revents must be 1 here, no need to check	677	# $revents must be 1 here, no need to check
512	sysread $term->{socket}, my $buf, 8192	678	sysread $term->{socket}, my $buf, 8192
513	or end-of-file;	679	or end-of-file;
514	});	680	});
515		681
516	$iow = new urxvt::iow	682	$iow = new urxvt::iow
517	Create a new io watcher object in stopped state.	683	Create a new io watcher object in stopped state.
518		684
519	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	685	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
520	Set the callback to be called when io events are triggered.	686	Set the callback to be called when io events are triggered.
521	$reventmask is a bitset as described in the "events" method.	687	$reventmask is a bitset as described in the "events" method.
522		688
523	$iow = $iow->fd ($fd)	689	$iow = $iow->fd ($fd)
524	Set the filedescriptor (not handle) to watch.	690	Set the filedescriptor (not handle) to watch.
525		691
526	$iow = $iow->events ($eventmask)	692	$iow = $iow->events ($eventmask)
527	Set the event mask to watch. Bit #0 (value 1) enables watching for	693	Set the event mask to watch. Bit #0 (value 1) enables watching
528	read data, Bit #1 (value 2) enables watching for write data.	694	for read data, Bit #1 (value 2) enables watching for write data.
529		695
530	$iow = $iow->start	696	$iow = $iow->start
531	Start watching for requested events on the given handle.	697	Start watching for requested events on the given handle.
532		698
533	$iow = $iow->stop	699	$iow = $iow->stop
534	Stop watching for events on the given filehandle.	700	Stop watching for events on the given filehandle.
535		701
536	ENVIRONMENT	702	ENVIRONMENT
537	URXVT_PERL_VERBOSITY	703	URXVT_PERL_VERBOSITY
538	This variable controls the verbosity level of the perl extension. Higher	704	This variable controls the verbosity level of the perl extension.
539	numbers indicate more verbose output.	705	Higher numbers indicate more verbose output.
540		706
541	=0 - only fatal messages	707	== 0 - fatal messages
542	=3 - script loading and management	708	>= 3 - script loading and management
543	=10 - all events received	709	>=10 - all events received
544		710
545	AUTHOR	711	AUTHOR
546	Marc Lehmann <pcg@goof.com>	712	Marc Lehmann <pcg@goof.com>
547	http://software.schmorp.de/pkg/rxvt-unicode	713	http://software.schmorp.de/pkg/rxvt-unicode
548		714

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC vs. Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC