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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.19 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.33 by root, Fri Jan 20 22:49:34 2006 UTC

…		…
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	Or by adding them to the resource for extensions loaded by default:
		35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		37
34	selection (enabled by default)	38	selection (enabled by default)
35	(More) intelligent selection. This extension tries to be more	39	(More) intelligent selection. This extension tries to be more
36	intelligent when the user extends selections (double-click). Right	40	intelligent when the user extends selections (double-click and
37	now, it tries to select urls and complete shell-quoted arguments,	41	further clicks). Right now, it tries to select words, urls and
38	which is very convenient, too, if your ls supports	42	complete shell-quoted arguments, which is very convenient, too, if
39	"--quoting-style=shell".	43	your ls supports "--quoting-style=shell".
40		44
		45	A double-click usually selects the word under the cursor, further
		46	clicks will enlarge the selection.
		47
		48	The selection works by trying to match a number of regexes and
		49	displaying them in increasing order of length. You can add your own
		50	regexes by specifying resources of the form:
		51
		52	URxvt.selection.pattern-0: perl-regex
		53	URxvt.selection.pattern-1: perl-regex
		54	...
		55
		56	The index number (0, 1...) must not have any holes, and each regex
		57	must contain at least one pair of capturing parentheses, which will
		58	be used for the match. For example, the followign adds a regex that
		59	matches everything between two vertical bars:
		60
		61	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		62
		63	You can look at the source of the selection extension to see more
		64	interesting uses, such as parsing a line from beginning to end.
		65
41	It also offers the following bindable keyboard command:	66	This extension also offers following bindable keyboard commands:
42		67
43	rot13	68	rot13
44	Rot-13 the selection when activated. Used via keyboard trigger:	69	Rot-13 the selection when activated. Used via keyboard trigger:
45		70
46	URxvt.keysym.C-M-r: perl:selection:rot13	71	URxvt.keysym.C-M-r: perl:selection:rot13
…		…
50	options at runtime.	75	options at runtime.
51		76
52	selection-popup (enabled by default)	77	selection-popup (enabled by default)
53	Binds a popup menu to Ctrl-Button3 that lets you convert the	78	Binds a popup menu to Ctrl-Button3 that lets you convert the
54	selection text into various other formats/action (such as uri	79	selection text into various other formats/action (such as uri
55	unescaping, perl evalution, web-browser starting etc.), depending on	80	unescaping, perl evaluation, web-browser starting etc.), depending
56	content.	81	on content.
		82
		83	Other extensions can extend this popup menu by pushing a code
		84	reference onto "@{ $term-"{selection_popup_hook} }>, that is called
		85	whenever the popup is displayed.
		86
		87	It's sole argument is the popup menu, which can be modified. The
		88	selection is in $_, which can be used to decide wether to add
		89	something or not. It should either return nothing or a string and a
		90	code reference. The string will be used as button text and the code
		91	reference will be called when the button gets activated and should
		92	transform $_.
		93
		94	The following will add an entry "a to b" that transforms all "a"s in
		95	the selection to "b"s, but only if the selection currently contains
		96	any "a"s:
		97
		98	push @{ $self->{term}{selection_popup_hook} }, sub {
		99	/a/ ? ("a to be" => sub { s/a/b/g }
		100	: ()
		101	};
57		102
58	searchable-scrollback<hotkey> (enabled by default)	103	searchable-scrollback<hotkey> (enabled by default)
59	Adds regex search functionality to the scrollback buffer, triggered	104	Adds regex search functionality to the scrollback buffer, triggered
60	by a hotkey (default: "M-s"). When in search mode, normal terminal	105	by a hotkey (default: "M-s"). While in search mode, normal terminal
61	input/output is suspended.	106	input/output is suspended and a regex is displayed at the bottom of
		107	the screen.
62		108
63	"/" starts an incremental regex search, "n" searches further, "p" or	109	Inputting characters appends them to the regex and continues
64	"N" jump to the previous match, "G" jumps to the bottom and clears	110	incremental search. "BackSpace" removes a character from the regex,
65	the history, "enter" leaves search mode at the current position and	111	"Up" and "Down" search upwards/downwards in the scrollback buffer,
66	"escape" returns to the original position.	112	"End" jumps to the bottom. "Escape" leaves search mode and returns
		113	to the point where search was started, while "Enter" or "Return"
		114	stay at the current position and additionally stores the first match
		115	in the current line into the primary selection.
67		116
68	digital-clock	117	selection-autotransform
69	Displays a digital clock using the built-in overlay.	118	This selection allows you to do automatic transforms on a selection
		119	whenever a selection is made.
		120
		121	It works by specifying perl snippets (most useful is a single "s///"
		122	operator) that modify $_ as resources:
		123
		124	URxvt.selection-autotransform.0: transform
		125	URxvt.selection-autotransform.1: transform
		126	...
		127
		128	For example, the following will transform selections of the form
		129	"filename:number", often seen in compiler messages, into "vi
		130	+$filename $word":
		131
		132	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		133
		134	And this example matches the same,but replaces it with vi-commands
		135	you can paste directly into your (vi :) editor:
		136
		137	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		138
		139	Of course, this can be modified to suit your needs and your editor
		140	:)
		141
		142	To expand the example above to typical perl error messages ("XXX at
		143	FILENAME line YYY."), you need a slightly more elaborate solution:
		144
		145	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		146	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		147
		148	The first line tells the selection code to treat the unchanging part
		149	of every error message as a selection pattern, and the second line
		150	transforms the message into vi commands to load the file.
		151
		152	readline
		153	A support package that tries to make editing with readline easier.
		154	At the moment, it reacts to clicking with the left mouse button by
		155	trying to move the text cursor to this position. It does so by
		156	generating as many cursor-left or cursor-right keypresses as
		157	required (the this only works for programs that correctly support
		158	wide characters).
		159
		160	It only works when clicking into the same line (possibly extended
		161	over multiple rows) as the text cursor and on the primary screen, to
		162	reduce the risk of misinterpreting. The normal selection isn't
		163	disabled, so quick successive clicks might interfere with selection
		164	creation in harmless ways.
		165
		166	tabbed
		167	This transforms the terminal into a tabbar with additional
		168	terminals, that is, it implements what is commonly refered to as
		169	"tabbed terminal". The topmost line displays a "[NEW]" button,
		170	which, when clicked, will add a new tab, followed by one button per
		171	tab.
		172
		173	Clicking a button will activate that tab. Pressing Shift-Left and
		174	Shift-Right will switch to the tab left or right of the current one,
		175	while Shift-Down creates a new tab.
70		176
71	mark-urls	177	mark-urls
72	Uses per-line display filtering ("on_line_update") to underline	178	Uses per-line display filtering ("on_line_update") to underline urls
73	urls.	179	and make them clickable. When middle-clicked, the program specified
		180	in the resource "urlLauncher" (default "x-www-browser") will be
		181	started with the URL as first argument.
		182
		183	automove-background
		184	This is basically a one-line extension that dynamically changes the
		185	background pixmap offset to the window position, in effect creating
		186	the same effect as pseudo transparency with a custom pixmap. No
		187	scaling is supported in this mode. Exmaple:
		188
		189	rxvt -pixmap background.xpm -pe automove-background
74		190
75	block-graphics-to-ascii	191	block-graphics-to-ascii
76	A not very useful example of filtering all text output to the	192	A not very useful example of filtering all text output to the
77	terminal, by replacing all line-drawing characters (U+2500 ..	193	terminal, by replacing all line-drawing characters (U+2500 ..
78	U+259F) by a similar-looking ascii character.	194	U+259F) by a similar-looking ascii character.
79		195
		196	digital-clock
		197	Displays a digital clock using the built-in overlay.
		198
80	example-refresh-hooks	199	example-refresh-hooks
81	Displays a very simple digital clock in the upper right corner of	200	Displays a very simple digital clock in the upper right corner of
82	the window. Illustrates overwriting the refresh callbacks to create	201	the window. Illustrates overwriting the refresh callbacks to create
83	your own overlays or changes.	202	your own overlays or changes.
		203
		204	selection-pastebin
		205	This is a little rarely useful extension that Uploads the selection
		206	as textfile to a remote site (or does other things). (The
		207	implementation is not currently secure for use in a multiuser
		208	environment as it writes to /tmp directly.).
		209
		210	It listens to the "selection-pastebin:remote-pastebin" keyboard
		211	command, i.e.
		212
		213	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		214
		215	Pressing this combination runs a command with "%" replaced by the
		216	name of the textfile. This command can be set via a resource:
		217
		218	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		219
		220	And the default is likely not useful to anybody but the few people
		221	around here :)
		222
		223	The name of the textfile is the hex encoded md5 sum of the
		224	selection, so the same content should lead to the same filename.
		225
		226	After a successful upload the selection will be replaced by the text
		227	given in the "selection-pastebin-url" resource (again, the % is the
		228	placeholder for the filename):
		229
		230	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
84		231
85	API DOCUMENTATION	232	API DOCUMENTATION
86	General API Considerations	233	General API Considerations
87	All objects (such as terminals, time watchers etc.) are typical	234	All objects (such as terminals, time watchers etc.) are typical
88	reference-to-hash objects. The hash can be used to store anything you	235	reference-to-hash objects. The hash can be used to store anything you
…		…
98	Argument names also often indicate the type of a parameter. Here are	245	Argument names also often indicate the type of a parameter. Here are
99	some hints on what they mean:	246	some hints on what they mean:
100		247
101	$text	248	$text
102	Rxvt-unicodes special way of encoding text, where one "unicode"	249	Rxvt-unicodes special way of encoding text, where one "unicode"
103	character always represents one screen cell. See row_t for a	250	character always represents one screen cell. See ROW_t for a
104	discussion of this format.	251	discussion of this format.
105		252
106	$string	253	$string
107	A perl text string, with an emphasis on text. It can store all	254	A perl text string, with an emphasis on text. It can store all
108	unicode characters and is to be distinguished with text encoded in a	255	unicode characters and is to be distinguished with text encoded in a
…		…
142	be called whenever the relevant event happens.	289	be called whenever the relevant event happens.
143		290
144	The first argument passed to them is an extension oject as described in	291	The first argument passed to them is an extension oject as described in
145	the in the "Extension Objects" section.	292	the in the "Extension Objects" section.
146		293
147	All of these hooks must return a boolean value. If it is true, then the	294	All of these hooks must return a boolean value. If any of the called
148	event counts as being consumed, and the invocation of other hooks is	295	hooks returns true, then the event counts as being consumed, and the
149	skipped, and the relevant action might not be carried out by the C++	296	relevant action might not be carried out by the C++ code.
150	code.
151		297
152	When in doubt, return a false value (preferably "()").	298	When in doubt, return a false value (preferably "()").
153		299
154	on_init $term	300	on_init $term
155	Called after a new terminal object has been initialized, but before	301	Called after a new terminal object has been initialized, but before
156	windows are created or the command gets run. Most methods are unsafe	302	windows are created or the command gets run. Most methods are unsafe
157	to call or deliver senseless data, as terminal size and other	303	to call or deliver senseless data, as terminal size and other
158	characteristics have not yet been determined. You can safely query	304	characteristics have not yet been determined. You can safely query
159	and change resources, though.	305	and change resources and options, though. For many purposes the
		306	"on_start" hook is a better place.
		307
		308	on_start $term
		309	Called at the very end of initialisation of a new terminal, just
		310	before trying to map (display) the toplevel and returning to the
		311	mainloop.
		312
		313	on_destroy $term
		314	Called whenever something tries to destroy terminal, before doing
		315	anything yet. If this hook returns true, then destruction is
		316	skipped, but this is rarely a good idea.
160		317
161	on_reset $term	318	on_reset $term
162	Called after the screen is "reset" for any reason, such as resizing	319	Called after the screen is "reset" for any reason, such as resizing
163	or control sequences. Here is where you can react on changes to	320	or control sequences. Here is where you can react on changes to
164	size-related variables.	321	size-related variables.
165		322
166	on_start $term	323	on_child_start $term, $pid
167	Called at the very end of initialisation of a new terminal, just	324	Called just after the child process has been "fork"ed.
168	before returning to the mainloop.	325
		326	on_child_exit $term, $status
		327	Called just after the child process has exited. $status is the
		328	status from "waitpid".
169		329
170	on_sel_make $term, $eventtime	330	on_sel_make $term, $eventtime
171	Called whenever a selection has been made by the user, but before	331	Called whenever a selection has been made by the user, but before
172	the selection text is copied, so changes to the beginning, end or	332	the selection text is copied, so changes to the beginning, end or
173	type of the selection will be honored.	333	type of the selection will be honored.
…		…
186		346
187	on_sel_extend $term	347	on_sel_extend $term
188	Called whenever the user tries to extend the selection (e.g. with a	348	Called whenever the user tries to extend the selection (e.g. with a
189	double click) and is either supposed to return false (normal	349	double click) and is either supposed to return false (normal
190	operation), or should extend the selection itelf and return true to	350	operation), or should extend the selection itelf and return true to
191	suppress the built-in processing.	351	suppress the built-in processing. This can happen multiple times, as
		352	long as the callback returns true, it will be called on every
		353	further click by the user and is supposed to enlarge the selection
		354	more and more, if possible.
192		355
193	See the selection example extension.	356	See the selection example extension.
194		357
195	on_view_change $term, $offset	358	on_view_change $term, $offset
196	Called whenever the view offset changes, i..e the user or program	359	Called whenever the view offset changes, i..e the user or program
…		…
255	on_keyboard_command $term, $string	418	on_keyboard_command $term, $string
256	Called whenever the user presses a key combination that has a	419	Called whenever the user presses a key combination that has a
257	"perl:string" action bound to it (see description of the keysym	420	"perl:string" action bound to it (see description of the keysym
258	resource in the rxvt(1) manpage).	421	resource in the rxvt(1) manpage).
259		422
		423	on_x_event $term, $event
		424	Called on every X event received on the vt window (and possibly
		425	other windows). Should only be used as a last resort. Most event
		426	structure members are not passed.
		427
260	on_focus_in $term	428	on_focus_in $term
261	Called whenever the window gets the keyboard focus, before	429	Called whenever the window gets the keyboard focus, before
262	rxvt-unicode does focus in processing.	430	rxvt-unicode does focus in processing.
263		431
264	on_focus_out $term	432	on_focus_out $term
265	Called wheneever the window loses keyboard focus, before	433	Called wheneever the window loses keyboard focus, before
266	rxvt-unicode does focus out processing.	434	rxvt-unicode does focus out processing.
267		435
		436	on_configure_notify $term, $event
		437	on_property_notify $term, $event
268	on_key_press $term, $event, $keysym, $octets	438	on_key_press $term, $event, $keysym, $octets
269	on_key_release $term, $event, $keysym	439	on_key_release $term, $event, $keysym
270	on_button_press $term, $event	440	on_button_press $term, $event
271	on_button_release $term, $event	441	on_button_release $term, $event
272	on_motion_notify $term, $event	442	on_motion_notify $term, $event
…		…
276	terminal If the hook returns true, then the even will be ignored by	446	terminal If the hook returns true, then the even will be ignored by
277	rxvt-unicode.	447	rxvt-unicode.
278		448
279	The event is a hash with most values as named by Xlib (see the	449	The event is a hash with most values as named by Xlib (see the
280	XEvent manpage), with the additional members "row" and "col", which	450	XEvent manpage), with the additional members "row" and "col", which
281	are the row and column under the mouse cursor.	451	are the (real, not screen-based) row and column under the mouse
		452	cursor.
