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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.10 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC

…		…
12	# start a rxvt using it:	12	# start a rxvt using it:
13		13
14	rxvt --perl-lib $HOME -pe grab_test	14	rxvt --perl-lib $HOME -pe grab_test
15		15
16	DESCRIPTION	16	DESCRIPTION
17	Everytime a terminal object gets created, scripts specified via the	17	Everytime a terminal object gets created, extension scripts specified
18	"perl" resource are loaded and associated with it.	18	via the "perl" resource are loaded and associated with it.
19		19
20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
21	thus must be encoded as UTF-8.	21	thus must be encoded as UTF-8.
22		22
23	Each script will only ever be loaded once, even in rxvtd, where scripts	23	Each script will only ever be loaded once, even in rxvtd, where scripts
24	will be shared (but not enabled) for all terminals.	24	will be shared (but not enabled) for all terminals.
25		25
26	Prepackaged Extensions	26	PREPACKAGED EXTENSIONS
27	This section describes the extensiosn delivered with this version. You	27	This section describes the extensions delivered with this release. You
28	can find them in /opt/rxvt/lib/urxvt/perl/.	28	can find them in /opt/rxvt/lib/urxvt/perl/.
29		29
30	You can activate them like this:	30	You can activate them like this:
31		31
32	rxvt -pe <extensionname>	32	rxvt -pe <extensionname>
33		33
34	selection	34	selection (enabled by default)
35	Intelligent selection. This extension tries to be more intelligent	35	(More) intelligent selection. This extension tries to be more
36	when the user extends selections (double-click). Right now, it tries	36	intelligent when the user extends selections (double-click and
37	to select urls and complete shell-quoted arguments, which is very	37	further clicks). Right now, it tries to select words, urls and
		38	complete shell-quoted arguments, which is very convenient, too, if
38	convenient, too, if your ls supports "--quoting-style=shell".	39	your ls supports "--quoting-style=shell".
39		40
40	It also offers the following bindable event:	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:
41		63
42	rot13	64	rot13
43	Rot-13 the selection when activated. Used via keyboard trigger:	65	Rot-13 the selection when activated. Used via keyboard trigger:
44		66
45	URxvt.keysym.C-M-r: perl:selection:rot13	67	URxvt.keysym.C-M-r: perl:selection:rot13
		68
		69	option-popup (enabled by default)
		70	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		71	options at runtime.
		72
		73	selection-popup (enabled by default)
		74	Binds a popup menu to Ctrl-Button3 that lets you convert the
		75	selection text into various other formats/action (such as uri
		76	unescaping, perl evalution, web-browser starting etc.), depending on
		77	content.
		78
		79	searchable-scrollback<hotkey> (enabled by default)
		80	Adds regex search functionality to the scrollback buffer, triggered
		81	by a hotkey (default: "M-s"). While in search mode, normal terminal
		82	input/output is suspended and a regex is displayed at the bottom of
		83	the screen.
		84
		85	Inputting characters appends them to the regex and continues
		86	incremental search. "BackSpace" removes a character from the regex,
		87	"Up" and "Down" search upwards/downwards in the scrollback buffer,
		88	"End" jumps to the bottom. "Escape" leaves search mode and returns
		89	to the point where search was started, while "Enter" or "Return"
		90	stay at the current position and additionally stores the first match
		91	in the current line into the primary selection.
		92
		93	selection-autotransform
		94	This selection allows you to do automatic transforms on a selection
		95	whenever a selection is made.
		96
		97	It works by specifying perl snippets (most useful is a single "s///"
		98	operator) that modify $_ as resources:
		99
		100	URxvt.selection-autotransform.0: transform
		101	URxvt.selection-autotransform.1: transform
		102	...
		103
		104	For example, the following will transform selections of the form
		105	"filename:number", often seen in compiler messages, into "vi
		106	+$filename $word":
		107
		108	URxvt.selection-autotransform.0: s/^([^:[: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.
46		138
47	digital-clock	139	digital-clock
48	Displays a digital clock using the built-in overlay.	140	Displays a digital clock using the built-in overlay.
49		141
50	example-refresh-hooks	142	example-refresh-hooks
51	Displays a very simple digital clock in the upper right corner of	143	Displays a very simple digital clock in the upper right corner of
52	the window. Illustrates overwriting the refresh callbacks to create	144	the window. Illustrates overwriting the refresh callbacks to create
53	your own overlays or changes.	145	your own overlays or changes.
54		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
55	General API Considerations	176	General API Considerations
56	All objects (such as terminals, time watchers etc.) are typical	177	All objects (such as terminals, time watchers etc.) are typical
57	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
58	like. All members starting with an underscore (such as "_ptr" or	179	like. All members starting with an underscore (such as "_ptr" or
59	"_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
…		…
62	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
63	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
64	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
65	terminal is destroyed.	186	terminal is destroyed.
66		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
67	Hooks	230	Hooks
68	The following subroutines can be declared in loaded scripts, and will be	231	The following subroutines can be declared in extension files, and will
69	called whenever the relevant event happens.	232	be called whenever the relevant event happens.
70		233
71	The first argument passed to them is an object private to each terminal	234	The first argument passed to them is an extension oject as described in
72	and extension package. You can call all "urxvt::term" methods on it, but	235	the in the "Extension Objects" section.
73	its not a real "urxvt::term" object. Instead, the real "urxvt::term"
74	object that is shared between all packages is stored in the "term"
75	member.
76		236
77	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
78	counts as being consumed, and the invocation of other hooks is	238	event counts as being consumed, and the invocation of other hooks is
79	skipped, and the relevant action might not be carried out by the C++	239	skipped, and the relevant action might not be carried out by the C++
80	code.	240	code.
81		241
82	When in doubt, return a false value (preferably "()").	242	When in doubt, return a false value (preferably "()").
83		243
84	on_init $term	244	on_init $term
85	Called after a new terminal object has been initialized, but before	245	Called after a new terminal object has been initialized, but before
86	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.
87		250
88	on_reset $term	251	on_reset $term
89	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
90	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
91	size-related variables.	254	size-related variables.
…		…
113		276
114	on_sel_extend $term	277	on_sel_extend $term
115	Called whenever the user tries to extend the selection (e.g. with a	278	Called whenever the user tries to extend the selection (e.g. with a
116	double click) and is either supposed to return false (normal	279	double click) and is either supposed to return false (normal
117	operation), or should extend the selection itelf and return true to	280	operation), or should extend the selection itelf and return true to
118	suppress the built-in processing.	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.
119		285
120	See the selection example extension.	286	See the selection example extension.
121
122	on_focus_in $term
123	Called whenever the window gets the keyboard focus, before urxvt
124	does focus in processing.
125
126	on_focus_out $term
127	Called wheneever the window loses keyboard focus, before urxvt does
128	focus out processing.
129		287
130	on_view_change $term, $offset	288	on_view_change $term, $offset
131	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
132	scrolls. Offset 0 means display the normal terminal, positive values	290	scrolls. Offset 0 means display the normal terminal, positive values
133	show this many lines of scrollback.	291	show this many lines of scrollback.
…		…
138	may be larger than the scroll back buffer or the terminal.	296	may be larger than the scroll back buffer or the terminal.
139		297
140	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
141	- 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
142	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.
143
144	on_tty_activity $term NYI
145	Called whenever the program(s) running in the urxvt window send
146	output.
147		301
148	on_osc_seq $term, $string	302	on_osc_seq $term, $string
149	Called whenever the ESC ] 777 ; string ST command sequence (OSC =	303	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
150	operating system command) is processed. Cursor position and other	304	operating system command) is processed. Cursor position and other
151	state information is up-to-date when this happens. For	305	state information is up-to-date when this happens. For
…		…
155		309
156	Be careful not ever to trust (in a security sense) the data you	310	Be careful not ever to trust (in a security sense) the data you
157	receive, as its source can not easily be controleld (e-mail content,	311	receive, as its source can not easily be controleld (e-mail content,
158	messages from other users on the same system etc.).	312	messages from other users on the same system etc.).
159		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.
		338
160	on_refresh_begin $term	339	on_refresh_begin $term
161	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
162	or similar effects by modify terminal contents in refresh_begin, and	341	or similar effects by modify terminal contents in refresh_begin, and
163	restoring them in refresh_end. The built-in overlay and selection	342	restoring them in refresh_end. The built-in overlay and selection
164	display code is run after this hook, and takes precedence.	343	display code is run after this hook, and takes precedence.
…		…
169	on_keyboard_command $term, $string	348	on_keyboard_command $term, $string
170	Called whenever the user presses a key combination that has a	349	Called whenever the user presses a key combination that has a
171	"perl:string" action bound to it (see description of the keysym	350	"perl:string" action bound to it (see description of the keysym
172	resource in the rxvt(1) manpage).	351	resource in the rxvt(1) manpage).
173		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
174	Variables in the "urxvt" Package	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
175	$urxvt::TERM	398	$urxvt::TERM
176	The current terminal. Whenever a callback/Hook is bein executed,
177	this variable stores the current "urxvt::term" object.	399	The current terminal. This variable stores the current "urxvt::term"
		400	object, whenever a callback/hook is executing.
178		401
179	Functions in the "urxvt" Package	402	Functions in the "urxvt" Package
180	urxvt::fatal $errormessage	403	urxvt::fatal $errormessage
181	Fatally aborts execution with the given error message. Avoid at all	404	Fatally aborts execution with the given error message. Avoid at all
182	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
…		…
188	function that calls this function.	411	function that calls this function.
189		412
190	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
191	correct place, e.g. on stderr of the connecting urxvtc client.	414	correct place, e.g. on stderr of the connecting urxvtc client.
192		415
		416	Messages have a size limit of 1023 bytes currently.
		417
193	$time = urxvt::NOW	418	$time = urxvt::NOW
194	Returns the "current time" (as per the event loop).	419	Returns the "current time" (as per the event loop).
		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.
195		441
196	RENDITION	442	RENDITION
197	Rendition bitsets contain information about colour, font, font styles	443	Rendition bitsets contain information about colour, font, font styles
198	and similar information for each screen cell.	444	and similar information for each screen cell.
199		445
…		…
217		463
218	$foreground = urxvt::GET_BASEFG $rend	464	$foreground = urxvt::GET_BASEFG $rend
219	$background = urxvt::GET_BASEBG $rend	465	$background = urxvt::GET_BASEBG $rend
220	Return the foreground/background colour index, respectively.	466	Return the foreground/background colour index, respectively.
221		467
222	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	468	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
223	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	469	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
224	Replace the foreground/background colour in the rendition mask with	470	Replace the foreground/background colour in the rendition mask with
225	the specified one.	471	the specified one.
226		472
227	$value = urxvt::GET_CUSTOM ($rend)	473	$value = urxvt::GET_CUSTOM $rend
228	Return the "custom" value: Every rendition has 5 bits for use by	474	Return the "custom" value: Every rendition has 5 bits for use by
229	extensions. They can be set and changed as you like and are	475	extensions. They can be set and changed as you like and are
230	initially zero.	476	initially zero.
231		477
232	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	478	$rend = urxvt::SET_CUSTOM $rend, $new_value
233	Change the custom value.	479	Change the custom value.
234		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
235	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
236	$value = $term->resource ($name[, $newval])	521	$value = $term->resource ($name[, $newval])
237	Returns the current resource value associated with a given name and	522	Returns the current resource value associated with a given name and
238	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
239	"init" hook. Unset resources are returned and accepted as "undef".	524	"init" hook. Unset resources are returned and accepted as "undef".
240		525
…		…
249	Please note that resource strings will currently only be freed when	534	Please note that resource strings will currently only be freed when
250	the terminal is destroyed, so changing options frequently will eat	535	the terminal is destroyed, so changing options frequently will eat
251	memory.	536	memory.
252		537
253	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
254	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
255	actual list:	540	/src/rsinc.h to see the actual list:
256		541
257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
258	borderLess color cursorBlink cursorUnderline cutchars delete_key	543	borderLess color cursorBlink cursorUnderline cutchars delete_key
259	display_name embed ext_bwidth fade font geometry hold iconName	544	display_name embed ext_bwidth fade font geometry hold iconName
260	imFont imLocale inputMethod insecure int_bwidth intensityStyles	545	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
265	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
266	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
267	shade term_name title transparent transparent_all tripleclickwords	552	shade term_name title transparent transparent_all tripleclickwords
268	utmpInhibit visualBell	553	utmpInhibit visualBell
269		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
270	($row, $col) = $term->selection_mark ([$row, $col])	578	($row, $col) = $term->selection_mark ([$row, $col])
271	($row, $col) = $term->selection_beg ([$row, $col])	579	($row, $col) = $term->selection_beg ([$row, $col])
272	($row, $col) = $term->selection_end ([$row, $col])	580	($row, $col) = $term->selection_end ([$row, $col])
273	Return the current values of the selection mark, begin or end	581	Return the current values of the selection mark, begin or end
274	positions, and optionally set them to new values.	582	positions, and optionally set them to new values.
275		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
276	$success = $term->selection_grab ($eventtime)	590	$success = $term->selection_grab ($eventtime)
277	Try to request the primary selection from the server (for example,	591	Try to request the primary selection text from the server (for
278	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.
279		595
280	$oldtext = $term->selection ([$newtext])	596	$oldtext = $term->selection ([$newtext])
281	Return the current selection text and optionally replace it by	597	Return the current selection text and optionally replace it by
282	$newtext.	598	$newtext.
283		599
284	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	600	$term->overlay_simple ($x, $y, $text)
285	overlay box. See the next method for details. # #=cut	601	Create a simple multi-line overlay box. See the next method for
286		602	details.
287	sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_;
288
289	my @lines = split /\n/, $text;
290
291	my $w = 0;
292	for (map $self->strwidth ($_), @lines) {
293	$w = $_ if $w < $_;
294	}
295
296	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
297	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
298	}
299		603
300	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	604	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
301	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
302	width/height. $rstyle defines the initial rendition style (default:	606	width/height. $rstyle defines the initial rendition style (default:
303	"OVERLAY_RSTYLE").	607	"OVERLAY_RSTYLE").
…		…
322	If visible, hide the overlay, but do not destroy it.	626	If visible, hide the overlay, but do not destroy it.
323		627
324	$overlay->show	628	$overlay->show
325	If hidden, display the overlay again.	629	If hidden, display the overlay again.
326		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
327	$cellwidth = $term->strwidth $string	636	$cellwidth = $term->strwidth ($string)
328	Returns the number of screen-cells this string would need. Correctly	637	Returns the number of screen-cells this string would need. Correctly
329	accounts for wide and combining characters.	638	accounts for wide and combining characters.
330		639
331	$octets = $term->locale_encode $string	640	$octets = $term->locale_encode ($string)
332	Convert the given text string into the corresponding locale	641	Convert the given text string into the corresponding locale
333	encoding.	642	encoding.
334		643
335	$string = $term->locale_decode $octets	644	$string = $term->locale_decode ($octets)
336	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.
337		678
338	$term->tt_write ($octets)	679	$term->tt_write ($octets)
339	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).
340	To pass characters instead of octets, you should convert your	681	To pass characters instead of octets, you should convert your
341	strings first to the locale-specific encoding using	682	strings first to the locale-specific encoding using
342	"$term->locale_encode".	683	"$term->locale_encode".
343		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
344	$nrow = $term->nrow	708	$terminal_rows = $term->nrow
345	$ncol = $term->ncol	709	$terminal_columns = $term->ncol
346	Return the number of rows/columns of the terminal window (i.e. as	710	$has_focus = $term->focus
347	specified by "-geometry", excluding any scrollback).	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.
348		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
349	$nsaved = $term->nsaved	723	$env = $term->env
350	Returns the number of lines in the scrollback buffer.	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.
351		733
352	$view_start = $term->view_start ([$newvalue])	734	$view_start = $term->view_start ([$newvalue])
353	Returns the negative row number of the topmost line. Minimum value	735	Returns the row number of the topmost displayed line. Maximum value
354	is 0, which displays the normal terminal contents. Larger values	736	is 0, which displays the normal terminal contents. Lower values
355	scroll this many lines into the scrollback buffer.	737	scroll this many lines into the scrollback buffer.
356		738
357	$term->want_refresh	739	$term->want_refresh
358	Requests a screen refresh. At the next opportunity, rxvt-unicode	740	Requests a screen refresh. At the next opportunity, rxvt-unicode
359	will compare the on-screen display with its stored representation.	741	will compare the on-screen display with its stored representation.
…		…
409	$line = $term->line ($row_number)	791	$line = $term->line ($row_number)
410	Create and return a new "urxvt::line" object that stores information	792	Create and return a new "urxvt::line" object that stores information
411	about the logical line that row $row_number is part of. It supports	793	about the logical line that row $row_number is part of. It supports
412	the following methods:	794	the following methods:
413		795
414	$text = $line->t	796	$text = $line->t ([$new_text])
415	Returns the full text of the line, similar to "ROW_t"	797	Returns or replaces the full text of the line, similar to
		798	"ROW_t"
416		799
417	$rend = $line->r	800	$rend = $line->r ([$new_rend])
418	Returns the full rendition array of the line, similar to "ROW_r"	801	Returns or replaces the full rendition array of the line,
		802	similar to "ROW_r"
419		803
420	$length = $line->l	804	$length = $line->l
421	Returns the length of the line in cells, similar to "ROW_l".	805	Returns the length of the line in cells, similar to "ROW_l".
422		806
423	$rownum = $line->beg	807	$rownum = $line->beg
…		…
425	Return the row number of the first/last row of the line,	809	Return the row number of the first/last row of the line,
426	respectively.	810	respectively.
427		811
428	$offset = $line->offset_of ($row, $col)	812	$offset = $line->offset_of ($row, $col)
429	Returns the character offset of the given row\|col pair within	813	Returns the character offset of the given row\|col pair within
430	the logical line.	814	the logical line. Works for rows outside the line, too, and
		815	returns corresponding offsets outside the string.
431		816
432	($row, $col) = $line->coord_of ($offset)	817	($row, $col) = $line->coord_of ($offset)
433	Translates a string offset into terminal coordinates again.	818	Translates a string offset into terminal coordinates again.
434		819
435	($row, $col) = $line->coord_of ($offset) =item $text =
436	$term->special_encode $string	820	$text = $term->special_encode $string
437	Converts a perl string into the special encoding used by	821	Converts a perl string into the special encoding used by
438	rxvt-unicode, where one character corresponds to one screen cell.	822	rxvt-unicode, where one character corresponds to one screen cell.
439	See "$term->ROW_t" for details.	823	See "$term->ROW_t" for details.
440		824
441	$string = $term->special_decode $text	825	$string = $term->special_decode $text
442	Converts rxvt-unicodes text reprsentation into a perl string. See	826	Converts rxvt-unicodes text reprsentation into a perl string. See
443	"$term->ROW_t" for details.	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).
444		870
445	The "urxvt::timer" Class	871	The "urxvt::timer" Class
446	This class implements timer watchers/events. Time is represented as a	872	This class implements timer watchers/events. Time is represented as a
447	fractional number of seconds since the epoch. Example:	873	fractional number of seconds since the epoch. Example:
448		874
…		…
487		913
488	$term->{socket} = ...	914	$term->{socket} = ...
489	$term->{iow} = urxvt::iow	915	$term->{iow} = urxvt::iow
490	->new	916	->new
491	->fd (fileno $term->{socket})	917	->fd (fileno $term->{socket})
492	->events (1) # wait for read data	918	->events (urxvt::EVENT_READ)
493	->start	919	->start
494	->cb (sub {	920	->cb (sub {
495	my ($iow, $revents) = @_;	921	my ($iow, $revents) = @_;
496	# $revents must be 1 here, no need to check	922	# $revents must be 1 here, no need to check
497	sysread $term->{socket}, my $buf, 8192	923	sysread $term->{socket}, my $buf, 8192
…		…
507		933
508	$iow = $iow->fd ($fd)	934	$iow = $iow->fd ($fd)
509	Set the filedescriptor (not handle) to watch.	935	Set the filedescriptor (not handle) to watch.
510		936
511	$iow = $iow->events ($eventmask)	937	$iow = $iow->events ($eventmask)
512	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
513	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".
514		941
515	$iow = $iow->start	942	$iow = $iow->start
516	Start watching for requested events on the given handle.	943	Start watching for requested events on the given handle.
517		944
518	$iow = $iow->stop	945	$iow = $iow->stop
…		…
521	ENVIRONMENT	948	ENVIRONMENT
522	URXVT_PERL_VERBOSITY	949	URXVT_PERL_VERBOSITY
523	This variable controls the verbosity level of the perl extension. Higher	950	This variable controls the verbosity level of the perl extension. Higher
524	numbers indicate more verbose output.	951	numbers indicate more verbose output.
525		952
526	=0 - only fatal messages	953	== 0 - fatal messages
527	=3 - script loading and management	954	>= 3 - script loading and management
528	=10 - all events received	955	>=10 - all called hooks
		956	>=11 - hook reutrn values
529		957
530	AUTHOR	958	AUTHOR
531	Marc Lehmann <pcg@goof.com>	959	Marc Lehmann <pcg@goof.com>
532	http://software.schmorp.de/pkg/rxvt-unicode	960	http://software.schmorp.de/pkg/rxvt-unicode
533		961

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.10 by root, Wed Jan 4 05:35:34 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.10 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC