[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.41 by root, Tue Feb 21 01:00:40 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
50		79
51	option-popup (enabled by default)	80	option-popup (enabled by default)
52	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)	81	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
53	options at runtime.	82	options at runtime.
54		83
		84	Other extensions can extend this popup menu by pushing a code
		85	reference onto "@{ $term-"{option_popup_hook} }>, which gets called
		86	whenever the popup is being displayed.
		87
		88	It's sole argument is the popup menu, which can be modified. It
		89	should either return nothing or a string, the initial boolean value
		90	and a code reference. The string will be used as button text and the
		91	code reference will be called when the toggle changes, with the new
		92	boolean value as first argument.
		93
		94	The following will add an entry "myoption" that changes
		95	"$self-"{myoption}>:
		96
		97	push @{ $self->{term}{option_popup_hook} }, sub {
		98	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		99	};
		100
55	selection-popup (enabled by default)	101	selection-popup (enabled by default)
56	Binds a popup menu to Ctrl-Button3 that lets you convert the	102	Binds a popup menu to Ctrl-Button3 that lets you convert the
57	selection text into various other formats/action (such as uri	103	selection text into various other formats/action (such as uri
58	unescaping, perl evalution, web-browser starting etc.), depending on	104	unescaping, perl evaluation, web-browser starting etc.), depending
59	content.	105	on content.
		106
		107	Other extensions can extend this popup menu by pushing a code
		108	reference onto "@{ $term-"{selection_popup_hook} }>, which gets
		109	called whenever the popup is being displayed.
		110
		111	It's sole argument is the popup menu, which can be modified. The
		112	selection is in $_, which can be used to decide wether to add
		113	something or not. It should either return nothing or a string and a
		114	code reference. The string will be used as button text and the code
		115	reference will be called when the button gets activated and should
		116	transform $_.
		117
		118	The following will add an entry "a to b" that transforms all "a"s in
		119	the selection to "b"s, but only if the selection currently contains
		120	any "a"s:
		121
		122	push @{ $self->{term}{selection_popup_hook} }, sub {
		123	/a/ ? ("a to be" => sub { s/a/b/g }
		124	: ()
		125	};
60		126
61	searchable-scrollback<hotkey> (enabled by default)	127	searchable-scrollback<hotkey> (enabled by default)
62	Adds regex search functionality to the scrollback buffer, triggered	128	Adds regex search functionality to the scrollback buffer, triggered
63	by a hotkey (default: "M-s"). While in search mode, normal terminal	129	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	130	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	136	"End" jumps to the bottom. "Escape" leaves search mode and returns
71	to the point where search was started, while "Enter" or "Return"	137	to the point where search was started, while "Enter" or "Return"
72	stay at the current position and additionally stores the first match	138	stay at the current position and additionally stores the first match
73	in the current line into the primary selection.	139	in the current line into the primary selection.
74		140
75	digital-clock	141	readline (enabled by default)
76	Displays a digital clock using the built-in overlay.	142	A support package that tries to make editing with readline easier.
		143	At the moment, it reacts to clicking shift-left mouse button by
		144	trying to move the text cursor to this position. It does so by
		145	generating as many cursor-left or cursor-right keypresses as
		146	required (the this only works for programs that correctly support
		147	wide characters).
		148
		149	To avoid too many false positives, this is only done when:
		150
		151	- the tty is in ICANON state.
		152	- the text cursor is visible.
		153	- the primary screen is currently being displayed.
		154	- the mouse is on the same (multi-row-) line as the text cursor.
		155
		156	The normal selection mechanism isn't disabled, so quick successive
		157	clicks might interfere with selection creation in harmless ways.
		158
		159	selection-autotransform
		160	This selection allows you to do automatic transforms on a selection
		161	whenever a selection is made.
		162
		163	It works by specifying perl snippets (most useful is a single "s///"
		164	operator) that modify $_ as resources:
		165
		166	URxvt.selection-autotransform.0: transform
		167	URxvt.selection-autotransform.1: transform
		168	...
		169
		170	For example, the following will transform selections of the form
		171	"filename:number", often seen in compiler messages, into "vi
		172	+$filename $word":
		173
		174	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		175
		176	And this example matches the same,but replaces it with vi-commands
		177	you can paste directly into your (vi :) editor:
		178
		179	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		180
		181	Of course, this can be modified to suit your needs and your editor
		182	:)
		183
		184	To expand the example above to typical perl error messages ("XXX at
		185	FILENAME line YYY."), you need a slightly more elaborate solution:
		186
		187	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		188	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		189
		190	The first line tells the selection code to treat the unchanging part
		191	of every error message as a selection pattern, and the second line
		192	transforms the message into vi commands to load the file.
		193
		194	tabbed
		195	This transforms the terminal into a tabbar with additional
		196	terminals, that is, it implements what is commonly refered to as
		197	"tabbed terminal". The topmost line displays a "[NEW]" button,
		198	which, when clicked, will add a new tab, followed by one button per
		199	tab.
		200
		201	Clicking a button will activate that tab. Pressing Shift-Left and
		202	Shift-Right will switch to the tab left or right of the current one,
		203	while Shift-Down creates a new tab.
		204
		205	The tabbar itself can be configured similarly to a normal terminal,
		206	but with a resource class of "URxvt.tabbed". In addition, it
		207	supports the following four resources (shown with defaults):
		208
		209	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		210	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		211	URxvt.tabbed.tab-fg: <colour-index, default 0>
		212	URxvt.tabbed.tab-bg: <colour-index, default 1>
		213
		214	See COLOR AND GRAPHICS in the rxvt(1) manpage for valid indices.
77		215
78	mark-urls	216	mark-urls
79	Uses per-line display filtering ("on_line_update") to underline urls	217	Uses per-line display filtering ("on_line_update") to underline urls
80	and make them clickable. When middle-clicked, the program specified	218	and make them clickable. When middle-clicked, the program specified
81	in the resource "urlLauncher" (default "x-www-browser") will be	219	in the resource "urlLauncher" (default "x-www-browser") will be
82	started with the URL as first argument.	220	started with the URL as first argument.
83		221
		222	xim-onthespot
		223	This (experimental) perl extension implements OnTheSpot editing. It
		224	does not work perfectly, and some input methods don't seem to work
		225	well with OnTheSpot editing in general, but it seems to work at
		226	leats for SCIM and kinput2.
		227
		228	You enable it by specifying this extension and a preedit style of
		229	"OnTheSpot", i.e.:
		230
		231	rxvt -pt OnTheSpot -pe xim-onthespot
		232
		233	automove-background
		234	This is basically a one-line extension that dynamically changes the
		235	background pixmap offset to the window position, in effect creating
		236	the same effect as pseudo transparency with a custom pixmap. No
		237	scaling is supported in this mode. Exmaple:
		238
		239	rxvt -pixmap background.xpm -pe automove-background
		240
84	block-graphics-to-ascii	241	block-graphics-to-ascii
85	A not very useful example of filtering all text output to the	242	A not very useful example of filtering all text output to the
86	terminal, by replacing all line-drawing characters (U+2500 ..	243	terminal, by replacing all line-drawing characters (U+2500 ..
87	U+259F) by a similar-looking ascii character.	244	U+259F) by a similar-looking ascii character.
		245
		246	digital-clock
		247	Displays a digital clock using the built-in overlay.
		248
		249	remote-clipboard
		250	Somewhat of a misnomer, this extension adds two menu entries to the
		251	selection popup that allows one ti run external commands to store
		252	the selection somewhere and fetch it again.
		253
		254	We use it to implement a "distributed selection mechanism", which
		255	just means that one command uploads the file to a remote server, and
		256	another reads it.
		257
		258	The commands can be set using the "URxvt.remote-selection.store" and
		259	"URxvt.remote-selection.fetch" resources. The first should read the
		260	selection to store from STDIN (always in UTF-8), the second should
		261	provide the selection data on STDOUT (also in UTF-8).
		262
		263	The defaults (which are likely useless to you) use rsh and cat:
		264
		265	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		266	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		267
		268	selection-pastebin
		269	This is a little rarely useful extension that Uploads the selection
		270	as textfile to a remote site (or does other things). (The
		271	implementation is not currently secure for use in a multiuser
		272	environment as it writes to /tmp directly.).
		273
		274	It listens to the "selection-pastebin:remote-pastebin" keyboard
		275	command, i.e.
		276
		277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		278
		279	Pressing this combination runs a command with "%" replaced by the
		280	name of the textfile. This command can be set via a resource:
		281
		282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		283
		284	And the default is likely not useful to anybody but the few people
		285	around here :)
		286
		287	The name of the textfile is the hex encoded md5 sum of the
		288	selection, so the same content should lead to the same filename.
		289
		290	After a successful upload the selection will be replaced by the text
		291	given in the "selection-pastebin-url" resource (again, the % is the
		292	placeholder for the filename):
		293
		294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
