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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.23 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC

…		…
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
		34	Or by adding them to the resource for extensions loaded by default:
		35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
33		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 and	40	intelligent when the user extends selections (double-click and
37	further clicks). Right now, it tries to select words, urls and	41	further clicks). Right now, it tries to select words, urls and
…		…
39	your ls supports "--quoting-style=shell".	43	your ls supports "--quoting-style=shell".
40		44
41	A double-click usually selects the word under the cursor, further	45	A double-click usually selects the word under the cursor, further
42	clicks will enlarge the selection.	46	clicks will enlarge the selection.
43		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	Another example: Programs I use often output "absolute path: " at
		64	the beginning of a line when they process multiple files. The
		65	following pattern matches the filename (note, there is a single
		66	space at the very end):
		67
		68	URxvt.selection.pattern-0: ^(/[^:]+):\
		69
		70	You can look at the source of the selection extension to see more
		71	interesting uses, such as parsing a line from beginning to end.
		72
44	It also offers the following bindable keyboard command:	73	This extension also offers following bindable keyboard commands:
45		74
46	rot13	75	rot13
47	Rot-13 the selection when activated. Used via keyboard trigger:	76	Rot-13 the selection when activated. Used via keyboard trigger:
48		77
49	URxvt.keysym.C-M-r: perl:selection:rot13	78	URxvt.keysym.C-M-r: perl:selection:rot13
…		…
53	options at runtime.	82	options at runtime.
54		83
55	selection-popup (enabled by default)	84	selection-popup (enabled by default)
56	Binds a popup menu to Ctrl-Button3 that lets you convert the	85	Binds a popup menu to Ctrl-Button3 that lets you convert the
57	selection text into various other formats/action (such as uri	86	selection text into various other formats/action (such as uri
58	unescaping, perl evalution, web-browser starting etc.), depending on	87	unescaping, perl evaluation, web-browser starting etc.), depending
59	content.	88	on content.
		89
		90	Other extensions can extend this popup menu by pushing a code
		91	reference onto "@{ $term-"{selection_popup_hook} }>, that is called
		92	whenever the popup is displayed.
		93
		94	It's sole argument is the popup menu, which can be modified. The
		95	selection is in $_, which can be used to decide wether to add
		96	something or not. It should either return nothing or a string and a
		97	code reference. The string will be used as button text and the code
		98	reference will be called when the button gets activated and should
		99	transform $_.
		100
		101	The following will add an entry "a to b" that transforms all "a"s in
		102	the selection to "b"s, but only if the selection currently contains
		103	any "a"s:
		104
		105	push @{ $self->{term}{selection_popup_hook} }, sub {
		106	/a/ ? ("a to be" => sub { s/a/b/g }
		107	: ()
		108	};
60		109
61	searchable-scrollback<hotkey> (enabled by default)	110	searchable-scrollback<hotkey> (enabled by default)
62	Adds regex search functionality to the scrollback buffer, triggered	111	Adds regex search functionality to the scrollback buffer, triggered
63	by a hotkey (default: "M-s"). While in search mode, normal terminal	112	by a hotkey (default: "M-s"). While in search mode, normal terminal
64	input/output is suspended and a regex is displayed at the bottom of	113	input/output is suspended and a regex is displayed at the bottom of
…		…
70	"End" jumps to the bottom. "Escape" leaves search mode and returns	119	"End" jumps to the bottom. "Escape" leaves search mode and returns
71	to the point where search was started, while "Enter" or "Return"	120	to the point where search was started, while "Enter" or "Return"
72	stay at the current position and additionally stores the first match	121	stay at the current position and additionally stores the first match
73	in the current line into the primary selection.	122	in the current line into the primary selection.
74		123
75	digital-clock	124	readline (enabled by default)
76	Displays a digital clock using the built-in overlay.	125	A support package that tries to make editing with readline easier.
		126	At the moment, it reacts to clicking with the left mouse button by
		127	trying to move the text cursor to this position. It does so by
		128	generating as many cursor-left or cursor-right keypresses as
		129	required (the this only works for programs that correctly support
		130	wide characters).
		131
		132	To avoid too many false positives, this is only done when:
		133
		134	- the tty is in ICANON state.
		135	- the text cursor is visible.
		136	- the primary screen is currently being displayed.
		137	- the mouse is on the same (multi-row-) line as the text cursor.
		138
		139	The normal selection mechanism isn't disabled, so quick successive
		140	clicks might interfere with selection creation in harmless ways.
		141
		142	selection-autotransform
		143	This selection allows you to do automatic transforms on a selection
		144	whenever a selection is made.
		145
		146	It works by specifying perl snippets (most useful is a single "s///"
		147	operator) that modify $_ as resources:
		148
		149	URxvt.selection-autotransform.0: transform
		150	URxvt.selection-autotransform.1: transform
		151	...
		152
		153	For example, the following will transform selections of the form
		154	"filename:number", often seen in compiler messages, into "vi
		155	+$filename $word":
		156
		157	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		158
		159	And this example matches the same,but replaces it with vi-commands
		160	you can paste directly into your (vi :) editor:
		161
		162	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		163
		164	Of course, this can be modified to suit your needs and your editor
		165	:)
		166
		167	To expand the example above to typical perl error messages ("XXX at
		168	FILENAME line YYY."), you need a slightly more elaborate solution:
		169
		170	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		171	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		172
		173	The first line tells the selection code to treat the unchanging part
		174	of every error message as a selection pattern, and the second line
		175	transforms the message into vi commands to load the file.
		176
		177	tabbed
		178	This transforms the terminal into a tabbar with additional
		179	terminals, that is, it implements what is commonly refered to as
		180	"tabbed terminal". The topmost line displays a "[NEW]" button,
		181	which, when clicked, will add a new tab, followed by one button per
		182	tab.
		183
		184	Clicking a button will activate that tab. Pressing Shift-Left and
		185	Shift-Right will switch to the tab left or right of the current one,
		186	while Shift-Down creates a new tab.
77		187
78	mark-urls	188	mark-urls
79	Uses per-line display filtering ("on_line_update") to underline urls	189	Uses per-line display filtering ("on_line_update") to underline urls
80	and make them clickable. When middle-clicked, the program specified	190	and make them clickable. When middle-clicked, the program specified
81	in the resource "urlLauncher" (default "x-www-browser") will be	191	in the resource "urlLauncher" (default "x-www-browser") will be
82	started with the URL as first argument.	192	started with the URL as first argument.
83		193
		194	xim-onthespot
		195	This (experimental) perl extension implements OnTheSpot editing. It
		196	does not work perfectly, and some input methods don't seem to work
		197	well with OnTheSpot editing in general, but it seems to work at
		198	leats for SCIM and kinput2.
		199
		200	You enable it by specifying this extension and a preedit style of
		201	"OnTheSpot", i.e.:
		202
		203	rxvt -pt OnTheSpot -pe xim-onthespot
		204
		205	automove-background
		206	This is basically a one-line extension that dynamically changes the
		207	background pixmap offset to the window position, in effect creating
		208	the same effect as pseudo transparency with a custom pixmap. No
		209	scaling is supported in this mode. Exmaple:
		210
		211	rxvt -pixmap background.xpm -pe automove-background
		212
84	block-graphics-to-ascii	213	block-graphics-to-ascii
85	A not very useful example of filtering all text output to the	214	A not very useful example of filtering all text output to the
86	terminal, by replacing all line-drawing characters (U+2500 ..	215	terminal, by replacing all line-drawing characters (U+2500 ..
87	U+259F) by a similar-looking ascii character.	216	U+259F) by a similar-looking ascii character.
88		217
		218	digital-clock
		219	Displays a digital clock using the built-in overlay.
		220
89	example-refresh-hooks	221	example-refresh-hooks
90	Displays a very simple digital clock in the upper right corner of	222	Displays a very simple digital clock in the upper right corner of
91	the window. Illustrates overwriting the refresh callbacks to create	223	the window. Illustrates overwriting the refresh callbacks to create
92	your own overlays or changes.	224	your own overlays or changes.
		225
		226	selection-pastebin
		227	This is a little rarely useful extension that Uploads the selection
		228	as textfile to a remote site (or does other things). (The
		229	implementation is not currently secure for use in a multiuser
		230	environment as it writes to /tmp directly.).
		231
		232	It listens to the "selection-pastebin:remote-pastebin" keyboard
		233	command, i.e.
		234
		235	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		236
		237	Pressing this combination runs a command with "%" replaced by the
		238	name of the textfile. This command can be set via a resource:
		239
		240	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		241
		242	And the default is likely not useful to anybody but the few people
		243	around here :)
		244
		245	The name of the textfile is the hex encoded md5 sum of the
		246	selection, so the same content should lead to the same filename.
		247
		248	After a successful upload the selection will be replaced by the text
		249	given in the "selection-pastebin-url" resource (again, the % is the
		250	placeholder for the filename):
		251
		252	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
93		253
94	API DOCUMENTATION	254	API DOCUMENTATION
95	General API Considerations	255	General API Considerations
96	All objects (such as terminals, time watchers etc.) are typical	256	All objects (such as terminals, time watchers etc.) are typical
97	reference-to-hash objects. The hash can be used to store anything you	257	reference-to-hash objects. The hash can be used to store anything you
…		…
151	be called whenever the relevant event happens.	311	be called whenever the relevant event happens.
152		312
153	The first argument passed to them is an extension oject as described in	313	The first argument passed to them is an extension oject as described in
154	the in the "Extension Objects" section.	314	the in the "Extension Objects" section.
155		315
156	All of these hooks must return a boolean value. If it is true, then the	316	All of these hooks must return a boolean value. If any of the called
157	event counts as being consumed, and the invocation of other hooks is	317	hooks returns true, then the event counts as being consumed, and the
158	skipped, and the relevant action might not be carried out by the C++	318	relevant action might not be carried out by the C++ code.
159	code.
160		319
161	When in doubt, return a false value (preferably "()").	320	When in doubt, return a false value (preferably "()").
162		321
163	on_init $term	322	on_init $term
164	Called after a new terminal object has been initialized, but before	323	Called after a new terminal object has been initialized, but before
165	windows are created or the command gets run. Most methods are unsafe	324	windows are created or the command gets run. Most methods are unsafe
166	to call or deliver senseless data, as terminal size and other	325	to call or deliver senseless data, as terminal size and other
167	characteristics have not yet been determined. You can safely query	326	characteristics have not yet been determined. You can safely query
168	and change resources, though.	327	and change resources and options, though. For many purposes the
		328	"on_start" hook is a better place.
		329
		330	on_start $term
		331	Called at the very end of initialisation of a new terminal, just
		332	before trying to map (display) the toplevel and returning to the
		333	mainloop.
		334
		335	on_destroy $term
		336	Called whenever something tries to destroy terminal, when the
		337	terminal is still fully functional (not for long, though).
169		338
170	on_reset $term	339	on_reset $term
171	Called after the screen is "reset" for any reason, such as resizing	340	Called after the screen is "reset" for any reason, such as resizing
172	or control sequences. Here is where you can react on changes to	341	or control sequences. Here is where you can react on changes to
173	size-related variables.	342	size-related variables.
174		343
175	on_start $term	344	on_child_start $term, $pid
176	Called at the very end of initialisation of a new terminal, just	345	Called just after the child process has been "fork"ed.
177	before returning to the mainloop.	346
		347	on_child_exit $term, $status
		348	Called just after the child process has exited. $status is the
		349	status from "waitpid".
178		350
179	on_sel_make $term, $eventtime	351	on_sel_make $term, $eventtime
180	Called whenever a selection has been made by the user, but before	352	Called whenever a selection has been made by the user, but before
181	the selection text is copied, so changes to the beginning, end or	353	the selection text is copied, so changes to the beginning, end or
182	type of the selection will be honored.	354	type of the selection will be honored.
…		…
267	on_keyboard_command $term, $string	439	on_keyboard_command $term, $string
268	Called whenever the user presses a key combination that has a	440	Called whenever the user presses a key combination that has a
269	"perl:string" action bound to it (see description of the keysym	441	"perl:string" action bound to it (see description of the keysym
270	resource in the rxvt(1) manpage).	442	resource in the rxvt(1) manpage).
271		443
		444	on_x_event $term, $event
		445	Called on every X event received on the vt window (and possibly
		446	other windows). Should only be used as a last resort. Most event
		447	structure members are not passed.
		448
272	on_focus_in $term	449	on_focus_in $term
273	Called whenever the window gets the keyboard focus, before	450	Called whenever the window gets the keyboard focus, before
274	rxvt-unicode does focus in processing.	451	rxvt-unicode does focus in processing.
275		452
276	on_focus_out $term	453	on_focus_out $term
277	Called wheneever the window loses keyboard focus, before	454	Called wheneever the window loses keyboard focus, before
278	rxvt-unicode does focus out processing.	455	rxvt-unicode does focus out processing.
279		456
		457	on_configure_notify $term, $event
		458	on_property_notify $term, $event
