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

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.25 by root, Thu Jan 12 12:15:10 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.25 by root, Thu Jan 12 12:15:10 2006 UTC