[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.37 by root, Wed Jan 25 21:48:47 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.
		217
		218	digital-clock
		219	Displays a digital clock using the built-in overlay.
		220
		221	remote-clipboard
		222	Somewhat of a misnomer, this extension adds two menu entries to the
		223	selection popup that allows one ti run external commands to store
		224	the selection somewhere and fetch it again.
		225
		226	We use it to implement a "distributed selection mechanism", which
		227	just means that one command uploads the file to a remote server, and
		228	another reads it.
		229
		230	The commands can be set using the "URxvt.remote-selection.store" and
		231	"URxvt.remote-selection.fetch" resources. The first should read the
		232	selection to store from STDIN (always in UTF-8), the second should
		233	provide the selection data on STDOUT (also in UTF-8).
		234
		235	The defaults (which are likely useless to you) use rsh and cat:
		236
		237	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		238	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		239
		240	selection-pastebin
		241	This is a little rarely useful extension that Uploads the selection
		242	as textfile to a remote site (or does other things). (The
		243	implementation is not currently secure for use in a multiuser
		244	environment as it writes to /tmp directly.).
		245
		246	It listens to the "selection-pastebin:remote-pastebin" keyboard
		247	command, i.e.
		248
		249	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		250
		251	Pressing this combination runs a command with "%" replaced by the
		252	name of the textfile. This command can be set via a resource:
		253
		254	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		255
		256	And the default is likely not useful to anybody but the few people
		257	around here :)
		258
		259	The name of the textfile is the hex encoded md5 sum of the
		260	selection, so the same content should lead to the same filename.
		261
		262	After a successful upload the selection will be replaced by the text
		263	given in the "selection-pastebin-url" resource (again, the % is the
		264	placeholder for the filename):
		265
		266	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
88		267
89	example-refresh-hooks	268	example-refresh-hooks
90	Displays a very simple digital clock in the upper right corner of	269	Displays a very simple digital clock in the upper right corner of
91	the window. Illustrates overwriting the refresh callbacks to create	270	the window. Illustrates overwriting the refresh callbacks to create
92	your own overlays or changes.	271	your own overlays or changes.
…		…
151	be called whenever the relevant event happens.	330	be called whenever the relevant event happens.
152		331
153	The first argument passed to them is an extension oject as described in	332	The first argument passed to them is an extension oject as described in
154	the in the "Extension Objects" section.	333	the in the "Extension Objects" section.
155		334
156	All of these hooks must return a boolean value. If it is true, then the	335	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	336	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++	337	relevant action might not be carried out by the C++ code.
159	code.
160		338
161	When in doubt, return a false value (preferably "()").	339	When in doubt, return a false value (preferably "()").
162		340
163	on_init $term	341	on_init $term
164	Called after a new terminal object has been initialized, but before	342	Called after a new terminal object has been initialized, but before
165	windows are created or the command gets run. Most methods are unsafe	343	windows are created or the command gets run. Most methods are unsafe
166	to call or deliver senseless data, as terminal size and other	344	to call or deliver senseless data, as terminal size and other
167	characteristics have not yet been determined. You can safely query	345	characteristics have not yet been determined. You can safely query
168	and change resources, though.	346	and change resources and options, though. For many purposes the
		347	"on_start" hook is a better place.
		348
		349	on_start $term
		350	Called at the very end of initialisation of a new terminal, just
		351	before trying to map (display) the toplevel and returning to the
		352	mainloop.
		353
		354	on_destroy $term
		355	Called whenever something tries to destroy terminal, when the
		356	terminal is still fully functional (not for long, though).
169		357
170	on_reset $term	358	on_reset $term
171	Called after the screen is "reset" for any reason, such as resizing	359	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	360	or control sequences. Here is where you can react on changes to
173	size-related variables.	361	size-related variables.
174		362
175	on_start $term	363	on_child_start $term, $pid
176	Called at the very end of initialisation of a new terminal, just	364	Called just after the child process has been "fork"ed.
177	before returning to the mainloop.	365
		366	on_child_exit $term, $status
		367	Called just after the child process has exited. $status is the
		368	status from "waitpid".