280	on_key_press $term, $event, $keysym, $octets	459	on_key_press $term, $event, $keysym, $octets
281	on_key_release $term, $event, $keysym	460	on_key_release $term, $event, $keysym
282	on_button_press $term, $event	461	on_button_press $term, $event
283	on_button_release $term, $event	462	on_button_release $term, $event
284	on_motion_notify $term, $event	463	on_motion_notify $term, $event
…		…
288	terminal If the hook returns true, then the even will be ignored by	467	terminal If the hook returns true, then the even will be ignored by
289	rxvt-unicode.	468	rxvt-unicode.
290		469
291	The event is a hash with most values as named by Xlib (see the	470	The event is a hash with most values as named by Xlib (see the
292	XEvent manpage), with the additional members "row" and "col", which	471	XEvent manpage), with the additional members "row" and "col", which
293	are the row and column under the mouse cursor.	472	are the (real, not screen-based) row and column under the mouse
		473	cursor.
294		474
295	"on_key_press" additionally receives the string rxvt-unicode would	475	"on_key_press" additionally receives the string rxvt-unicode would
296	output, if any, in locale-specific encoding.	476	output, if any, in locale-specific encoding.
297		477
298	subwindow.	478	subwindow.
		479
		480	on_client_message $term, $event
		481	on_wm_protocols $term, $event
		482	on_wm_delete_window $term, $event
		483	Called when various types of ClientMessage events are received (all
		484	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
299		485
300	Variables in the "urxvt" Package	486	Variables in the "urxvt" Package
301	$urxvt::LIBDIR	487	$urxvt::LIBDIR
302	The rxvt-unicode library directory, where, among other things, the	488	The rxvt-unicode library directory, where, among other things, the
303	perl modules and scripts are stored.	489	perl modules and scripts are stored.
…		…
310	The basename of the installed binaries, usually "urxvt".	496	The basename of the installed binaries, usually "urxvt".
311		497
312	$urxvt::TERM	498	$urxvt::TERM
313	The current terminal. This variable stores the current "urxvt::term"	499	The current terminal. This variable stores the current "urxvt::term"
314	object, whenever a callback/hook is executing.	500	object, whenever a callback/hook is executing.
		501
		502	@urxvt::TERM_INIT
		503	All coderefs in this array will be called as methods of the next
		504	newly created "urxvt::term" object (during the "on_init" phase). The
		505	array gets cleared before the codereferences that were in it are
		506	being executed, so coderefs can push themselves onto it again if
		507	they so desire.
		508
		509	This complements to the perl-eval commandline option, but gets
		510	executed first.
		511
		512	@urxvt::TERM_EXT
		513	Works similar to @TERM_INIT, but contains perl package/class names,
		514	which get registered as normal extensions after calling the hooks in
		515	@TERM_INIT but before other extensions. Gets cleared just like
		516	@TERM_INIT.
315		517
316	Functions in the "urxvt" Package	518	Functions in the "urxvt" Package
317	urxvt::fatal $errormessage	519	urxvt::fatal $errormessage
318	Fatally aborts execution with the given error message. Avoid at all	520	Fatally aborts execution with the given error message. Avoid at all
319	costs! The only time this is acceptable is when the terminal process	521	costs! The only time this is acceptable is when the terminal process
…		…
327	Using this function has the advantage that its output ends up in the	529	Using this function has the advantage that its output ends up in the
328	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
329		531
330	Messages have a size limit of 1023 bytes currently.	532	Messages have a size limit of 1023 bytes currently.
331		533
332	$is_safe = urxvt::safe
333	Returns true when it is safe to do potentially unsafe things, such
334	as evaluating perl code specified by the user. This is true when
335	urxvt was started setuid or setgid.
336
337	$time = urxvt::NOW	534	$time = urxvt::NOW
338	Returns the "current time" (as per the event loop).	535	Returns the "current time" (as per the event loop).
339		536
340	urxvt::CurrentTime	537	urxvt::CurrentTime
341	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	538	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
342	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	539	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
343	Button5Mask, AnyModifier	540	Button5Mask, AnyModifier
		541	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		542	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		543	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		544	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		545	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		546	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		547	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		548	ColormapChangeMask, OwnerGrabButtonMask
		549	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		550	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		551	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		552	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		553	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		554	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		555	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
344	Various constants for use in X calls and event processing.	556	Various constants for use in X calls and event processing.
345		557
346	RENDITION	558	RENDITION
347	Rendition bitsets contain information about colour, font, font styles	559	Rendition bitsets contain information about colour, font, font styles
348	and similar information for each screen cell.	560	and similar information for each screen cell.
…		…
404	$term->destroy	616	$term->destroy
405	Destroy the terminal object (close the window, free resources etc.).	617	Destroy the terminal object (close the window, free resources etc.).
406	Please note that rxvt will not exit as long as any event watchers	618	Please note that rxvt will not exit as long as any event watchers
407	(timers, io watchers) are still active.	619	(timers, io watchers) are still active.
408		620
		621	$term->exec_async ($cmd[, @args])
		622	Works like the combination of the "fork"/"exec" builtins, which
		623	executes ("starts") programs in the background. This function takes
		624	care of setting the user environment before exec'ing the command
		625	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		626	or "system".
		627
		628	Returns the pid of the subprocess or "undef" on error.
		629
409	$isset = $term->option ($optval[, $set])	630	$isset = $term->option ($optval[, $set])
410	Returns true if the option specified by $optval is enabled, and	631	Returns true if the option specified by $optval is enabled, and
411	optionally change it. All option values are stored by name in the	632	optionally change it. All option values are stored by name in the
412	hash %urxvt::OPTION. Options not enabled in this binary are not in	633	hash %urxvt::OPTION. Options not enabled in this binary are not in
413	the hash.	634	the hash.
…		…
415	Here is a a likely non-exhaustive list of option names, please see	636	Here is a a likely non-exhaustive list of option names, please see
416	the source file /src/optinc.h to see the actual list:	637	the source file /src/optinc.h to see the actual list:
417		638
418	borderLess console cursorBlink cursorUnderline hold iconic insecure	639	borderLess console cursorBlink cursorUnderline hold iconic insecure
419	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	640	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
420	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	641	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
421	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	642	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
422	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	643	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
423	tripleclickwords utmpInhibit visualBell	644	transparent tripleclickwords utmpInhibit visualBell
424		645
425	$value = $term->resource ($name[, $newval])	646	$value = $term->resource ($name[, $newval])
426	Returns the current resource value associated with a given name and	647	Returns the current resource value associated with a given name and
427	optionally sets a new value. Setting values is most useful in the	648	optionally sets a new value. Setting values is most useful in the
428	"init" hook. Unset resources are returned and accepted as "undef".	649	"init" hook. Unset resources are returned and accepted as "undef".
…		…
445		666
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	667	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	668	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	669	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	670	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	671	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	672	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	673	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	674	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	675	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	676	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		677	secondaryScreen secondaryScroll selectstyle shade term_name title
456	shade term_name title transparent transparent_all tripleclickwords	678	transient_for transparent transparent_all tripleclickwords utmpInhibit
457	utmpInhibit visualBell	679	visualBell
458		680
459	$value = $term->x_resource ($pattern)	681	$value = $term->x_resource ($pattern)
460	Returns the X-Resource for the given pattern, excluding the program	682	Returns the X-Resource for the given pattern, excluding the program
461	or class name, i.e. "$term->x_resource ("boldFont")" should return	683	or class name, i.e. "$term->x_resource ("boldFont")" should return
462	the same value as used by this instance of rxvt-unicode. Returns	684	the same value as used by this instance of rxvt-unicode. Returns
…		…
573		795
574	Normally its not a good idea to use this function, as programs might	796	Normally its not a good idea to use this function, as programs might
575	be confused by changes in cursor position or scrolling. Its useful	797	be confused by changes in cursor position or scrolling. Its useful
576	inside a "on_add_lines" hook, though.	798	inside a "on_add_lines" hook, though.
577		799
		800	$term->scr_change_screen ($screen)
		801	Switch to given screen - 0 primary, 1 secondary.
		802
578	$term->cmd_parse ($octets)	803	$term->cmd_parse ($octets)
579	Similar to "scr_add_lines", but the argument must be in the	804	Similar to "scr_add_lines", but the argument must be in the
580	locale-specific encoding of the terminal and can contain command	805	locale-specific encoding of the terminal and can contain command
581	sequences (escape codes) that will be interpreted.	806	sequences (escape codes) that will be interpreted.
582		807
…		…
590	Replaces the event mask of the pty watcher by the given event mask.	815	Replaces the event mask of the pty watcher by the given event mask.
591	Can be used to suppress input and output handling to the pty/tty.	816	Can be used to suppress input and output handling to the pty/tty.
592	See the description of "urxvt::timer->events". Make sure to always	817	See the description of "urxvt::timer->events". Make sure to always
593	restore the previous value.	818	restore the previous value.
594		819
		820	$fd = $term->pty_fd
		821	Returns the master file descriptor for the pty in use, or -1 if no
		822	pty is used.
		823
595	$windowid = $term->parent	824	$windowid = $term->parent
596	Return the window id of the toplevel window.	825	Return the window id of the toplevel window.
597		826
598	$windowid = $term->vt	827	$windowid = $term->vt
599	Return the window id of the terminal window.	828	Return the window id of the terminal window.
		829
		830	$term->vt_emask_add ($x_event_mask)
		831	Adds the specified events to the vt event mask. Useful e.g. when you
		832	want to receive pointer events all the times:
		833
		834	$term->vt_emask_add (urxvt::PointerMotionMask);
600		835
601	$window_width = $term->width	836	$window_width = $term->width
602	$window_height = $term->height	837	$window_height = $term->height
603	$font_width = $term->fwidth	838	$font_width = $term->fwidth
604	$font_height = $term->fheight	839	$font_height = $term->fheight
…		…
607	$terminal_columns = $term->ncol	842	$terminal_columns = $term->ncol
608	$has_focus = $term->focus	843	$has_focus = $term->focus
609	$is_mapped = $term->mapped	844	$is_mapped = $term->mapped
610	$max_scrollback = $term->saveLines	845	$max_scrollback = $term->saveLines
611	$nrow_plus_saveLines = $term->total_rows	846	$nrow_plus_saveLines = $term->total_rows
612	$lines_in_scrollback = $term->nsaved	847	$topmost_scrollback_row = $term->top_row
613	Return various integers describing terminal characteristics.	848	Return various integers describing terminal characteristics.
614		849
615	$x_display = $term->display_id	850	$x_display = $term->display_id
616	Return the DISPLAY used by rxvt-unicode.	851	Return the DISPLAY used by rxvt-unicode.
617		852
…		…
627	$modifiermask = $term->ModNumLockMask	862	$modifiermask = $term->ModNumLockMask
628	Return the modifier masks corresponding to the "ISO Level 3 Shift"	863	Return the modifier masks corresponding to the "ISO Level 3 Shift"
629	(often AltGr), the meta key (often Alt) and the num lock key, if	864	(often AltGr), the meta key (often Alt) and the num lock key, if
630	applicable.	865	applicable.
631		866
		867	$screen = $term->current_screen
		868	Returns the currently displayed screen (0 primary, 1 secondary).
		869
		870	$cursor_is_hidden = $term->hidden_cursor
		871	Returns wether the cursor is currently hidden or not.
		872
632	$view_start = $term->view_start ([$newvalue])	873	$view_start = $term->view_start ([$newvalue])
633	Returns the negative row number of the topmost line. Minimum value	874	Returns the row number of the topmost displayed line. Maximum value
634	is 0, which displays the normal terminal contents. Larger values	875	is 0, which displays the normal terminal contents. Lower values
635	scroll this many lines into the scrollback buffer.	876	scroll this many lines into the scrollback buffer.
636		877
637	$term->want_refresh	878	$term->want_refresh
638	Requests a screen refresh. At the next opportunity, rxvt-unicode	879	Requests a screen refresh. At the next opportunity, rxvt-unicode
639	will compare the on-screen display with its stored representation.	880	will compare the on-screen display with its stored representation.
…		…
652	line, starting at column $start_col (default 0), which is useful to	893	line, starting at column $start_col (default 0), which is useful to
653	replace only parts of a line. The font index in the rendition will	894	replace only parts of a line. The font index in the rendition will
654	automatically be updated.	895	automatically be updated.
655		896
656	$text is in a special encoding: tabs and wide characters that use	897	$text is in a special encoding: tabs and wide characters that use
657	more than one cell when displayed are padded with urxvt::NOCHAR	898	more than one cell when displayed are padded with $urxvt::NOCHAR
658	characters ("chr 65535"). Characters with combining characters and	899	(chr 65535) characters. Characters with combining characters and
659	other characters that do not fit into the normal tetx encoding will	900	other characters that do not fit into the normal tetx encoding will
660	be replaced with characters in the private use area.	901	be replaced with characters in the private use area.
661		902
662	You have to obey this encoding when changing text. The advantage is	903	You have to obey this encoding when changing text. The advantage is
663	that "substr" and similar functions work on screen cells and not on	904	that "substr" and similar functions work on screen cells and not on
…		…
743		984
744	$term->ungrab	985	$term->ungrab
745	Calls XUngrab for the most recent grab. Is called automatically on	986	Calls XUngrab for the most recent grab. Is called automatically on
746	evaluation errors, as it is better to lose the grab in the error	987	evaluation errors, as it is better to lose the grab in the error
747	case as the session.	988	case as the session.
		989
		990	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		991	$atom_name = $term->XGetAtomName ($atom)
		992	@atoms = $term->XListProperties ($window)
		993	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		994	$term->XChangeWindowProperty ($window, $property, $type, $format,
		995	$octets)
		996	$term->XDeleteProperty ($window, $property)
		997	$window = $term->DefaultRootWindow
		998	$term->XReparentWindow ($window, $parent, [$x, $y])
		999	$term->XMapWindow ($window)
		1000	$term->XUnmapWindow ($window)
		1001	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1002	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1003	$y)
		1004	$term->XChangeInput ($window, $add_events[, $del_events])
		1005	Various X or X-related functions. The $term object only serves as
		1006	the source of the display, otherwise those functions map
		1007	more-or-less directory onto the X functions of the same name.
748		1008
749	The "urxvt::popup" Class	1009	The "urxvt::popup" Class
750	$popup->add_title ($title)	1010	$popup->add_title ($title)
751	Adds a non-clickable title to the popup.	1011	Adds a non-clickable title to the popup.
752		1012
…		…
800	$timer = $timer->start	1060	$timer = $timer->start
801	Start the timer.	1061	Start the timer.
802		1062
803	$timer = $timer->start ($tstamp)	1063	$timer = $timer->start ($tstamp)
804	Set the event trigger time to $tstamp and start the timer.	1064	Set the event trigger time to $tstamp and start the timer.
		1065
		1066	$timer = $timer->after ($delay)
		1067	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
805		1068
806	$timer = $timer->stop	1069	$timer = $timer->stop
807	Stop the timer.	1070	Stop the timer.
808		1071
809	The "urxvt::iow" Class	1072	The "urxvt::iow" Class
…		…
841	Start watching for requested events on the given handle.	1104	Start watching for requested events on the given handle.
842		1105
843	$iow = $iow->stop	1106	$iow = $iow->stop
844	Stop watching for events on the given filehandle.	1107	Stop watching for events on the given filehandle.
845		1108
		1109	The "urxvt::iw" Class
		1110	This class implements idle watchers, that get called automatically when
		1111	the process is idle. They should return as fast as possible, after doing
		1112	some useful work.
		1113
		1114	$iw = new urxvt::iw
		1115	Create a new idle watcher object in stopped state.
		1116
		1117	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1118	Set the callback to be called when the watcher triggers.
		1119
		1120	$timer = $timer->start
		1121	Start the watcher.
		1122
		1123	$timer = $timer->stop
		1124	Stop the watcher.
		1125
		1126	The "urxvt::pw" Class
		1127	This class implements process watchers. They create an event whenever a
		1128	process exits, after which they stop automatically.
		1129
		1130	my $pid = fork;
		1131	...
		1132	$term->{pw} = urxvt::pw
		1133	->new
		1134	->start ($pid)
		1135	->cb (sub {
		1136	my ($pw, $exit_status) = @_;
		1137	...
		1138	});
		1139
		1140	$pw = new urxvt::pw
		1141	Create a new process watcher in stopped state.
		1142
		1143	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1144	Set the callback to be called when the timer triggers.
		1145
		1146	$pw = $timer->start ($pid)
		1147	Tells the wqtcher to start watching for process $pid.
		1148
		1149	$pw = $pw->stop
		1150	Stop the watcher.
		1151
846	ENVIRONMENT	1152	ENVIRONMENT
847	URXVT_PERL_VERBOSITY	1153	URXVT_PERL_VERBOSITY
848	This variable controls the verbosity level of the perl extension. Higher	1154	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1155	numbers indicate more verbose output.
850		1156

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.23 by root, Thu Jan 12 05:37:34 2006 UTC vs. Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.23 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC