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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.29 by root, Tue Jan 17 16:22:41 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.29 by root, Tue Jan 17 16:22:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.29 by root, Tue Jan 17 16:22:41 2006 UTC