282		453
283	"on_key_press" additionally receives the string rxvt-unicode would	454	"on_key_press" additionally receives the string rxvt-unicode would
284	output, if any, in locale-specific encoding.	455	output, if any, in locale-specific encoding.
285		456
286	subwindow.	457	subwindow.
		458
		459	on_client_message $term, $event
		460	on_wm_protocols $term, $event
		461	on_wm_delete_window $term, $event
		462	Called when various types of ClientMessage events are received (all
		463	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
287		464
288	Variables in the "urxvt" Package	465	Variables in the "urxvt" Package
289	$urxvt::LIBDIR	466	$urxvt::LIBDIR
290	The rxvt-unicode library directory, where, among other things, the	467	The rxvt-unicode library directory, where, among other things, the
291	perl modules and scripts are stored.	468	perl modules and scripts are stored.
…		…
299		476
300	$urxvt::TERM	477	$urxvt::TERM
301	The current terminal. This variable stores the current "urxvt::term"	478	The current terminal. This variable stores the current "urxvt::term"
302	object, whenever a callback/hook is executing.	479	object, whenever a callback/hook is executing.
303		480
304	*	481	@urxvt::TERM_INIT
		482	All coderefs in this array will be called as methods of the next
		483	newly created "urxvt::term" object (during the "on_init" phase). The
		484	array gets cleared before the codereferences that were in it are
		485	being executed, so coderefs can push themselves onto it again if
		486	they so desire.
		487
		488	This complements to the perl-eval commandline option, but gets
		489	executed first.
		490
		491	@urxvt::TERM_EXT
		492	Works similar to @TERM_INIT, but contains perl package/class names,
		493	which get registered as normal extensions after calling the hooks in
		494	@TERM_INIT but before other extensions. Gets cleared just like
		495	@TERM_INIT.
305		496
306	Functions in the "urxvt" Package	497	Functions in the "urxvt" Package
307	$term = new urxvt [arg...]
308	Creates a new terminal, very similar as if you had started it with
309	"system $binfile, arg...". Croaks (and probably outputs an error
310	message) if the new instance couldn't be created. Returns "undef" if
311	the new instance didn't initialise perl, and the terminal object
312	otherwise. The "init" and "start" hooks will be called during the
313	call.
314
315	urxvt::fatal $errormessage	498	urxvt::fatal $errormessage
316	Fatally aborts execution with the given error message. Avoid at all	499	Fatally aborts execution with the given error message. Avoid at all
317	costs! The only time this is acceptable is when the terminal process	500	costs! The only time this is acceptable is when the terminal process
318	starts up.	501	starts up.
319		502
…		…
323	function that calls this function.	506	function that calls this function.
324		507
325	Using this function has the advantage that its output ends up in the	508	Using this function has the advantage that its output ends up in the
326	correct place, e.g. on stderr of the connecting urxvtc client.	509	correct place, e.g. on stderr of the connecting urxvtc client.
327		510
328	$is_safe = urxvt::safe	511	Messages have a size limit of 1023 bytes currently.
329	Returns true when it is safe to do potentially unsafe things, such
330	as evaluating perl code specified by the user. This is true when
331	urxvt was started setuid or setgid.
332		512
333	$time = urxvt::NOW	513	$time = urxvt::NOW
334	Returns the "current time" (as per the event loop).	514	Returns the "current time" (as per the event loop).
335		515
336	urxvt::CurrentTime	516	urxvt::CurrentTime
337	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	517	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
338	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	518	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
339	Button5Mask, AnyModifier	519	Button5Mask, AnyModifier
		520	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		521	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		522	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		523	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		524	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		525	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		526	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		527	ColormapChangeMask, OwnerGrabButtonMask
		528	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		529	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		530	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		531	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		532	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		533	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		534	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
340	Various constants for use in X calls and event processing.	535	Various constants for use in X calls and event processing.
341		536
342	RENDITION	537	RENDITION
343	Rendition bitsets contain information about colour, font, font styles	538	Rendition bitsets contain information about colour, font, font styles
344	and similar information for each screen cell.	539	and similar information for each screen cell.
…		…
385	condition variables, but non-blocking condvar use is ok. What this means	580	condition variables, but non-blocking condvar use is ok. What this means
386	is that you cannot use blocking APIs, but the non-blocking variant	581	is that you cannot use blocking APIs, but the non-blocking variant
387	should work.	582	should work.
388		583
389	The "urxvt::term" Class	584	The "urxvt::term" Class
		585	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		586	Creates a new terminal, very similar as if you had started it with
		587	system "$rxvtname, arg...". $envhashref must be a reference to a
		588	%ENV-like hash which defines the environment of the new terminal.
		589
		590	Croaks (and probably outputs an error message) if the new instance
		591	couldn't be created. Returns "undef" if the new instance didn't
		592	initialise perl, and the terminal object otherwise. The "init" and
		593	"start" hooks will be called during this call.
		594
390	$term->destroy	595	$term->destroy
391	Destroy the terminal object (close the window, free resources etc.).	596	Destroy the terminal object (close the window, free resources etc.).
392	Please note that rxvt will not exit as long as any event watchers	597	Please note that rxvt will not exit as long as any event watchers
393	(timers, io watchers) are still active.	598	(timers, io watchers) are still active.
		599
		600	$term->exec_async ($cmd[, @args])
		601	Works like the combination of the "fork"/"exec" builtins, which
		602	executes ("starts") programs in the background. This function takes
		603	care of setting the user environment before exec'ing the command
		604	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		605	or "system".
		606
		607	Returns the pid of the subprocess or "undef" on error.
394		608
395	$isset = $term->option ($optval[, $set])	609	$isset = $term->option ($optval[, $set])
396	Returns true if the option specified by $optval is enabled, and	610	Returns true if the option specified by $optval is enabled, and
397	optionally change it. All option values are stored by name in the	611	optionally change it. All option values are stored by name in the
398	hash %urxvt::OPTION. Options not enabled in this binary are not in	612	hash %urxvt::OPTION. Options not enabled in this binary are not in
…		…
401	Here is a a likely non-exhaustive list of option names, please see	615	Here is a a likely non-exhaustive list of option names, please see
402	the source file /src/optinc.h to see the actual list:	616	the source file /src/optinc.h to see the actual list:
403		617
404	borderLess console cursorBlink cursorUnderline hold iconic insecure	618	borderLess console cursorBlink cursorUnderline hold iconic insecure
405	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	619	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
406	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	620	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
407	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	621	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
408	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	622	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
409	tripleclickwords utmpInhibit visualBell	623	transparent tripleclickwords utmpInhibit visualBell
410		624
411	$value = $term->resource ($name[, $newval])	625	$value = $term->resource ($name[, $newval])
412	Returns the current resource value associated with a given name and	626	Returns the current resource value associated with a given name and
413	optionally sets a new value. Setting values is most useful in the	627	optionally sets a new value. Setting values is most useful in the
414	"init" hook. Unset resources are returned and accepted as "undef".	628	"init" hook. Unset resources are returned and accepted as "undef".
…		…
431		645
432	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	646	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
433	borderLess color cursorBlink cursorUnderline cutchars delete_key	647	borderLess color cursorBlink cursorUnderline cutchars delete_key
434	display_name embed ext_bwidth fade font geometry hold iconName	648	display_name embed ext_bwidth fade font geometry hold iconName
435	imFont imLocale inputMethod insecure int_bwidth intensityStyles	649	imFont imLocale inputMethod insecure int_bwidth intensityStyles
436	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	650	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
437	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	651	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
438	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	652	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
439	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	653	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
440	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	654	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
441	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	655	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		656	secondaryScreen secondaryScroll selectstyle shade term_name title
442	shade term_name title transparent transparent_all tripleclickwords	657	transient_for transparent transparent_all tripleclickwords utmpInhibit
443	utmpInhibit visualBell	658	visualBell
		659
		660	$value = $term->x_resource ($pattern)
		661	Returns the X-Resource for the given pattern, excluding the program
		662	or class name, i.e. "$term->x_resource ("boldFont")" should return
		663	the same value as used by this instance of rxvt-unicode. Returns
		664	"undef" if no resource with that pattern exists.
		665
		666	This method should only be called during the "on_start" hook, as
		667	there is only one resource database per display, and later
		668	invocations might return the wrong resources.
444		669
445	$success = $term->parse_keysym ($keysym_spec, $command_string)	670	$success = $term->parse_keysym ($keysym_spec, $command_string)
446	Adds a keymap translation exactly as specified via a resource. See	671	Adds a keymap translation exactly as specified via a resource. See
447	the "keysym" resource in the rxvt(1) manpage.	672	the "keysym" resource in the rxvt(1) manpage.
448		673
…		…
459	($row, $col) = $term->selection_beg ([$row, $col])	684	($row, $col) = $term->selection_beg ([$row, $col])
460	($row, $col) = $term->selection_end ([$row, $col])	685	($row, $col) = $term->selection_end ([$row, $col])
461	Return the current values of the selection mark, begin or end	686	Return the current values of the selection mark, begin or end
462	positions, and optionally set them to new values.	687	positions, and optionally set them to new values.
463		688
		689	$term->selection_make ($eventtime[, $rectangular])
		690	Tries to make a selection as set by "selection_beg" and
		691	"selection_end". If $rectangular is true (default: false), a
		692	rectangular selection will be made. This is the prefered function to
		693	make a selection.
		694
464	$success = $term->selection_grab ($eventtime)	695	$success = $term->selection_grab ($eventtime)
465	Try to request the primary selection from the server (for example,	696	Try to request the primary selection text from the server (for
466	as set by the next method).	697	example, as set by the next method). No visual feedback will be
		698	given. This function is mostly useful from within "on_sel_grab"
		699	hooks.
467		700
468	$oldtext = $term->selection ([$newtext])	701	$oldtext = $term->selection ([$newtext])
469	Return the current selection text and optionally replace it by	702	Return the current selection text and optionally replace it by
470	$newtext.	703	$newtext.
471		704
…		…
516	$string = $term->locale_decode ($octets)	749	$string = $term->locale_decode ($octets)
517	Convert the given locale-encoded octets into a perl string.	750	Convert the given locale-encoded octets into a perl string.
518		751
519	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	752	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
520	XORs the rendition values in the given span with the provided value	753	XORs the rendition values in the given span with the provided value
521	(default: "RS_RVid"). Useful in refresh hooks to provide effects	754	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
522	similar to the selection.	755	in refresh hooks to provide effects similar to the selection.
523		756
524	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,	757	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
525	$rstyle2]])	758	$rstyle2]])
526	Similar to "scr_xor_span", but xors a rectangle instead. Trailing	759	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
527	whitespace will additionally be xored with the $rstyle2, which	760	whitespace will additionally be xored with the $rstyle2, which
528	defaults to "RS_RVid \| RS_Uline", which removes reverse video again	761	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
529	and underlines it instead.	762	and underlines it instead. Both styles MUST NOT contain font
		763	styles.
530		764
531	$term->scr_bell	765	$term->scr_bell
532	Ring the bell!	766	Ring the bell!
533		767
534	$term->scr_add_lines ($string)	768	$term->scr_add_lines ($string)
…		…
540		774
541	Normally its not a good idea to use this function, as programs might	775	Normally its not a good idea to use this function, as programs might
542	be confused by changes in cursor position or scrolling. Its useful	776	be confused by changes in cursor position or scrolling. Its useful
543	inside a "on_add_lines" hook, though.	777	inside a "on_add_lines" hook, though.
544		778
		779	$term->scr_change_screen ($screen)
		780	Switch to given screen - 0 primary, 1 secondary.
		781
545	$term->cmd_parse ($octets)	782	$term->cmd_parse ($octets)
546	Similar to "scr_add_lines", but the argument must be in the	783	Similar to "scr_add_lines", but the argument must be in the
547	locale-specific encoding of the terminal and can contain command	784	locale-specific encoding of the terminal and can contain command
548	sequences (escape codes) that will be interpreted.	785	sequences (escape codes) that will be interpreted.
549		786
…		…
562	$windowid = $term->parent	799	$windowid = $term->parent
563	Return the window id of the toplevel window.	800	Return the window id of the toplevel window.
564		801
565	$windowid = $term->vt	802	$windowid = $term->vt
566	Return the window id of the terminal window.	803	Return the window id of the terminal window.
		804
		805	$term->vt_emask_add ($x_event_mask)
		806	Adds the specified events to the vt event mask. Useful e.g. when you
		807	want to receive pointer events all the times:
		808
		809	$term->vt_emask_add (urxvt::PointerMotionMask);
567		810
568	$window_width = $term->width	811	$window_width = $term->width
569	$window_height = $term->height	812	$window_height = $term->height
570	$font_width = $term->fwidth	813	$font_width = $term->fwidth
571	$font_height = $term->fheight	814	$font_height = $term->fheight
…		…
574	$terminal_columns = $term->ncol	817	$terminal_columns = $term->ncol
575	$has_focus = $term->focus	818	$has_focus = $term->focus
576	$is_mapped = $term->mapped	819	$is_mapped = $term->mapped
577	$max_scrollback = $term->saveLines	820	$max_scrollback = $term->saveLines
578	$nrow_plus_saveLines = $term->total_rows	821	$nrow_plus_saveLines = $term->total_rows
579	$lines_in_scrollback = $term->nsaved	822	$topmost_scrollback_row = $term->top_row
580	Return various integers describing terminal characteristics.	823	Return various integers describing terminal characteristics.
		824
		825	$x_display = $term->display_id
		826	Return the DISPLAY used by rxvt-unicode.
581		827
582	$lc_ctype = $term->locale	828	$lc_ctype = $term->locale
583	Returns the LC_CTYPE category string used by this rxvt-unicode.	829	Returns the LC_CTYPE category string used by this rxvt-unicode.
584		830
585	$x_display = $term->display_id	831	$env = $term->env
586	Return the DISPLAY used by rxvt-unicode.	832	Returns a copy of the environment in effect for the terminal as a
		833	hashref similar to "\%ENV".
587		834
588	$modifiermask = $term->ModLevel3Mask	835	$modifiermask = $term->ModLevel3Mask
589	$modifiermask = $term->ModMetaMask	836	$modifiermask = $term->ModMetaMask
590	$modifiermask = $term->ModNumLockMask	837	$modifiermask = $term->ModNumLockMask
591	Return the modifier masks corresponding to the "ISO Level 3 Shift"	838	Return the modifier masks corresponding to the "ISO Level 3 Shift"
592	(often AltGr), the meta key (often Alt) and the num lock key, if	839	(often AltGr), the meta key (often Alt) and the num lock key, if
593	applicable.	840	applicable.
594		841
		842	$screen = $term->current_screen
		843	Returns the currently displayed screen (0 primary, 1 secondary).
		844
595	$view_start = $term->view_start ([$newvalue])	845	$view_start = $term->view_start ([$newvalue])
596	Returns the negative row number of the topmost line. Minimum value	846	Returns the row number of the topmost displayed line. Maximum value
597	is 0, which displays the normal terminal contents. Larger values	847	is 0, which displays the normal terminal contents. Lower values
598	scroll this many lines into the scrollback buffer.	848	scroll this many lines into the scrollback buffer.
599		849
600	$term->want_refresh	850	$term->want_refresh
601	Requests a screen refresh. At the next opportunity, rxvt-unicode	851	Requests a screen refresh. At the next opportunity, rxvt-unicode
602	will compare the on-screen display with its stored representation.	852	will compare the on-screen display with its stored representation.
…		…
615	line, starting at column $start_col (default 0), which is useful to	865	line, starting at column $start_col (default 0), which is useful to
616	replace only parts of a line. The font index in the rendition will	866	replace only parts of a line. The font index in the rendition will
617	automatically be updated.	867	automatically be updated.
618		868
619	$text is in a special encoding: tabs and wide characters that use	869	$text is in a special encoding: tabs and wide characters that use
620	more than one cell when displayed are padded with urxvt::NOCHAR	870	more than one cell when displayed are padded with $urxvt::NOCHAR
621	characters ("chr 65535"). Characters with combining characters and	871	characters. Characters with combining characters and other
622	other characters that do not fit into the normal tetx encoding will	872	characters that do not fit into the normal tetx encoding will be
623	be replaced with characters in the private use area.	873	replaced with characters in the private use area.
624		874
625	You have to obey this encoding when changing text. The advantage is	875	You have to obey this encoding when changing text. The advantage is
626	that "substr" and similar functions work on screen cells and not on	876	that "substr" and similar functions work on screen cells and not on
627	characters.	877	characters.
628		878
…		…
670	Return the row number of the first/last row of the line,	920	Return the row number of the first/last row of the line,
671	respectively.	921	respectively.
672		922
673	$offset = $line->offset_of ($row, $col)	923	$offset = $line->offset_of ($row, $col)
674	Returns the character offset of the given row\|col pair within	924	Returns the character offset of the given row\|col pair within
675	the logical line.	925	the logical line. Works for rows outside the line, too, and
		926	returns corresponding offsets outside the string.
676		927
677	($row, $col) = $line->coord_of ($offset)	928	($row, $col) = $line->coord_of ($offset)
678	Translates a string offset into terminal coordinates again.	929	Translates a string offset into terminal coordinates again.
679		930
680	$text = $term->special_encode $string	931	$text = $term->special_encode $string
…		…
706	$term->ungrab	957	$term->ungrab
707	Calls XUngrab for the most recent grab. Is called automatically on	958	Calls XUngrab for the most recent grab. Is called automatically on
708	evaluation errors, as it is better to lose the grab in the error	959	evaluation errors, as it is better to lose the grab in the error
709	case as the session.	960	case as the session.
710		961
		962	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		963	$atom_name = $term->XGetAtomName ($atom)
		964	@atoms = $term->XListProperties ($window)
		965	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		966	$term->XChangeWindowProperty ($window, $property, $type, $format,
		967	$octets)
		968	$term->XDeleteProperty ($window, $property)
		969	$window = $term->DefaultRootWindow
		970	$term->XReparentWindow ($window, $parent, [$x, $y])
		971	$term->XMapWindow ($window)
		972	$term->XUnmapWindow ($window)
		973	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		974	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		975	$y)
		976	$term->XChangeInput ($window, $add_events[, $del_events])
		977	Various X or X-related functions. The $term object only serves as
		978	the source of the display, otherwise those functions map
		979	more-or-less directory onto the X functions of the same name.
		980
711	The "urxvt::popup" Class	981	The "urxvt::popup" Class
712	$popup->add_title ($title)	982	$popup->add_title ($title)
713	Adds a non-clickable title to the popup.	983	Adds a non-clickable title to the popup.
714		984
715	$popup->add_separator ([$sepchr])	985	$popup->add_separator ([$sepchr])
…		…
727		997
728	$popup->show	998	$popup->show
729	Displays the popup (which is initially hidden).	999	Displays the popup (which is initially hidden).
730		1000
731	The "urxvt::timer" Class	1001	The "urxvt::timer" Class
732	This class implements timer watchers/events. Time is represented as	1002	This class implements timer watchers/events. Time is represented as a
733	a fractional number of seconds since the epoch. Example:	1003	fractional number of seconds since the epoch. Example:
734		1004
735	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);	1005	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
736	$term->{timer} = urxvt::timer	1006	$term->{timer} = urxvt::timer
737	->new	1007	->new
738	->interval (1)	1008	->interval (1)
739	->cb (sub {	1009	->cb (sub {
740	$term->{overlay}->set (0, 0,	1010	$term->{overlay}->set (0, 0,
741	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1011	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
742	});	1012	});
743		1013
744	$timer = new urxvt::timer	1014	$timer = new urxvt::timer
745	Create a new timer object in started state. It is scheduled to	1015	Create a new timer object in started state. It is scheduled to fire
746	fire immediately.	1016	immediately.
747		1017
748	$timer = $timer->cb (sub { my ($timer) = @_; ... })	1018	$timer = $timer->cb (sub { my ($timer) = @_; ... })
749	Set the callback to be called when the timer triggers.	1019	Set the callback to be called when the timer triggers.
750		1020
751	$tstamp = $timer->at	1021	$tstamp = $timer->at
752	Return the time this watcher will fire next.	1022	Return the time this watcher will fire next.
753		1023
754	$timer = $timer->set ($tstamp)	1024	$timer = $timer->set ($tstamp)
755	Set the time the event is generated to $tstamp.	1025	Set the time the event is generated to $tstamp.
756		1026
757	$timer = $timer->interval ($interval)	1027	$timer = $timer->interval ($interval)
758	Normally (and when $interval is 0), the timer will automatically	1028	Normally (and when $interval is 0), the timer will automatically
759	stop after it has fired once. If $interval is non-zero, then the	1029	stop after it has fired once. If $interval is non-zero, then the
760	timer is automatically rescheduled at the given intervals.	1030	timer is automatically rescheduled at the given intervals.
761		1031
762	$timer = $timer->start	1032	$timer = $timer->start
763	Start the timer.	1033	Start the timer.
764		1034
765	$timer = $timer->start ($tstamp)	1035	$timer = $timer->start ($tstamp)
766	Set the event trigger time to $tstamp and start the timer.	1036	Set the event trigger time to $tstamp and start the timer.
767		1037
		1038	$timer = $timer->after ($delay)
		1039	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
		1040
768	$timer = $timer->stop	1041	$timer = $timer->stop
769	Stop the timer.	1042	Stop the timer.
770		1043
771	The "urxvt::iow" Class	1044	The "urxvt::iow" Class
772	This class implements io watchers/events. Example:	1045	This class implements io watchers/events. Example:
773		1046
774	$term->{socket} = ...	1047	$term->{socket} = ...
775	$term->{iow} = urxvt::iow	1048	$term->{iow} = urxvt::iow
		1049	->new
		1050	->fd (fileno $term->{socket})
		1051	->events (urxvt::EVENT_READ)
		1052	->start
		1053	->cb (sub {
		1054	my ($iow, $revents) = @_;
		1055	# $revents must be 1 here, no need to check
		1056	sysread $term->{socket}, my $buf, 8192
		1057	or end-of-file;
		1058	});
		1059
		1060	$iow = new urxvt::iow
		1061	Create a new io watcher object in stopped state.
		1062
		1063	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
		1064	Set the callback to be called when io events are triggered.
		1065	$reventmask is a bitset as described in the "events" method.
		1066
		1067	$iow = $iow->fd ($fd)
		1068	Set the filedescriptor (not handle) to watch.
		1069
		1070	$iow = $iow->events ($eventmask)
		1071	Set the event mask to watch. The only allowed values are
		1072	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1073	together, or "urxvt::EVENT_NONE".
		1074
		1075	$iow = $iow->start
		1076	Start watching for requested events on the given handle.
		1077
		1078	$iow = $iow->stop
		1079	Stop watching for events on the given filehandle.
		1080
		1081	The "urxvt::iw" Class
		1082	This class implements idle watchers, that get called automatically when
		1083	the process is idle. They should return as fast as possible, after doing
		1084	some useful work.
		1085
		1086	$iw = new urxvt::iw
		1087	Create a new idle watcher object in stopped state.
		1088
		1089	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1090	Set the callback to be called when the watcher triggers.
		1091
		1092	$timer = $timer->start
		1093	Start the watcher.
		1094
		1095	$timer = $timer->stop
		1096	Stop the watcher.
		1097
		1098	The "urxvt::pw" Class
		1099	This class implements process watchers. They create an event whenever a
		1100	process exits, after which they stop automatically.
		1101
		1102	my $pid = fork;
		1103	...
		1104	$term->{pw} = urxvt::pw
776	->new	1105	->new
777	->fd (fileno $term->{socket})
778	->events (urxvt::EVENT_READ)
779	->start	1106	->start ($pid)
780	->cb (sub {	1107	->cb (sub {
781	my ($iow, $revents) = @_;	1108	my ($pw, $exit_status) = @_;
782	# $revents must be 1 here, no need to check
783	sysread $term->{socket}, my $buf, 8192
784	or end-of-file;
785	});	1109	...
		1110	});
786		1111
787	$iow = new urxvt::iow	1112	$pw = new urxvt::pw
788	Create a new io watcher object in stopped state.	1113	Create a new process watcher in stopped state.
789		1114
790	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	1115	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
791	Set the callback to be called when io events are triggered.	1116	Set the callback to be called when the timer triggers.
792	$reventmask is a bitset as described in the "events" method.
793		1117
794	$iow = $iow->fd ($fd)	1118	$pw = $timer->start ($pid)
795	Set the filedescriptor (not handle) to watch.	1119	Tells the wqtcher to start watching for process $pid.
796		1120
797	$iow = $iow->events ($eventmask)
798	Set the event mask to watch. The only allowed values are
799	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be
800	ORed together, or "urxvt::EVENT_NONE".
801
802	$iow = $iow->start
803	Start watching for requested events on the given handle.
804
805	$iow = $iow->stop	1121	$pw = $pw->stop
806	Stop watching for events on the given filehandle.	1122	Stop the watcher.
807		1123
808	ENVIRONMENT	1124	ENVIRONMENT
809	URXVT_PERL_VERBOSITY	1125	URXVT_PERL_VERBOSITY
810	This variable controls the verbosity level of the perl extension.	1126	This variable controls the verbosity level of the perl extension. Higher
811	Higher numbers indicate more verbose output.	1127	numbers indicate more verbose output.
812		1128
813	== 0 - fatal messages	1129	== 0 - fatal messages
814	>= 3 - script loading and management	1130	>= 3 - script loading and management
815	>=10 - all events received	1131	>=10 - all called hooks
		1132	>=11 - hook reutrn values
816		1133
817	AUTHOR	1134	AUTHOR
818	Marc Lehmann <pcg@goof.com>	1135	Marc Lehmann <pcg@goof.com>
819	http://software.schmorp.de/pkg/rxvt-unicode	1136	http://software.schmorp.de/pkg/rxvt-unicode
820		1137

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.19 by root, Tue Jan 10 19:46:28 2006 UTC vs. Revision 1.33 by root, Fri Jan 20 22:49:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.19 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.33 by root, Fri Jan 20 22:49:34 2006 UTC