88		295
89	example-refresh-hooks	296	example-refresh-hooks
90	Displays a very simple digital clock in the upper right corner of	297	Displays a very simple digital clock in the upper right corner of
91	the window. Illustrates overwriting the refresh callbacks to create	298	the window. Illustrates overwriting the refresh callbacks to create
92	your own overlays or changes.	299	your own overlays or changes.
…		…
151	be called whenever the relevant event happens.	358	be called whenever the relevant event happens.
152		359
153	The first argument passed to them is an extension oject as described in	360	The first argument passed to them is an extension oject as described in
154	the in the "Extension Objects" section.	361	the in the "Extension Objects" section.
155		362
156	All of these hooks must return a boolean value. If it is true, then the	363	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	364	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++	365	relevant action might not be carried out by the C++ code.
159	code.
160		366
161	When in doubt, return a false value (preferably "()").	367	When in doubt, return a false value (preferably "()").
162		368
163	on_init $term	369	on_init $term
164	Called after a new terminal object has been initialized, but before	370	Called after a new terminal object has been initialized, but before
165	windows are created or the command gets run. Most methods are unsafe	371	windows are created or the command gets run. Most methods are unsafe
166	to call or deliver senseless data, as terminal size and other	372	to call or deliver senseless data, as terminal size and other
167	characteristics have not yet been determined. You can safely query	373	characteristics have not yet been determined. You can safely query
168	and change resources, though.	374	and change resources and options, though. For many purposes the
		375	"on_start" hook is a better place.
		376
		377	on_start $term
		378	Called at the very end of initialisation of a new terminal, just
		379	before trying to map (display) the toplevel and returning to the
		380	mainloop.
		381
		382	on_destroy $term
		383	Called whenever something tries to destroy terminal, when the
		384	terminal is still fully functional (not for long, though).
169		385
170	on_reset $term	386	on_reset $term
171	Called after the screen is "reset" for any reason, such as resizing	387	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	388	or control sequences. Here is where you can react on changes to
173	size-related variables.	389	size-related variables.
174		390
175	on_start $term	391	on_child_start $term, $pid
176	Called at the very end of initialisation of a new terminal, just	392	Called just after the child process has been "fork"ed.
177	before returning to the mainloop.	393
		394	on_child_exit $term, $status
		395	Called just after the child process has exited. $status is the
		396	status from "waitpid".
178		397
179	on_sel_make $term, $eventtime	398	on_sel_make $term, $eventtime
180	Called whenever a selection has been made by the user, but before	399	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	400	the selection text is copied, so changes to the beginning, end or
182	type of the selection will be honored.	401	type of the selection will be honored.
…		…
262	display code is run after this hook, and takes precedence.	481	display code is run after this hook, and takes precedence.
263		482
264	on_refresh_end $term	483	on_refresh_end $term
265	Called just after the screen gets redrawn. See "on_refresh_begin".	484	Called just after the screen gets redrawn. See "on_refresh_begin".
266		485
267	on_keyboard_command $term, $string	486	on_user_command $term, $string
268	Called whenever the user presses a key combination that has a	487	Called whenever the a user-configured event is being activated (e.g.
269	"perl:string" action bound to it (see description of the keysym	488	via a "perl:string" action bound to a key, see description of the
270	resource in the rxvt(1) manpage).	489	keysym resource in the rxvt(1) manpage).
		490
		491	The event is simply the action string. This interface is assumed to
		492	change slightly in the future.
		493
		494	on_resize_all_windows $tern, $new_width, $new_height
		495	Called just after the new window size has been calculcated, but
		496	before windows are actually being resized or hints are being set. If
		497	this hook returns TRUE, setting of the window hints is being
		498	skipped.
		499
		500	on_x_event $term, $event
		501	Called on every X event received on the vt window (and possibly
		502	other windows). Should only be used as a last resort. Most event
		503	structure members are not passed.
271		504
272	on_focus_in $term	505	on_focus_in $term
273	Called whenever the window gets the keyboard focus, before	506	Called whenever the window gets the keyboard focus, before
274	rxvt-unicode does focus in processing.	507	rxvt-unicode does focus in processing.
275		508
276	on_focus_out $term	509	on_focus_out $term
277	Called wheneever the window loses keyboard focus, before	510	Called wheneever the window loses keyboard focus, before
278	rxvt-unicode does focus out processing.	511	rxvt-unicode does focus out processing.
279		512
		513	on_configure_notify $term, $event
		514	on_property_notify $term, $event
280	on_key_press $term, $event, $keysym, $octets	515	on_key_press $term, $event, $keysym, $octets
281	on_key_release $term, $event, $keysym	516	on_key_release $term, $event, $keysym
282	on_button_press $term, $event	517	on_button_press $term, $event
283	on_button_release $term, $event	518	on_button_release $term, $event
284	on_motion_notify $term, $event	519	on_motion_notify $term, $event
…		…
288	terminal If the hook returns true, then the even will be ignored by	523	terminal If the hook returns true, then the even will be ignored by
289	rxvt-unicode.	524	rxvt-unicode.
290		525
291	The event is a hash with most values as named by Xlib (see the	526	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	527	XEvent manpage), with the additional members "row" and "col", which
293	are the row and column under the mouse cursor.	528	are the (real, not screen-based) row and column under the mouse
		529	cursor.
294		530
295	"on_key_press" additionally receives the string rxvt-unicode would	531	"on_key_press" additionally receives the string rxvt-unicode would
296	output, if any, in locale-specific encoding.	532	output, if any, in locale-specific encoding.
297		533
298	subwindow.	534	subwindow.
		535
		536	on_client_message $term, $event
		537	on_wm_protocols $term, $event
		538	on_wm_delete_window $term, $event
		539	Called when various types of ClientMessage events are received (all
		540	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
299		541
300	Variables in the "urxvt" Package	542	Variables in the "urxvt" Package
301	$urxvt::LIBDIR	543	$urxvt::LIBDIR
302	The rxvt-unicode library directory, where, among other things, the	544	The rxvt-unicode library directory, where, among other things, the
303	perl modules and scripts are stored.	545	perl modules and scripts are stored.
…		…
310	The basename of the installed binaries, usually "urxvt".	552	The basename of the installed binaries, usually "urxvt".
311		553
312	$urxvt::TERM	554	$urxvt::TERM
313	The current terminal. This variable stores the current "urxvt::term"	555	The current terminal. This variable stores the current "urxvt::term"
314	object, whenever a callback/hook is executing.	556	object, whenever a callback/hook is executing.
		557
		558	@urxvt::TERM_INIT
		559	All coderefs in this array will be called as methods of the next
		560	newly created "urxvt::term" object (during the "on_init" phase). The
		561	array gets cleared before the codereferences that were in it are
		562	being executed, so coderefs can push themselves onto it again if
		563	they so desire.
		564
		565	This complements to the perl-eval commandline option, but gets
		566	executed first.
		567
		568	@urxvt::TERM_EXT
		569	Works similar to @TERM_INIT, but contains perl package/class names,
		570	which get registered as normal extensions after calling the hooks in
		571	@TERM_INIT but before other extensions. Gets cleared just like
		572	@TERM_INIT.
315		573
316	Functions in the "urxvt" Package	574	Functions in the "urxvt" Package
317	urxvt::fatal $errormessage	575	urxvt::fatal $errormessage
318	Fatally aborts execution with the given error message. Avoid at all	576	Fatally aborts execution with the given error message. Avoid at all
319	costs! The only time this is acceptable is when the terminal process	577	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	585	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.	586	correct place, e.g. on stderr of the connecting urxvtc client.
329		587
330	Messages have a size limit of 1023 bytes currently.	588	Messages have a size limit of 1023 bytes currently.
331		589
332	$is_safe = urxvt::safe	590	@terms = urxvt::termlist
333	Returns true when it is safe to do potentially unsafe things, such	591	Returns all urxvt::term objects that exist in this process,
334	as evaluating perl code specified by the user. This is true when	592	regardless of wether they are started, being destroyed etc., so be
335	urxvt was started setuid or setgid.	593	careful. Only term objects that have perl extensions attached will
		594	be returned (because there is no urxvt::term objet associated with
		595	others).
336		596
337	$time = urxvt::NOW	597	$time = urxvt::NOW
338	Returns the "current time" (as per the event loop).	598	Returns the "current time" (as per the event loop).
339		599
340	urxvt::CurrentTime	600	urxvt::CurrentTime
341	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	601	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
342	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	602	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
343	Button5Mask, AnyModifier	603	Button5Mask, AnyModifier
		604	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		605	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		606	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		607	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		608	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		609	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		610	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		611	ColormapChangeMask, OwnerGrabButtonMask
		612	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		613	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		614	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		615	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		616	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		617	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		618	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
344	Various constants for use in X calls and event processing.	619	Various constants for use in X calls and event processing.
345		620
346	RENDITION	621	RENDITION
347	Rendition bitsets contain information about colour, font, font styles	622	Rendition bitsets contain information about colour, font, font styles
348	and similar information for each screen cell.	623	and similar information for each screen cell.
…		…
369	$background = urxvt::GET_BASEBG $rend	644	$background = urxvt::GET_BASEBG $rend
370	Return the foreground/background colour index, respectively.	645	Return the foreground/background colour index, respectively.
371		646
372	$rend = urxvt::SET_FGCOLOR $rend, $new_colour	647	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
373	$rend = urxvt::SET_BGCOLOR $rend, $new_colour	648	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
		649	$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
374	Replace the foreground/background colour in the rendition mask with	650	Replace the foreground/background colour in the rendition mask with
375	the specified one.	651	the specified one.
376		652
377	$value = urxvt::GET_CUSTOM $rend	653	$value = urxvt::GET_CUSTOM $rend
378	Return the "custom" value: Every rendition has 5 bits for use by	654	Return the "custom" value: Every rendition has 5 bits for use by
…		…
397	%ENV-like hash which defines the environment of the new terminal.	673	%ENV-like hash which defines the environment of the new terminal.
398		674
399	Croaks (and probably outputs an error message) if the new instance	675	Croaks (and probably outputs an error message) if the new instance
400	couldn't be created. Returns "undef" if the new instance didn't	676	couldn't be created. Returns "undef" if the new instance didn't
401	initialise perl, and the terminal object otherwise. The "init" and	677	initialise perl, and the terminal object otherwise. The "init" and
402	"start" hooks will be called during this call.	678	"start" hooks will be called before this call returns, and are free
		679	to refer to global data (which is race free).
403		680
404	$term->destroy	681	$term->destroy
405	Destroy the terminal object (close the window, free resources etc.).	682	Destroy the terminal object (close the window, free resources etc.).
406	Please note that rxvt will not exit as long as any event watchers	683	Please note that rxvt will not exit as long as any event watchers
407	(timers, io watchers) are still active.	684	(timers, io watchers) are still active.
		685
		686	$term->exec_async ($cmd[, @args])
		687	Works like the combination of the "fork"/"exec" builtins, which
		688	executes ("starts") programs in the background. This function takes
		689	care of setting the user environment before exec'ing the command
		690	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		691	or "system".
		692
		693	Returns the pid of the subprocess or "undef" on error.
408		694
409	$isset = $term->option ($optval[, $set])	695	$isset = $term->option ($optval[, $set])
410	Returns true if the option specified by $optval is enabled, and	696	Returns true if the option specified by $optval is enabled, and
411	optionally change it. All option values are stored by name in the	697	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	698	hash %urxvt::OPTION. Options not enabled in this binary are not in
…		…
415	Here is a a likely non-exhaustive list of option names, please see	701	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:	702	the source file /src/optinc.h to see the actual list:
417		703
418	borderLess console cursorBlink cursorUnderline hold iconic insecure	704	borderLess console cursorBlink cursorUnderline hold iconic insecure
419	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	705	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
420	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	706	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
421	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	707	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
422	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	708	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
423	tripleclickwords utmpInhibit visualBell	709	transparent tripleclickwords utmpInhibit visualBell
424		710
425	$value = $term->resource ($name[, $newval])	711	$value = $term->resource ($name[, $newval])
426	Returns the current resource value associated with a given name and	712	Returns the current resource value associated with a given name and
427	optionally sets a new value. Setting values is most useful in the	713	optionally sets a new value. Setting values is most useful in the
428	"init" hook. Unset resources are returned and accepted as "undef".	714	"init" hook. Unset resources are returned and accepted as "undef".
…		…
445		731
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	732	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	733	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	734	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	735	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	736	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	737	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	738	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	739	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	740	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	741	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		742	secondaryScreen secondaryScroll selectstyle shade term_name title
456	shade term_name title transparent transparent_all tripleclickwords	743	transient_for transparent transparent_all tripleclickwords utmpInhibit
457	utmpInhibit visualBell	744	visualBell
458		745
459	$value = $term->x_resource ($pattern)	746	$value = $term->x_resource ($pattern)
460	Returns the X-Resource for the given pattern, excluding the program	747	Returns the X-Resource for the given pattern, excluding the program
461	or class name, i.e. "$term->x_resource ("boldFont")" should return	748	or class name, i.e. "$term->x_resource ("boldFont")" should return
462	the same value as used by this instance of rxvt-unicode. Returns	749	the same value as used by this instance of rxvt-unicode. Returns
…		…
573		860
574	Normally its not a good idea to use this function, as programs might	861	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	862	be confused by changes in cursor position or scrolling. Its useful
576	inside a "on_add_lines" hook, though.	863	inside a "on_add_lines" hook, though.
577		864
		865	$term->scr_change_screen ($screen)
		866	Switch to given screen - 0 primary, 1 secondary.
		867
578	$term->cmd_parse ($octets)	868	$term->cmd_parse ($octets)
579	Similar to "scr_add_lines", but the argument must be in the	869	Similar to "scr_add_lines", but the argument must be in the
580	locale-specific encoding of the terminal and can contain command	870	locale-specific encoding of the terminal and can contain command
581	sequences (escape codes) that will be interpreted.	871	sequences (escape codes) that will be interpreted.
582		872
…		…
590	Replaces the event mask of the pty watcher by the given event mask.	880	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.	881	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	882	See the description of "urxvt::timer->events". Make sure to always
593	restore the previous value.	883	restore the previous value.
594		884
		885	$fd = $term->pty_fd
		886	Returns the master file descriptor for the pty in use, or -1 if no
		887	pty is used.
		888
595	$windowid = $term->parent	889	$windowid = $term->parent
596	Return the window id of the toplevel window.	890	Return the window id of the toplevel window.
597		891
598	$windowid = $term->vt	892	$windowid = $term->vt
599	Return the window id of the terminal window.	893	Return the window id of the terminal window.
		894
		895	$term->vt_emask_add ($x_event_mask)
		896	Adds the specified events to the vt event mask. Useful e.g. when you
		897	want to receive pointer events all the times:
		898
		899	$term->vt_emask_add (urxvt::PointerMotionMask);
		900
		901	$term->focus_in
		902	$term->focus_out
		903	$term->key_press ($state, $keycode[, $time])
		904	$term->key_release ($state, $keycode[, $time])
		905	Deliver various fake events to to terminal.
600		906
601	$window_width = $term->width	907	$window_width = $term->width
602	$window_height = $term->height	908	$window_height = $term->height
603	$font_width = $term->fwidth	909	$font_width = $term->fwidth
604	$font_height = $term->fheight	910	$font_height = $term->fheight
…		…
607	$terminal_columns = $term->ncol	913	$terminal_columns = $term->ncol
608	$has_focus = $term->focus	914	$has_focus = $term->focus
609	$is_mapped = $term->mapped	915	$is_mapped = $term->mapped
610	$max_scrollback = $term->saveLines	916	$max_scrollback = $term->saveLines
611	$nrow_plus_saveLines = $term->total_rows	917	$nrow_plus_saveLines = $term->total_rows
612	$lines_in_scrollback = $term->nsaved	918	$topmost_scrollback_row = $term->top_row
613	Return various integers describing terminal characteristics.	919	Return various integers describing terminal characteristics.
614		920
615	$x_display = $term->display_id	921	$x_display = $term->display_id
616	Return the DISPLAY used by rxvt-unicode.	922	Return the DISPLAY used by rxvt-unicode.
617		923
…		…
619	Returns the LC_CTYPE category string used by this rxvt-unicode.	925	Returns the LC_CTYPE category string used by this rxvt-unicode.
620		926
621	$env = $term->env	927	$env = $term->env
622	Returns a copy of the environment in effect for the terminal as a	928	Returns a copy of the environment in effect for the terminal as a
623	hashref similar to "\%ENV".	929	hashref similar to "\%ENV".
		930
		931	@envv = $term->envv
		932	Returns the environment as array of strings of the form "VAR=VALUE".
		933
		934	@argv = $term->argv
		935	Return the argument vector as this terminal, similar to @ARGV, but
		936	includes the program name as first element.
624		937
625	$modifiermask = $term->ModLevel3Mask	938	$modifiermask = $term->ModLevel3Mask
626	$modifiermask = $term->ModMetaMask	939	$modifiermask = $term->ModMetaMask
627	$modifiermask = $term->ModNumLockMask	940	$modifiermask = $term->ModNumLockMask
628	Return the modifier masks corresponding to the "ISO Level 3 Shift"	941	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	942	(often AltGr), the meta key (often Alt) and the num lock key, if
630	applicable.	943	applicable.
631		944
		945	$screen = $term->current_screen
		946	Returns the currently displayed screen (0 primary, 1 secondary).
		947
		948	$cursor_is_hidden = $term->hidden_cursor
		949	Returns wether the cursor is currently hidden or not.
		950
632	$view_start = $term->view_start ([$newvalue])	951	$view_start = $term->view_start ([$newvalue])
633	Returns the negative row number of the topmost line. Minimum value	952	Returns the row number of the topmost displayed line. Maximum value
634	is 0, which displays the normal terminal contents. Larger values	953	is 0, which displays the normal terminal contents. Lower values
635	scroll this many lines into the scrollback buffer.	954	scroll this many lines into the scrollback buffer.
636		955
637	$term->want_refresh	956	$term->want_refresh
638	Requests a screen refresh. At the next opportunity, rxvt-unicode	957	Requests a screen refresh. At the next opportunity, rxvt-unicode
639	will compare the on-screen display with its stored representation.	958	will compare the on-screen display with its stored representation.
…		…
652	line, starting at column $start_col (default 0), which is useful to	971	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	972	replace only parts of a line. The font index in the rendition will
654	automatically be updated.	973	automatically be updated.
655		974
656	$text is in a special encoding: tabs and wide characters that use	975	$text is in a special encoding: tabs and wide characters that use
657	more than one cell when displayed are padded with urxvt::NOCHAR	976	more than one cell when displayed are padded with $urxvt::NOCHAR
658	characters ("chr 65535"). Characters with combining characters and	977	(chr 65535) characters. Characters with combining characters and
659	other characters that do not fit into the normal tetx encoding will	978	other characters that do not fit into the normal tetx encoding will
660	be replaced with characters in the private use area.	979	be replaced with characters in the private use area.
661		980
662	You have to obey this encoding when changing text. The advantage is	981	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	982	that "substr" and similar functions work on screen cells and not on
…		…
722		1041
723	$string = $term->special_decode $text	1042	$string = $term->special_decode $text
724	Converts rxvt-unicodes text reprsentation into a perl string. See	1043	Converts rxvt-unicodes text reprsentation into a perl string. See
725	"$term->ROW_t" for details.	1044	"$term->ROW_t" for details.
726		1045
727	$success = $term->grab_button ($button, $modifiermask)	1046	$success = $term->grab_button ($button, $modifiermask[, $window =
		1047	$term->vt])
		1048	$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
728	Registers a synchronous button grab. See the XGrabButton manpage.	1049	Register/unregister a synchronous button grab. See the XGrabButton
		1050	manpage.
729		1051
730	$success = $term->grab ($eventtime[, $sync])	1052	$success = $term->grab ($eventtime[, $sync])
731	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1053	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
732	synchronous ($sync is true). Also remembers the grab timestampe.	1054	synchronous ($sync is true). Also remembers the grab timestampe.
733		1055
…		…
744	$term->ungrab	1066	$term->ungrab
745	Calls XUngrab for the most recent grab. Is called automatically on	1067	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	1068	evaluation errors, as it is better to lose the grab in the error
747	case as the session.	1069	case as the session.
748		1070
		1071	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1072	$atom_name = $term->XGetAtomName ($atom)
		1073	@atoms = $term->XListProperties ($window)
		1074	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1075	$term->XChangeWindowProperty ($window, $property, $type, $format,
		1076	$octets)
		1077	$term->XDeleteProperty ($window, $property)
		1078	$window = $term->DefaultRootWindow
		1079	$term->XReparentWindow ($window, $parent, [$x, $y])
		1080	$term->XMapWindow ($window)
		1081	$term->XUnmapWindow ($window)
		1082	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1083	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1084	$y)
		1085	$term->XChangeInput ($window, $add_events[, $del_events])
		1086	Various X or X-related functions. The $term object only serves as
		1087	the source of the display, otherwise those functions map
		1088	more-or-less directory onto the X functions of the same name.
		1089
749	The "urxvt::popup" Class	1090	The "urxvt::popup" Class
750	$popup->add_title ($title)	1091	$popup->add_title ($title)
751	Adds a non-clickable title to the popup.	1092	Adds a non-clickable title to the popup.
752		1093
753	$popup->add_separator ([$sepchr])	1094	$popup->add_separator ([$sepchr])
…		…
756		1097
757	$popup->add_button ($text, $cb)	1098	$popup->add_button ($text, $cb)
758	Adds a clickable button to the popup. $cb is called whenever it is	1099	Adds a clickable button to the popup. $cb is called whenever it is
759	selected.	1100	selected.
760		1101
761	$popup->add_toggle ($text, $cb, $initial_value)	1102	$popup->add_toggle ($text, $initial_value, $cb)
762	Adds a toggle/checkbox item to the popup. Teh callback gets called	1103	Adds a toggle/checkbox item to the popup. The callback gets called
763	whenever it gets toggled, with a boolean indicating its value as its	1104	whenever it gets toggled, with a boolean indicating its new value as
764	first argument.	1105	its first argument.
765		1106
766	$popup->show	1107	$popup->show
767	Displays the popup (which is initially hidden).	1108	Displays the popup (which is initially hidden).
768		1109
769	The "urxvt::timer" Class	1110	The "urxvt::timer" Class
…		…
800	$timer = $timer->start	1141	$timer = $timer->start
801	Start the timer.	1142	Start the timer.
802		1143
803	$timer = $timer->start ($tstamp)	1144	$timer = $timer->start ($tstamp)
804	Set the event trigger time to $tstamp and start the timer.	1145	Set the event trigger time to $tstamp and start the timer.
		1146
		1147	$timer = $timer->after ($delay)
		1148	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
805		1149
806	$timer = $timer->stop	1150	$timer = $timer->stop
807	Stop the timer.	1151	Stop the timer.
808		1152
809	The "urxvt::iow" Class	1153	The "urxvt::iow" Class
…		…
841	Start watching for requested events on the given handle.	1185	Start watching for requested events on the given handle.
842		1186
843	$iow = $iow->stop	1187	$iow = $iow->stop
844	Stop watching for events on the given filehandle.	1188	Stop watching for events on the given filehandle.
845		1189
		1190	The "urxvt::iw" Class
		1191	This class implements idle watchers, that get called automatically when
		1192	the process is idle. They should return as fast as possible, after doing
		1193	some useful work.
		1194
		1195	$iw = new urxvt::iw
		1196	Create a new idle watcher object in stopped state.
		1197
		1198	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1199	Set the callback to be called when the watcher triggers.
		1200
		1201	$timer = $timer->start
		1202	Start the watcher.
		1203
		1204	$timer = $timer->stop
		1205	Stop the watcher.
		1206
		1207	The "urxvt::pw" Class
		1208	This class implements process watchers. They create an event whenever a
		1209	process exits, after which they stop automatically.
		1210
		1211	my $pid = fork;
		1212	...
		1213	$term->{pw} = urxvt::pw
		1214	->new
		1215	->start ($pid)
		1216	->cb (sub {
		1217	my ($pw, $exit_status) = @_;
		1218	...
		1219	});
		1220
		1221	$pw = new urxvt::pw
		1222	Create a new process watcher in stopped state.
		1223
		1224	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1225	Set the callback to be called when the timer triggers.
		1226
		1227	$pw = $timer->start ($pid)
		1228	Tells the wqtcher to start watching for process $pid.
		1229
		1230	$pw = $pw->stop
		1231	Stop the watcher.
		1232
846	ENVIRONMENT	1233	ENVIRONMENT
847	URXVT_PERL_VERBOSITY	1234	URXVT_PERL_VERBOSITY
848	This variable controls the verbosity level of the perl extension. Higher	1235	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1236	numbers indicate more verbose output.
850		1237

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.41 by root, Tue Feb 21 01:00:40 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.41 by root, Tue Feb 21 01:00:40 2006 UTC