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

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.35 by root, Sun Jan 22 20:39:56 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.35 by root, Sun Jan 22 20:39:56 2006 UTC