178		369
179	on_sel_make $term, $eventtime	370	on_sel_make $term, $eventtime
180	Called whenever a selection has been made by the user, but before	371	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	372	the selection text is copied, so changes to the beginning, end or
182	type of the selection will be honored.	373	type of the selection will be honored.
…		…
262	display code is run after this hook, and takes precedence.	453	display code is run after this hook, and takes precedence.
263		454
264	on_refresh_end $term	455	on_refresh_end $term
265	Called just after the screen gets redrawn. See "on_refresh_begin".	456	Called just after the screen gets redrawn. See "on_refresh_begin".
266		457
267	on_keyboard_command $term, $string	458	on_user_command $term, $string
268	Called whenever the user presses a key combination that has a	459	Called whenever the a user-configured event is being activated (e.g.
269	"perl:string" action bound to it (see description of the keysym	460	via a "perl:string" action bound to a key, see description of the
270	resource in the rxvt(1) manpage).	461	keysym resource in the rxvt(1) manpage).
		462
		463	The event is simply the action string. This interface is assumed to
		464	change slightly in the future.
		465
		466	on_x_event $term, $event
		467	Called on every X event received on the vt window (and possibly
		468	other windows). Should only be used as a last resort. Most event
		469	structure members are not passed.
271		470
272	on_focus_in $term	471	on_focus_in $term
273	Called whenever the window gets the keyboard focus, before	472	Called whenever the window gets the keyboard focus, before
274	rxvt-unicode does focus in processing.	473	rxvt-unicode does focus in processing.
275		474
276	on_focus_out $term	475	on_focus_out $term
277	Called wheneever the window loses keyboard focus, before	476	Called wheneever the window loses keyboard focus, before
278	rxvt-unicode does focus out processing.	477	rxvt-unicode does focus out processing.
279		478
		479	on_configure_notify $term, $event
		480	on_property_notify $term, $event
280	on_key_press $term, $event, $keysym, $octets	481	on_key_press $term, $event, $keysym, $octets
281	on_key_release $term, $event, $keysym	482	on_key_release $term, $event, $keysym
282	on_button_press $term, $event	483	on_button_press $term, $event
283	on_button_release $term, $event	484	on_button_release $term, $event
284	on_motion_notify $term, $event	485	on_motion_notify $term, $event
…		…
288	terminal If the hook returns true, then the even will be ignored by	489	terminal If the hook returns true, then the even will be ignored by
289	rxvt-unicode.	490	rxvt-unicode.
290		491
291	The event is a hash with most values as named by Xlib (see the	492	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	493	XEvent manpage), with the additional members "row" and "col", which
293	are the row and column under the mouse cursor.	494	are the (real, not screen-based) row and column under the mouse
		495	cursor.
294		496
295	"on_key_press" additionally receives the string rxvt-unicode would	497	"on_key_press" additionally receives the string rxvt-unicode would
296	output, if any, in locale-specific encoding.	498	output, if any, in locale-specific encoding.
297		499
298	subwindow.	500	subwindow.
		501
		502	on_client_message $term, $event
		503	on_wm_protocols $term, $event
		504	on_wm_delete_window $term, $event
		505	Called when various types of ClientMessage events are received (all
		506	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
299		507
300	Variables in the "urxvt" Package	508	Variables in the "urxvt" Package
301	$urxvt::LIBDIR	509	$urxvt::LIBDIR
302	The rxvt-unicode library directory, where, among other things, the	510	The rxvt-unicode library directory, where, among other things, the
303	perl modules and scripts are stored.	511	perl modules and scripts are stored.
…		…
310	The basename of the installed binaries, usually "urxvt".	518	The basename of the installed binaries, usually "urxvt".
311		519
312	$urxvt::TERM	520	$urxvt::TERM
313	The current terminal. This variable stores the current "urxvt::term"	521	The current terminal. This variable stores the current "urxvt::term"
314	object, whenever a callback/hook is executing.	522	object, whenever a callback/hook is executing.
		523
		524	@urxvt::TERM_INIT
		525	All coderefs in this array will be called as methods of the next
		526	newly created "urxvt::term" object (during the "on_init" phase). The
		527	array gets cleared before the codereferences that were in it are
		528	being executed, so coderefs can push themselves onto it again if
		529	they so desire.
		530
		531	This complements to the perl-eval commandline option, but gets
		532	executed first.
		533
		534	@urxvt::TERM_EXT
		535	Works similar to @TERM_INIT, but contains perl package/class names,
		536	which get registered as normal extensions after calling the hooks in
		537	@TERM_INIT but before other extensions. Gets cleared just like
		538	@TERM_INIT.
315		539
316	Functions in the "urxvt" Package	540	Functions in the "urxvt" Package
317	urxvt::fatal $errormessage	541	urxvt::fatal $errormessage
318	Fatally aborts execution with the given error message. Avoid at all	542	Fatally aborts execution with the given error message. Avoid at all
319	costs! The only time this is acceptable is when the terminal process	543	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	551	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.	552	correct place, e.g. on stderr of the connecting urxvtc client.
329		553
330	Messages have a size limit of 1023 bytes currently.	554	Messages have a size limit of 1023 bytes currently.
331		555
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	556	$time = urxvt::NOW
338	Returns the "current time" (as per the event loop).	557	Returns the "current time" (as per the event loop).
339		558
340	urxvt::CurrentTime	559	urxvt::CurrentTime
341	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	560	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
342	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	561	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
343	Button5Mask, AnyModifier	562	Button5Mask, AnyModifier
		563	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		564	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		565	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		566	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		567	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		568	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		569	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		570	ColormapChangeMask, OwnerGrabButtonMask
		571	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		572	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		573	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		574	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		575	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
344	Various constants for use in X calls and event processing.	578	Various constants for use in X calls and event processing.
345		579
346	RENDITION	580	RENDITION
347	Rendition bitsets contain information about colour, font, font styles	581	Rendition bitsets contain information about colour, font, font styles
348	and similar information for each screen cell.	582	and similar information for each screen cell.
…		…
404	$term->destroy	638	$term->destroy
405	Destroy the terminal object (close the window, free resources etc.).	639	Destroy the terminal object (close the window, free resources etc.).
406	Please note that rxvt will not exit as long as any event watchers	640	Please note that rxvt will not exit as long as any event watchers
407	(timers, io watchers) are still active.	641	(timers, io watchers) are still active.
408		642
		643	$term->exec_async ($cmd[, @args])
		644	Works like the combination of the "fork"/"exec" builtins, which
		645	executes ("starts") programs in the background. This function takes
		646	care of setting the user environment before exec'ing the command
		647	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		648	or "system".
		649
		650	Returns the pid of the subprocess or "undef" on error.
		651
409	$isset = $term->option ($optval[, $set])	652	$isset = $term->option ($optval[, $set])
410	Returns true if the option specified by $optval is enabled, and	653	Returns true if the option specified by $optval is enabled, and
411	optionally change it. All option values are stored by name in the	654	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	655	hash %urxvt::OPTION. Options not enabled in this binary are not in
413	the hash.	656	the hash.
…		…
415	Here is a a likely non-exhaustive list of option names, please see	658	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:	659	the source file /src/optinc.h to see the actual list:
417		660
418	borderLess console cursorBlink cursorUnderline hold iconic insecure	661	borderLess console cursorBlink cursorUnderline hold iconic insecure
419	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	662	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
420	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	663	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
421	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	664	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
422	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	665	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
423	tripleclickwords utmpInhibit visualBell	666	transparent tripleclickwords utmpInhibit visualBell
424		667
425	$value = $term->resource ($name[, $newval])	668	$value = $term->resource ($name[, $newval])
426	Returns the current resource value associated with a given name and	669	Returns the current resource value associated with a given name and
427	optionally sets a new value. Setting values is most useful in the	670	optionally sets a new value. Setting values is most useful in the
428	"init" hook. Unset resources are returned and accepted as "undef".	671	"init" hook. Unset resources are returned and accepted as "undef".
…		…
445		688
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	689	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	690	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	691	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	692	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	693	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	694	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	695	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	696	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	697	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	698	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		699	secondaryScreen secondaryScroll selectstyle shade term_name title
456	shade term_name title transparent transparent_all tripleclickwords	700	transient_for transparent transparent_all tripleclickwords utmpInhibit
457	utmpInhibit visualBell	701	visualBell
458		702
459	$value = $term->x_resource ($pattern)	703	$value = $term->x_resource ($pattern)
460	Returns the X-Resource for the given pattern, excluding the program	704	Returns the X-Resource for the given pattern, excluding the program
461	or class name, i.e. "$term->x_resource ("boldFont")" should return	705	or class name, i.e. "$term->x_resource ("boldFont")" should return
462	the same value as used by this instance of rxvt-unicode. Returns	706	the same value as used by this instance of rxvt-unicode. Returns
…		…
573		817
574	Normally its not a good idea to use this function, as programs might	818	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	819	be confused by changes in cursor position or scrolling. Its useful
576	inside a "on_add_lines" hook, though.	820	inside a "on_add_lines" hook, though.
577		821
		822	$term->scr_change_screen ($screen)
		823	Switch to given screen - 0 primary, 1 secondary.
		824
578	$term->cmd_parse ($octets)	825	$term->cmd_parse ($octets)
579	Similar to "scr_add_lines", but the argument must be in the	826	Similar to "scr_add_lines", but the argument must be in the
580	locale-specific encoding of the terminal and can contain command	827	locale-specific encoding of the terminal and can contain command
581	sequences (escape codes) that will be interpreted.	828	sequences (escape codes) that will be interpreted.
582		829
…		…
590	Replaces the event mask of the pty watcher by the given event mask.	837	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.	838	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	839	See the description of "urxvt::timer->events". Make sure to always
593	restore the previous value.	840	restore the previous value.
594		841
		842	$fd = $term->pty_fd
		843	Returns the master file descriptor for the pty in use, or -1 if no
		844	pty is used.
		845
595	$windowid = $term->parent	846	$windowid = $term->parent
596	Return the window id of the toplevel window.	847	Return the window id of the toplevel window.
597		848
598	$windowid = $term->vt	849	$windowid = $term->vt
599	Return the window id of the terminal window.	850	Return the window id of the terminal window.
		851
		852	$term->vt_emask_add ($x_event_mask)
		853	Adds the specified events to the vt event mask. Useful e.g. when you
		854	want to receive pointer events all the times:
		855
		856	$term->vt_emask_add (urxvt::PointerMotionMask);
600		857
601	$window_width = $term->width	858	$window_width = $term->width
602	$window_height = $term->height	859	$window_height = $term->height
603	$font_width = $term->fwidth	860	$font_width = $term->fwidth
604	$font_height = $term->fheight	861	$font_height = $term->fheight
…		…
607	$terminal_columns = $term->ncol	864	$terminal_columns = $term->ncol
608	$has_focus = $term->focus	865	$has_focus = $term->focus
609	$is_mapped = $term->mapped	866	$is_mapped = $term->mapped
610	$max_scrollback = $term->saveLines	867	$max_scrollback = $term->saveLines
611	$nrow_plus_saveLines = $term->total_rows	868	$nrow_plus_saveLines = $term->total_rows
612	$lines_in_scrollback = $term->nsaved	869	$topmost_scrollback_row = $term->top_row
613	Return various integers describing terminal characteristics.	870	Return various integers describing terminal characteristics.
614		871
615	$x_display = $term->display_id	872	$x_display = $term->display_id
616	Return the DISPLAY used by rxvt-unicode.	873	Return the DISPLAY used by rxvt-unicode.
617		874
…		…
627	$modifiermask = $term->ModNumLockMask	884	$modifiermask = $term->ModNumLockMask
628	Return the modifier masks corresponding to the "ISO Level 3 Shift"	885	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	886	(often AltGr), the meta key (often Alt) and the num lock key, if
630	applicable.	887	applicable.
631		888
		889	$screen = $term->current_screen
		890	Returns the currently displayed screen (0 primary, 1 secondary).
		891
		892	$cursor_is_hidden = $term->hidden_cursor
		893	Returns wether the cursor is currently hidden or not.
		894
632	$view_start = $term->view_start ([$newvalue])	895	$view_start = $term->view_start ([$newvalue])
633	Returns the negative row number of the topmost line. Minimum value	896	Returns the row number of the topmost displayed line. Maximum value
634	is 0, which displays the normal terminal contents. Larger values	897	is 0, which displays the normal terminal contents. Lower values
635	scroll this many lines into the scrollback buffer.	898	scroll this many lines into the scrollback buffer.
636		899
637	$term->want_refresh	900	$term->want_refresh
638	Requests a screen refresh. At the next opportunity, rxvt-unicode	901	Requests a screen refresh. At the next opportunity, rxvt-unicode
639	will compare the on-screen display with its stored representation.	902	will compare the on-screen display with its stored representation.
…		…
652	line, starting at column $start_col (default 0), which is useful to	915	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	916	replace only parts of a line. The font index in the rendition will
654	automatically be updated.	917	automatically be updated.
655		918
656	$text is in a special encoding: tabs and wide characters that use	919	$text is in a special encoding: tabs and wide characters that use
657	more than one cell when displayed are padded with urxvt::NOCHAR	920	more than one cell when displayed are padded with $urxvt::NOCHAR
658	characters ("chr 65535"). Characters with combining characters and	921	(chr 65535) characters. Characters with combining characters and
659	other characters that do not fit into the normal tetx encoding will	922	other characters that do not fit into the normal tetx encoding will
660	be replaced with characters in the private use area.	923	be replaced with characters in the private use area.
661		924
662	You have to obey this encoding when changing text. The advantage is	925	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	926	that "substr" and similar functions work on screen cells and not on
…		…
743		1006
744	$term->ungrab	1007	$term->ungrab
745	Calls XUngrab for the most recent grab. Is called automatically on	1008	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	1009	evaluation errors, as it is better to lose the grab in the error
747	case as the session.	1010	case as the session.
		1011
		1012	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1013	$atom_name = $term->XGetAtomName ($atom)
		1014	@atoms = $term->XListProperties ($window)
		1015	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1016	$term->XChangeWindowProperty ($window, $property, $type, $format,
		1017	$octets)
		1018	$term->XDeleteProperty ($window, $property)
		1019	$window = $term->DefaultRootWindow
		1020	$term->XReparentWindow ($window, $parent, [$x, $y])
		1021	$term->XMapWindow ($window)
		1022	$term->XUnmapWindow ($window)
		1023	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1024	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1025	$y)
		1026	$term->XChangeInput ($window, $add_events[, $del_events])
		1027	Various X or X-related functions. The $term object only serves as
		1028	the source of the display, otherwise those functions map
		1029	more-or-less directory onto the X functions of the same name.
