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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.1 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.1 by root, Mon Jan 2 19:36:07 2006 UTC vs. Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.1 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC