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

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