748		1030
749	The "urxvt::popup" Class	1031	The "urxvt::popup" Class
750	$popup->add_title ($title)	1032	$popup->add_title ($title)
751	Adds a non-clickable title to the popup.	1033	Adds a non-clickable title to the popup.
752		1034
…		…
800	$timer = $timer->start	1082	$timer = $timer->start
801	Start the timer.	1083	Start the timer.
802		1084
803	$timer = $timer->start ($tstamp)	1085	$timer = $timer->start ($tstamp)
804	Set the event trigger time to $tstamp and start the timer.	1086	Set the event trigger time to $tstamp and start the timer.
		1087
		1088	$timer = $timer->after ($delay)
		1089	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
805		1090
806	$timer = $timer->stop	1091	$timer = $timer->stop
807	Stop the timer.	1092	Stop the timer.
808		1093
809	The "urxvt::iow" Class	1094	The "urxvt::iow" Class
…		…
841	Start watching for requested events on the given handle.	1126	Start watching for requested events on the given handle.
842		1127
843	$iow = $iow->stop	1128	$iow = $iow->stop
844	Stop watching for events on the given filehandle.	1129	Stop watching for events on the given filehandle.
845		1130
		1131	The "urxvt::iw" Class
		1132	This class implements idle watchers, that get called automatically when
		1133	the process is idle. They should return as fast as possible, after doing
		1134	some useful work.
		1135
		1136	$iw = new urxvt::iw
		1137	Create a new idle watcher object in stopped state.
		1138
		1139	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1140	Set the callback to be called when the watcher triggers.
		1141
		1142	$timer = $timer->start
		1143	Start the watcher.
		1144
		1145	$timer = $timer->stop
		1146	Stop the watcher.
		1147
		1148	The "urxvt::pw" Class
		1149	This class implements process watchers. They create an event whenever a
		1150	process exits, after which they stop automatically.
		1151
		1152	my $pid = fork;
		1153	...
		1154	$term->{pw} = urxvt::pw
		1155	->new
		1156	->start ($pid)
		1157	->cb (sub {
		1158	my ($pw, $exit_status) = @_;
		1159	...
		1160	});
		1161
		1162	$pw = new urxvt::pw
		1163	Create a new process watcher in stopped state.
		1164
		1165	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1166	Set the callback to be called when the timer triggers.
		1167
		1168	$pw = $timer->start ($pid)
		1169	Tells the wqtcher to start watching for process $pid.
		1170
		1171	$pw = $pw->stop
		1172	Stop the watcher.
		1173
846	ENVIRONMENT	1174	ENVIRONMENT
847	URXVT_PERL_VERBOSITY	1175	URXVT_PERL_VERBOSITY
848	This variable controls the verbosity level of the perl extension. Higher	1176	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1177	numbers indicate more verbose output.
850		1178

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.37 by root, Wed Jan 25 21:48:47 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.37 by root, Wed Jan 25 21:48:47 2006 UTC