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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.23 by root, Thu Jan 12 05:37:34 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs. Revision 1.23 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.23 by root, Thu Jan 12 05:37:34 2006 UTC