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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.26 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.34 by root, Sat Jan 21 19:50:53 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
…		…
57	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	61	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
58		62
59	You can look at the source of the selection extension to see more	63	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.	64	interesting uses, such as parsing a line from beginning to end.
61		65
62	This extension also offers the following bindable keyboard command:	66	This extension also offers following bindable keyboard commands:
63		67
64	rot13	68	rot13
65	Rot-13 the selection when activated. Used via keyboard trigger:	69	Rot-13 the selection when activated. Used via keyboard trigger:
66		70
67	URxvt.keysym.C-M-r: perl:selection:rot13	71	URxvt.keysym.C-M-r: perl:selection:rot13
…		…
71	options at runtime.	75	options at runtime.
72		76
73	selection-popup (enabled by default)	77	selection-popup (enabled by default)
74	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
75	selection text into various other formats/action (such as uri	79	selection text into various other formats/action (such as uri
76	unescaping, perl evalution, web-browser starting etc.), depending on	80	unescaping, perl evaluation, web-browser starting etc.), depending
77	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	};
78		102
79	searchable-scrollback<hotkey> (enabled by default)	103	searchable-scrollback<hotkey> (enabled by default)
80	Adds regex search functionality to the scrollback buffer, triggered	104	Adds regex search functionality to the scrollback buffer, triggered
81	by a hotkey (default: "M-s"). While in search mode, normal terminal	105	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	106	input/output is suspended and a regex is displayed at the bottom of
…		…
88	"End" jumps to the bottom. "Escape" leaves search mode and returns	112	"End" jumps to the bottom. "Escape" leaves search mode and returns
89	to the point where search was started, while "Enter" or "Return"	113	to the point where search was started, while "Enter" or "Return"
90	stay at the current position and additionally stores the first match	114	stay at the current position and additionally stores the first match
91	in the current line into the primary selection.	115	in the current line into the primary selection.
92		116
		117	readline (enabled by default)
		118	A support package that tries to make editing with readline easier.
		119	At the moment, it reacts to clicking with the left mouse button by
		120	trying to move the text cursor to this position. It does so by
		121	generating as many cursor-left or cursor-right keypresses as
		122	required (the this only works for programs that correctly support
		123	wide characters).
		124
		125	To avoid too many false positives, this is only done when:
		126
		127	- the mouse is on the same (multi-row-) line as the text cursor.
		128	- the primary screen is currently being displayed.
		129	- the text cursor is visible.
		130
		131	The normal selection mechanism isn't disabled, so quick successive
		132	clicks might interfere with selection creation in harmless ways.
		133
93	selection-autotransform	134	selection-autotransform
94	This selection allows you to do automatic transforms on a selection	135	This selection allows you to do automatic transforms on a selection
95	whenever a selection is made.	136	whenever a selection is made.
96		137
97	It works by specifying perl snippets (most useful is a single "s///"	138	It works by specifying perl snippets (most useful is a single "s///"
…		…
103		144
104	For example, the following will transform selections of the form	145	For example, the following will transform selections of the form
105	"filename:number", often seen in compiler messages, into "vi	146	"filename:number", often seen in compiler messages, into "vi
106	+$filename $word":	147	+$filename $word":
107		148
108	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	149	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
109		150
110	And this example matches the same,but replaces it with vi-commands	151	And this example matches the same,but replaces it with vi-commands
111	you can paste directly into your (vi :) editor:	152	you can paste directly into your (vi :) editor:
112		153
113	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	154	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
114		155
115	Of course, this can be modified to suit your needs and your editor	156	Of course, this can be modified to suit your needs and your editor
116	:)	157	:)
117		158
118	To expand the example above to typical perl error messages ("XXX at	159	To expand the example above to typical perl error messages ("XXX at
119	FILENAME line YYY."), you need a slightly more elaborate solution:	160	FILENAME line YYY."), you need a slightly more elaborate solution:
120		161
121	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	162	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
122	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	163	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
123		164
124	The first line tells the selection code to treat the unchanging part	165	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	166	of every error message as a selection pattern, and the second line
126	transforms the message into vi commands to load the file.	167	transforms the message into vi commands to load the file.
		168
		169	tabbed
		170	This transforms the terminal into a tabbar with additional
		171	terminals, that is, it implements what is commonly refered to as
		172	"tabbed terminal". The topmost line displays a "[NEW]" button,
		173	which, when clicked, will add a new tab, followed by one button per
		174	tab.
		175
		176	Clicking a button will activate that tab. Pressing Shift-Left and
		177	Shift-Right will switch to the tab left or right of the current one,
		178	while Shift-Down creates a new tab.
127		179
128	mark-urls	180	mark-urls
129	Uses per-line display filtering ("on_line_update") to underline urls	181	Uses per-line display filtering ("on_line_update") to underline urls
130	and make them clickable. When middle-clicked, the program specified	182	and make them clickable. When middle-clicked, the program specified
131	in the resource "urlLauncher" (default "x-www-browser") will be	183	in the resource "urlLauncher" (default "x-www-browser") will be
132	started with the URL as first argument.	184	started with the URL as first argument.
133		185
		186	automove-background
		187	This is basically a one-line extension that dynamically changes the
		188	background pixmap offset to the window position, in effect creating
		189	the same effect as pseudo transparency with a custom pixmap. No
		190	scaling is supported in this mode. Exmaple:
		191
		192	rxvt -pixmap background.xpm -pe automove-background
		193
134	block-graphics-to-ascii	194	block-graphics-to-ascii
135	A not very useful example of filtering all text output to the	195	A not very useful example of filtering all text output to the
136	terminal, by replacing all line-drawing characters (U+2500 ..	196	terminal, by replacing all line-drawing characters (U+2500 ..
137	U+259F) by a similar-looking ascii character.	197	U+259F) by a similar-looking ascii character.
138		198
…		…
141		201
142	example-refresh-hooks	202	example-refresh-hooks
143	Displays a very simple digital clock in the upper right corner of	203	Displays a very simple digital clock in the upper right corner of
144	the window. Illustrates overwriting the refresh callbacks to create	204	the window. Illustrates overwriting the refresh callbacks to create
145	your own overlays or changes.	205	your own overlays or changes.
		206
		207	selection-pastebin
		208	This is a little rarely useful extension that Uploads the selection
		209	as textfile to a remote site (or does other things). (The
		210	implementation is not currently secure for use in a multiuser
		211	environment as it writes to /tmp directly.).
		212
		213	It listens to the "selection-pastebin:remote-pastebin" keyboard
		214	command, i.e.
		215
		216	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		217
		218	Pressing this combination runs a command with "%" replaced by the
		219	name of the textfile. This command can be set via a resource:
		220
		221	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		222
		223	And the default is likely not useful to anybody but the few people
		224	around here :)
		225
		226	The name of the textfile is the hex encoded md5 sum of the
		227	selection, so the same content should lead to the same filename.
		228
		229	After a successful upload the selection will be replaced by the text
		230	given in the "selection-pastebin-url" resource (again, the % is the
		231	placeholder for the filename):
		232
		233	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
146		234
147	API DOCUMENTATION	235	API DOCUMENTATION
148	General API Considerations	236	General API Considerations
149	All objects (such as terminals, time watchers etc.) are typical	237	All objects (such as terminals, time watchers etc.) are typical
150	reference-to-hash objects. The hash can be used to store anything you	238	reference-to-hash objects. The hash can be used to store anything you
…		…
204	be called whenever the relevant event happens.	292	be called whenever the relevant event happens.
205		293
206	The first argument passed to them is an extension oject as described in	294	The first argument passed to them is an extension oject as described in
207	the in the "Extension Objects" section.	295	the in the "Extension Objects" section.
208		296
209	All of these hooks must return a boolean value. If it is true, then the	297	All of these hooks must return a boolean value. If any of the called
210	event counts as being consumed, and the invocation of other hooks is	298	hooks returns true, then the event counts as being consumed, and the
211	skipped, and the relevant action might not be carried out by the C++	299	relevant action might not be carried out by the C++ code.
212	code.
213		300
214	When in doubt, return a false value (preferably "()").	301	When in doubt, return a false value (preferably "()").
215		302
216	on_init $term	303	on_init $term
217	Called after a new terminal object has been initialized, but before	304	Called after a new terminal object has been initialized, but before
218	windows are created or the command gets run. Most methods are unsafe	305	windows are created or the command gets run. Most methods are unsafe
219	to call or deliver senseless data, as terminal size and other	306	to call or deliver senseless data, as terminal size and other
220	characteristics have not yet been determined. You can safely query	307	characteristics have not yet been determined. You can safely query
221	and change resources, though.	308	and change resources and options, though. For many purposes the
		309	"on_start" hook is a better place.
		310
		311	on_start $term
		312	Called at the very end of initialisation of a new terminal, just
		313	before trying to map (display) the toplevel and returning to the
		314	mainloop.
		315
		316	on_destroy $term
		317	Called whenever something tries to destroy terminal, before doing
		318	anything yet. If this hook returns true, then destruction is
		319	skipped, but this is rarely a good idea.
222		320
223	on_reset $term	321	on_reset $term
224	Called after the screen is "reset" for any reason, such as resizing	322	Called after the screen is "reset" for any reason, such as resizing
225	or control sequences. Here is where you can react on changes to	323	or control sequences. Here is where you can react on changes to
226	size-related variables.	324	size-related variables.
227		325
228	on_start $term	326	on_child_start $term, $pid
229	Called at the very end of initialisation of a new terminal, just	327	Called just after the child process has been "fork"ed.
230	before returning to the mainloop.	328
		329	on_child_exit $term, $status
		330	Called just after the child process has exited. $status is the
		331	status from "waitpid".
231		332
232	on_sel_make $term, $eventtime	333	on_sel_make $term, $eventtime
233	Called whenever a selection has been made by the user, but before	334	Called whenever a selection has been made by the user, but before
234	the selection text is copied, so changes to the beginning, end or	335	the selection text is copied, so changes to the beginning, end or
235	type of the selection will be honored.	336	type of the selection will be honored.
…		…
320	on_keyboard_command $term, $string	421	on_keyboard_command $term, $string
321	Called whenever the user presses a key combination that has a	422	Called whenever the user presses a key combination that has a
322	"perl:string" action bound to it (see description of the keysym	423	"perl:string" action bound to it (see description of the keysym
323	resource in the rxvt(1) manpage).	424	resource in the rxvt(1) manpage).
324		425
		426	on_x_event $term, $event
		427	Called on every X event received on the vt window (and possibly
		428	other windows). Should only be used as a last resort. Most event
		429	structure members are not passed.
		430
325	on_focus_in $term	431	on_focus_in $term
326	Called whenever the window gets the keyboard focus, before	432	Called whenever the window gets the keyboard focus, before
327	rxvt-unicode does focus in processing.	433	rxvt-unicode does focus in processing.
328		434
329	on_focus_out $term	435	on_focus_out $term
330	Called wheneever the window loses keyboard focus, before	436	Called wheneever the window loses keyboard focus, before
331	rxvt-unicode does focus out processing.	437	rxvt-unicode does focus out processing.
332		438
		439	on_configure_notify $term, $event
		440	on_property_notify $term, $event
333	on_key_press $term, $event, $keysym, $octets	441	on_key_press $term, $event, $keysym, $octets
334	on_key_release $term, $event, $keysym	442	on_key_release $term, $event, $keysym
335	on_button_press $term, $event	443	on_button_press $term, $event
336	on_button_release $term, $event	444	on_button_release $term, $event
337	on_motion_notify $term, $event	445	on_motion_notify $term, $event
…		…
341	terminal If the hook returns true, then the even will be ignored by	449	terminal If the hook returns true, then the even will be ignored by
342	rxvt-unicode.	450	rxvt-unicode.
343		451
344	The event is a hash with most values as named by Xlib (see the	452	The event is a hash with most values as named by Xlib (see the
345	XEvent manpage), with the additional members "row" and "col", which	453	XEvent manpage), with the additional members "row" and "col", which
346	are the row and column under the mouse cursor.	454	are the (real, not screen-based) row and column under the mouse
		455	cursor.
347		456
348	"on_key_press" additionally receives the string rxvt-unicode would	457	"on_key_press" additionally receives the string rxvt-unicode would
349	output, if any, in locale-specific encoding.	458	output, if any, in locale-specific encoding.
350		459
351	subwindow.	460	subwindow.
		461
		462	on_client_message $term, $event
		463	on_wm_protocols $term, $event
		464	on_wm_delete_window $term, $event
		465	Called when various types of ClientMessage events are received (all
		466	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
352		467
353	Variables in the "urxvt" Package	468	Variables in the "urxvt" Package
354	$urxvt::LIBDIR	469	$urxvt::LIBDIR
355	The rxvt-unicode library directory, where, among other things, the	470	The rxvt-unicode library directory, where, among other things, the
356	perl modules and scripts are stored.	471	perl modules and scripts are stored.
…		…
363	The basename of the installed binaries, usually "urxvt".	478	The basename of the installed binaries, usually "urxvt".
364		479
365	$urxvt::TERM	480	$urxvt::TERM
366	The current terminal. This variable stores the current "urxvt::term"	481	The current terminal. This variable stores the current "urxvt::term"
367	object, whenever a callback/hook is executing.	482	object, whenever a callback/hook is executing.
		483
		484	@urxvt::TERM_INIT
		485	All coderefs in this array will be called as methods of the next
		486	newly created "urxvt::term" object (during the "on_init" phase). The
		487	array gets cleared before the codereferences that were in it are
		488	being executed, so coderefs can push themselves onto it again if
		489	they so desire.
		490
		491	This complements to the perl-eval commandline option, but gets
		492	executed first.
		493
		494	@urxvt::TERM_EXT
		495	Works similar to @TERM_INIT, but contains perl package/class names,
		496	which get registered as normal extensions after calling the hooks in
		497	@TERM_INIT but before other extensions. Gets cleared just like
		498	@TERM_INIT.
368		499
369	Functions in the "urxvt" Package	500	Functions in the "urxvt" Package
370	urxvt::fatal $errormessage	501	urxvt::fatal $errormessage
371	Fatally aborts execution with the given error message. Avoid at all	502	Fatally aborts execution with the given error message. Avoid at all
372	costs! The only time this is acceptable is when the terminal process	503	costs! The only time this is acceptable is when the terminal process
…		…
380	Using this function has the advantage that its output ends up in the	511	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.	512	correct place, e.g. on stderr of the connecting urxvtc client.
382		513
383	Messages have a size limit of 1023 bytes currently.	514	Messages have a size limit of 1023 bytes currently.
384		515
385	$is_safe = urxvt::safe
386	Returns true when it is safe to do potentially unsafe things, such
387	as evaluating perl code specified by the user. This is true when
388	urxvt was started setuid or setgid.
389
390	$time = urxvt::NOW	516	$time = urxvt::NOW
391	Returns the "current time" (as per the event loop).	517	Returns the "current time" (as per the event loop).
392		518
393	urxvt::CurrentTime	519	urxvt::CurrentTime
394	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	520	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
395	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	521	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
396	Button5Mask, AnyModifier	522	Button5Mask, AnyModifier
		523	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		524	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		525	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		526	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		527	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		528	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		529	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		530	ColormapChangeMask, OwnerGrabButtonMask
		531	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		532	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		533	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		534	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		535	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		536	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		537	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
397	Various constants for use in X calls and event processing.	538	Various constants for use in X calls and event processing.
398		539
399	RENDITION	540	RENDITION
400	Rendition bitsets contain information about colour, font, font styles	541	Rendition bitsets contain information about colour, font, font styles
401	and similar information for each screen cell.	542	and similar information for each screen cell.
…		…
457	$term->destroy	598	$term->destroy
458	Destroy the terminal object (close the window, free resources etc.).	599	Destroy the terminal object (close the window, free resources etc.).
459	Please note that rxvt will not exit as long as any event watchers	600	Please note that rxvt will not exit as long as any event watchers
460	(timers, io watchers) are still active.	601	(timers, io watchers) are still active.
461		602
		603	$term->exec_async ($cmd[, @args])
		604	Works like the combination of the "fork"/"exec" builtins, which
		605	executes ("starts") programs in the background. This function takes
		606	care of setting the user environment before exec'ing the command
		607	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		608	or "system".
		609
		610	Returns the pid of the subprocess or "undef" on error.
		611
462	$isset = $term->option ($optval[, $set])	612	$isset = $term->option ($optval[, $set])
463	Returns true if the option specified by $optval is enabled, and	613	Returns true if the option specified by $optval is enabled, and
464	optionally change it. All option values are stored by name in the	614	optionally change it. All option values are stored by name in the
465	hash %urxvt::OPTION. Options not enabled in this binary are not in	615	hash %urxvt::OPTION. Options not enabled in this binary are not in
466	the hash.	616	the hash.
…		…
468	Here is a a likely non-exhaustive list of option names, please see	618	Here is a a likely non-exhaustive list of option names, please see
469	the source file /src/optinc.h to see the actual list:	619	the source file /src/optinc.h to see the actual list:
470		620
471	borderLess console cursorBlink cursorUnderline hold iconic insecure	621	borderLess console cursorBlink cursorUnderline hold iconic insecure
472	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	622	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
473	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	623	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
474	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	624	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
475	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	625	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
476	tripleclickwords utmpInhibit visualBell	626	transparent tripleclickwords utmpInhibit visualBell
477		627
478	$value = $term->resource ($name[, $newval])	628	$value = $term->resource ($name[, $newval])
479	Returns the current resource value associated with a given name and	629	Returns the current resource value associated with a given name and
480	optionally sets a new value. Setting values is most useful in the	630	optionally sets a new value. Setting values is most useful in the
481	"init" hook. Unset resources are returned and accepted as "undef".	631	"init" hook. Unset resources are returned and accepted as "undef".
…		…
498		648
499	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	649	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
500	borderLess color cursorBlink cursorUnderline cutchars delete_key	650	borderLess color cursorBlink cursorUnderline cutchars delete_key
501	display_name embed ext_bwidth fade font geometry hold iconName	651	display_name embed ext_bwidth fade font geometry hold iconName
502	imFont imLocale inputMethod insecure int_bwidth intensityStyles	652	imFont imLocale inputMethod insecure int_bwidth intensityStyles
503	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	653	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
504	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	654	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
505	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	655	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
506	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	656	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
507	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	657	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
508	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	658	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		659	secondaryScreen secondaryScroll selectstyle shade term_name title
509	shade term_name title transparent transparent_all tripleclickwords	660	transient_for transparent transparent_all tripleclickwords utmpInhibit
510	utmpInhibit visualBell	661	visualBell
511		662
512	$value = $term->x_resource ($pattern)	663	$value = $term->x_resource ($pattern)
513	Returns the X-Resource for the given pattern, excluding the program	664	Returns the X-Resource for the given pattern, excluding the program
514	or class name, i.e. "$term->x_resource ("boldFont")" should return	665	or class name, i.e. "$term->x_resource ("boldFont")" should return
515	the same value as used by this instance of rxvt-unicode. Returns	666	the same value as used by this instance of rxvt-unicode. Returns
…		…
626		777
627	Normally its not a good idea to use this function, as programs might	778	Normally its not a good idea to use this function, as programs might
628	be confused by changes in cursor position or scrolling. Its useful	779	be confused by changes in cursor position or scrolling. Its useful
629	inside a "on_add_lines" hook, though.	780	inside a "on_add_lines" hook, though.
630		781
		782	$term->scr_change_screen ($screen)
		783	Switch to given screen - 0 primary, 1 secondary.
		784
631	$term->cmd_parse ($octets)	785	$term->cmd_parse ($octets)
632	Similar to "scr_add_lines", but the argument must be in the	786	Similar to "scr_add_lines", but the argument must be in the
633	locale-specific encoding of the terminal and can contain command	787	locale-specific encoding of the terminal and can contain command
634	sequences (escape codes) that will be interpreted.	788	sequences (escape codes) that will be interpreted.
635		789
…		…
648	$windowid = $term->parent	802	$windowid = $term->parent
649	Return the window id of the toplevel window.	803	Return the window id of the toplevel window.
650		804
651	$windowid = $term->vt	805	$windowid = $term->vt
652	Return the window id of the terminal window.	806	Return the window id of the terminal window.
		807
		808	$term->vt_emask_add ($x_event_mask)
		809	Adds the specified events to the vt event mask. Useful e.g. when you
		810	want to receive pointer events all the times:
		811
		812	$term->vt_emask_add (urxvt::PointerMotionMask);
653		813
654	$window_width = $term->width	814	$window_width = $term->width
655	$window_height = $term->height	815	$window_height = $term->height
656	$font_width = $term->fwidth	816	$font_width = $term->fwidth
657	$font_height = $term->fheight	817	$font_height = $term->fheight
…		…
660	$terminal_columns = $term->ncol	820	$terminal_columns = $term->ncol
661	$has_focus = $term->focus	821	$has_focus = $term->focus
662	$is_mapped = $term->mapped	822	$is_mapped = $term->mapped
663	$max_scrollback = $term->saveLines	823	$max_scrollback = $term->saveLines
664	$nrow_plus_saveLines = $term->total_rows	824	$nrow_plus_saveLines = $term->total_rows
665	$lines_in_scrollback = $term->nsaved	825	$topmost_scrollback_row = $term->top_row
666	Return various integers describing terminal characteristics.	826	Return various integers describing terminal characteristics.
667		827
668	$x_display = $term->display_id	828	$x_display = $term->display_id
669	Return the DISPLAY used by rxvt-unicode.	829	Return the DISPLAY used by rxvt-unicode.
670		830
…		…
680	$modifiermask = $term->ModNumLockMask	840	$modifiermask = $term->ModNumLockMask
681	Return the modifier masks corresponding to the "ISO Level 3 Shift"	841	Return the modifier masks corresponding to the "ISO Level 3 Shift"
682	(often AltGr), the meta key (often Alt) and the num lock key, if	842	(often AltGr), the meta key (often Alt) and the num lock key, if
683	applicable.	843	applicable.
684		844
		845	$screen = $term->current_screen
		846	Returns the currently displayed screen (0 primary, 1 secondary).
		847
		848	$cursor_is_hidden = $term->hidden_cursor
		849	Returns wether the cursor is currently hidden or not.
		850
685	$view_start = $term->view_start ([$newvalue])	851	$view_start = $term->view_start ([$newvalue])
686	Returns the negative row number of the topmost line. Minimum value	852	Returns the row number of the topmost displayed line. Maximum value
687	is 0, which displays the normal terminal contents. Larger values	853	is 0, which displays the normal terminal contents. Lower values
688	scroll this many lines into the scrollback buffer.	854	scroll this many lines into the scrollback buffer.
689		855
690	$term->want_refresh	856	$term->want_refresh
691	Requests a screen refresh. At the next opportunity, rxvt-unicode	857	Requests a screen refresh. At the next opportunity, rxvt-unicode
692	will compare the on-screen display with its stored representation.	858	will compare the on-screen display with its stored representation.
…		…
705	line, starting at column $start_col (default 0), which is useful to	871	line, starting at column $start_col (default 0), which is useful to
706	replace only parts of a line. The font index in the rendition will	872	replace only parts of a line. The font index in the rendition will
707	automatically be updated.	873	automatically be updated.
708		874
709	$text is in a special encoding: tabs and wide characters that use	875	$text is in a special encoding: tabs and wide characters that use
710	more than one cell when displayed are padded with urxvt::NOCHAR	876	more than one cell when displayed are padded with $urxvt::NOCHAR
711	characters ("chr 65535"). Characters with combining characters and	877	characters. Characters with combining characters and other
712	other characters that do not fit into the normal tetx encoding will	878	characters that do not fit into the normal tetx encoding will be
713	be replaced with characters in the private use area.	879	replaced with characters in the private use area.
714		880
715	You have to obey this encoding when changing text. The advantage is	881	You have to obey this encoding when changing text. The advantage is
716	that "substr" and similar functions work on screen cells and not on	882	that "substr" and similar functions work on screen cells and not on
717	characters.	883	characters.
718		884
…		…
796		962
797	$term->ungrab	963	$term->ungrab
798	Calls XUngrab for the most recent grab. Is called automatically on	964	Calls XUngrab for the most recent grab. Is called automatically on
799	evaluation errors, as it is better to lose the grab in the error	965	evaluation errors, as it is better to lose the grab in the error
800	case as the session.	966	case as the session.
		967
		968	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		969	$atom_name = $term->XGetAtomName ($atom)
		970	@atoms = $term->XListProperties ($window)
		971	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		972	$term->XChangeWindowProperty ($window, $property, $type, $format,
		973	$octets)
		974	$term->XDeleteProperty ($window, $property)
		975	$window = $term->DefaultRootWindow
		976	$term->XReparentWindow ($window, $parent, [$x, $y])
		977	$term->XMapWindow ($window)
		978	$term->XUnmapWindow ($window)
		979	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		980	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		981	$y)
		982	$term->XChangeInput ($window, $add_events[, $del_events])
		983	Various X or X-related functions. The $term object only serves as
		984	the source of the display, otherwise those functions map
		985	more-or-less directory onto the X functions of the same name.
801		986
802	The "urxvt::popup" Class	987	The "urxvt::popup" Class
803	$popup->add_title ($title)	988	$popup->add_title ($title)
804	Adds a non-clickable title to the popup.	989	Adds a non-clickable title to the popup.
805		990
…		…
853	$timer = $timer->start	1038	$timer = $timer->start
854	Start the timer.	1039	Start the timer.
855		1040
856	$timer = $timer->start ($tstamp)	1041	$timer = $timer->start ($tstamp)
857	Set the event trigger time to $tstamp and start the timer.	1042	Set the event trigger time to $tstamp and start the timer.
		1043
		1044	$timer = $timer->after ($delay)
		1045	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
858		1046
859	$timer = $timer->stop	1047	$timer = $timer->stop
860	Stop the timer.	1048	Stop the timer.
861		1049
862	The "urxvt::iow" Class	1050	The "urxvt::iow" Class
…		…
894	Start watching for requested events on the given handle.	1082	Start watching for requested events on the given handle.
895		1083
896	$iow = $iow->stop	1084	$iow = $iow->stop
897	Stop watching for events on the given filehandle.	1085	Stop watching for events on the given filehandle.
898		1086
		1087	The "urxvt::iw" Class
		1088	This class implements idle watchers, that get called automatically when
		1089	the process is idle. They should return as fast as possible, after doing
		1090	some useful work.
		1091
		1092	$iw = new urxvt::iw
		1093	Create a new idle watcher object in stopped state.
		1094
		1095	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1096	Set the callback to be called when the watcher triggers.
		1097
		1098	$timer = $timer->start
		1099	Start the watcher.
		1100
		1101	$timer = $timer->stop
		1102	Stop the watcher.
		1103
		1104	The "urxvt::pw" Class
		1105	This class implements process watchers. They create an event whenever a
		1106	process exits, after which they stop automatically.
		1107
		1108	my $pid = fork;
		1109	...
		1110	$term->{pw} = urxvt::pw
		1111	->new
		1112	->start ($pid)
		1113	->cb (sub {
		1114	my ($pw, $exit_status) = @_;
		1115	...
		1116	});
		1117
		1118	$pw = new urxvt::pw
		1119	Create a new process watcher in stopped state.
		1120
		1121	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1122	Set the callback to be called when the timer triggers.
		1123
		1124	$pw = $timer->start ($pid)
		1125	Tells the wqtcher to start watching for process $pid.
		1126
		1127	$pw = $pw->stop
		1128	Stop the watcher.
		1129
899	ENVIRONMENT	1130	ENVIRONMENT
900	URXVT_PERL_VERBOSITY	1131	URXVT_PERL_VERBOSITY
901	This variable controls the verbosity level of the perl extension. Higher	1132	This variable controls the verbosity level of the perl extension. Higher
902	numbers indicate more verbose output.	1133	numbers indicate more verbose output.
903		1134

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.26 by root, Fri Jan 13 01:09:37 2006 UTC vs. Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.26 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC