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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.2 by root, Mon Jan 2 20:35:39 2006 UTC vs. Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.2 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC