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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC vs.
Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC

…		…
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		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
		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). Right	40	intelligent when the user extends selections (double-click and
37	now, it tries to select urls and complete shell-quoted arguments,	41	further clicks). Right now, it tries to select words, urls and
38	which is very convenient, too, if your ls supports	42	complete shell-quoted arguments, which is very convenient, too, if
39	"--quoting-style=shell".	43	your ls supports "--quoting-style=shell".
40		44
		45	A double-click usually selects the word under the cursor, further
		46	clicks will enlarge the selection.
		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
41	It also offers the following bindable keyboard command:	73	This extension also offers following bindable keyboard commands:
42		74
43	rot13	75	rot13
44	Rot-13 the selection when activated. Used via keyboard trigger:	76	Rot-13 the selection when activated. Used via keyboard trigger:
45		77
46	URxvt.keysym.C-M-r: perl:selection:rot13	78	URxvt.keysym.C-M-r: perl:selection:rot13
…		…
50	options at runtime.	82	options at runtime.
51		83
52	selection-popup (enabled by default)	84	selection-popup (enabled by default)
53	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
54	selection text into various other formats/action (such as uri	86	selection text into various other formats/action (such as uri
55	unescaping, perl evalution, web-browser starting etc.), depending on	87	unescaping, perl evaluation, web-browser starting etc.), depending
56	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	};
57		109
58	searchable-scrollback<hotkey> (enabled by default)	110	searchable-scrollback<hotkey> (enabled by default)
59	Adds regex search functionality to the scrollback buffer, triggered	111	Adds regex search functionality to the scrollback buffer, triggered
60	by a hotkey (default: "M-s"). When in search mode, normal terminal	112	by a hotkey (default: "M-s"). While in search mode, normal terminal
61	input/output is suspended.	113	input/output is suspended and a regex is displayed at the bottom of
		114	the screen.
62		115
63	"/" starts an incremental regex search, "n" searches further, "p" or	116	Inputting characters appends them to the regex and continues
64	"N" jump to the previous match, "G" jumps to the bottom and clears	117	incremental search. "BackSpace" removes a character from the regex,
65	the history, "enter" leaves search mode at the current position and	118	"Up" and "Down" search upwards/downwards in the scrollback buffer,
66	"escape" returns to the original position.	119	"End" jumps to the bottom. "Escape" leaves search mode and returns
		120	to the point where search was started, while "Enter" or "Return"
		121	stay at the current position and additionally stores the first match
		122	in the current line into the primary selection.
67		123
68	digital-clock	124	readline (enabled by default)
69	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.
		187
		188	The tabbar itself can be configured similarly to a normal terminal,
		189	but with a resource class of "URxvt.tabbed". In addition, it
		190	supports the following four resources (shown with defaults):
		191
		192	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		193	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		194	URxvt.tabbed.tab-fg: <colour-index, default 0>
		195	URxvt.tabbed.tab-bg: <colour-index, default 1>
		196
		197	See COLOR AND GRAPHICS in the rxvt(1) manpage for valid indices.
70		198
71	mark-urls	199	mark-urls
72	Uses per-line display filtering ("on_line_update") to underline urls	200	Uses per-line display filtering ("on_line_update") to underline urls
73	and make them clickable. When clicked, the program specified in the	201	and make them clickable. When middle-clicked, the program specified
74	resource "urlLauncher" (default "x-www-browser") will be started.	202	in the resource "urlLauncher" (default "x-www-browser") will be
		203	started with the URL as first argument.
		204
		205	xim-onthespot
		206	This (experimental) perl extension implements OnTheSpot editing. It
		207	does not work perfectly, and some input methods don't seem to work
		208	well with OnTheSpot editing in general, but it seems to work at
		209	leats for SCIM and kinput2.
		210
		211	You enable it by specifying this extension and a preedit style of
		212	"OnTheSpot", i.e.:
		213
		214	rxvt -pt OnTheSpot -pe xim-onthespot
		215
		216	automove-background
		217	This is basically a one-line extension that dynamically changes the
		218	background pixmap offset to the window position, in effect creating
		219	the same effect as pseudo transparency with a custom pixmap. No
		220	scaling is supported in this mode. Exmaple:
		221
		222	rxvt -pixmap background.xpm -pe automove-background
75		223
76	block-graphics-to-ascii	224	block-graphics-to-ascii
77	A not very useful example of filtering all text output to the	225	A not very useful example of filtering all text output to the
78	terminal, by replacing all line-drawing characters (U+2500 ..	226	terminal, by replacing all line-drawing characters (U+2500 ..
79	U+259F) by a similar-looking ascii character.	227	U+259F) by a similar-looking ascii character.
		228
		229	digital-clock
		230	Displays a digital clock using the built-in overlay.
		231
		232	remote-clipboard
		233	Somewhat of a misnomer, this extension adds two menu entries to the
		234	selection popup that allows one ti run external commands to store
		235	the selection somewhere and fetch it again.
		236
		237	We use it to implement a "distributed selection mechanism", which
		238	just means that one command uploads the file to a remote server, and
		239	another reads it.
		240
		241	The commands can be set using the "URxvt.remote-selection.store" and
		242	"URxvt.remote-selection.fetch" resources. The first should read the
		243	selection to store from STDIN (always in UTF-8), the second should
		244	provide the selection data on STDOUT (also in UTF-8).
		245
		246	The defaults (which are likely useless to you) use rsh and cat:
		247
		248	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		249	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		250
		251	selection-pastebin
		252	This is a little rarely useful extension that Uploads the selection
		253	as textfile to a remote site (or does other things). (The
		254	implementation is not currently secure for use in a multiuser
		255	environment as it writes to /tmp directly.).
		256
		257	It listens to the "selection-pastebin:remote-pastebin" keyboard
		258	command, i.e.
		259
		260	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		261
		262	Pressing this combination runs a command with "%" replaced by the
		263	name of the textfile. This command can be set via a resource:
		264
		265	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		266
		267	And the default is likely not useful to anybody but the few people
		268	around here :)
		269
		270	The name of the textfile is the hex encoded md5 sum of the
		271	selection, so the same content should lead to the same filename.
		272
		273	After a successful upload the selection will be replaced by the text
		274	given in the "selection-pastebin-url" resource (again, the % is the
		275	placeholder for the filename):
		276
		277	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
80		278
81	example-refresh-hooks	279	example-refresh-hooks
82	Displays a very simple digital clock in the upper right corner of	280	Displays a very simple digital clock in the upper right corner of
83	the window. Illustrates overwriting the refresh callbacks to create	281	the window. Illustrates overwriting the refresh callbacks to create
84	your own overlays or changes.	282	your own overlays or changes.
…		…
143	be called whenever the relevant event happens.	341	be called whenever the relevant event happens.
144		342
145	The first argument passed to them is an extension oject as described in	343	The first argument passed to them is an extension oject as described in
146	the in the "Extension Objects" section.	344	the in the "Extension Objects" section.
147		345
148	All of these hooks must return a boolean value. If it is true, then the	346	All of these hooks must return a boolean value. If any of the called
149	event counts as being consumed, and the invocation of other hooks is	347	hooks returns true, then the event counts as being consumed, and the
150	skipped, and the relevant action might not be carried out by the C++	348	relevant action might not be carried out by the C++ code.
151	code.
152		349
153	When in doubt, return a false value (preferably "()").	350	When in doubt, return a false value (preferably "()").
154		351
155	on_init $term	352	on_init $term
156	Called after a new terminal object has been initialized, but before	353	Called after a new terminal object has been initialized, but before
157	windows are created or the command gets run. Most methods are unsafe	354	windows are created or the command gets run. Most methods are unsafe
158	to call or deliver senseless data, as terminal size and other	355	to call or deliver senseless data, as terminal size and other
159	characteristics have not yet been determined. You can safely query	356	characteristics have not yet been determined. You can safely query
160	and change resources, though.	357	and change resources and options, though. For many purposes the
		358	"on_start" hook is a better place.
		359
		360	on_start $term
		361	Called at the very end of initialisation of a new terminal, just
		362	before trying to map (display) the toplevel and returning to the
		363	mainloop.
		364
		365	on_destroy $term
		366	Called whenever something tries to destroy terminal, when the
		367	terminal is still fully functional (not for long, though).
161		368
162	on_reset $term	369	on_reset $term
163	Called after the screen is "reset" for any reason, such as resizing	370	Called after the screen is "reset" for any reason, such as resizing
164	or control sequences. Here is where you can react on changes to	371	or control sequences. Here is where you can react on changes to
165	size-related variables.	372	size-related variables.
166		373
167	on_start $term	374	on_child_start $term, $pid
168	Called at the very end of initialisation of a new terminal, just	375	Called just after the child process has been "fork"ed.
169	before returning to the mainloop.	376
		377	on_child_exit $term, $status
		378	Called just after the child process has exited. $status is the
		379	status from "waitpid".
170		380
171	on_sel_make $term, $eventtime	381	on_sel_make $term, $eventtime
172	Called whenever a selection has been made by the user, but before	382	Called whenever a selection has been made by the user, but before
173	the selection text is copied, so changes to the beginning, end or	383	the selection text is copied, so changes to the beginning, end or
174	type of the selection will be honored.	384	type of the selection will be honored.
…		…
187		397
188	on_sel_extend $term	398	on_sel_extend $term
189	Called whenever the user tries to extend the selection (e.g. with a	399	Called whenever the user tries to extend the selection (e.g. with a
190	double click) and is either supposed to return false (normal	400	double click) and is either supposed to return false (normal
191	operation), or should extend the selection itelf and return true to	401	operation), or should extend the selection itelf and return true to
192	suppress the built-in processing.	402	suppress the built-in processing. This can happen multiple times, as
		403	long as the callback returns true, it will be called on every
		404	further click by the user and is supposed to enlarge the selection
		405	more and more, if possible.
193		406
194	See the selection example extension.	407	See the selection example extension.
195		408
196	on_view_change $term, $offset	409	on_view_change $term, $offset
197	Called whenever the view offset changes, i..e the user or program	410	Called whenever the view offset changes, i..e the user or program
…		…
251	display code is run after this hook, and takes precedence.	464	display code is run after this hook, and takes precedence.
252		465
253	on_refresh_end $term	466	on_refresh_end $term
254	Called just after the screen gets redrawn. See "on_refresh_begin".	467	Called just after the screen gets redrawn. See "on_refresh_begin".
255		468
256	on_keyboard_command $term, $string	469	on_user_command $term, $string
257	Called whenever the user presses a key combination that has a	470	Called whenever the a user-configured event is being activated (e.g.
258	"perl:string" action bound to it (see description of the keysym	471	via a "perl:string" action bound to a key, see description of the
259	resource in the rxvt(1) manpage).	472	keysym resource in the rxvt(1) manpage).
		473
		474	The event is simply the action string. This interface is assumed to
		475	change slightly in the future.
		476
		477	on_x_event $term, $event
		478	Called on every X event received on the vt window (and possibly
		479	other windows). Should only be used as a last resort. Most event
		480	structure members are not passed.
260		481
261	on_focus_in $term	482	on_focus_in $term
262	Called whenever the window gets the keyboard focus, before	483	Called whenever the window gets the keyboard focus, before
263	rxvt-unicode does focus in processing.	484	rxvt-unicode does focus in processing.
264		485
265	on_focus_out $term	486	on_focus_out $term
266	Called wheneever the window loses keyboard focus, before	487	Called wheneever the window loses keyboard focus, before
267	rxvt-unicode does focus out processing.	488	rxvt-unicode does focus out processing.
268		489
		490	on_configure_notify $term, $event
		491	on_property_notify $term, $event
269	on_key_press $term, $event, $keysym, $octets	492	on_key_press $term, $event, $keysym, $octets
270	on_key_release $term, $event, $keysym	493	on_key_release $term, $event, $keysym
271	on_button_press $term, $event	494	on_button_press $term, $event
272	on_button_release $term, $event	495	on_button_release $term, $event
273	on_motion_notify $term, $event	496	on_motion_notify $term, $event
…		…
277	terminal If the hook returns true, then the even will be ignored by	500	terminal If the hook returns true, then the even will be ignored by
278	rxvt-unicode.	501	rxvt-unicode.
279		502
280	The event is a hash with most values as named by Xlib (see the	503	The event is a hash with most values as named by Xlib (see the
281	XEvent manpage), with the additional members "row" and "col", which	504	XEvent manpage), with the additional members "row" and "col", which
282	are the row and column under the mouse cursor.	505	are the (real, not screen-based) row and column under the mouse
		506	cursor.
283		507
284	"on_key_press" additionally receives the string rxvt-unicode would	508	"on_key_press" additionally receives the string rxvt-unicode would
285	output, if any, in locale-specific encoding.	509	output, if any, in locale-specific encoding.
286		510
287	subwindow.	511	subwindow.
		512
		513	on_client_message $term, $event
		514	on_wm_protocols $term, $event
		515	on_wm_delete_window $term, $event
		516	Called when various types of ClientMessage events are received (all
		517	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
288		518
289	Variables in the "urxvt" Package	519	Variables in the "urxvt" Package
290	$urxvt::LIBDIR	520	$urxvt::LIBDIR
291	The rxvt-unicode library directory, where, among other things, the	521	The rxvt-unicode library directory, where, among other things, the
292	perl modules and scripts are stored.	522	perl modules and scripts are stored.
…		…
299	The basename of the installed binaries, usually "urxvt".	529	The basename of the installed binaries, usually "urxvt".
300		530
301	$urxvt::TERM	531	$urxvt::TERM
302	The current terminal. This variable stores the current "urxvt::term"	532	The current terminal. This variable stores the current "urxvt::term"
303	object, whenever a callback/hook is executing.	533	object, whenever a callback/hook is executing.
		534
		535	@urxvt::TERM_INIT
		536	All coderefs in this array will be called as methods of the next
		537	newly created "urxvt::term" object (during the "on_init" phase). The
		538	array gets cleared before the codereferences that were in it are
		539	being executed, so coderefs can push themselves onto it again if
		540	they so desire.
		541
		542	This complements to the perl-eval commandline option, but gets
		543	executed first.
		544
		545	@urxvt::TERM_EXT
		546	Works similar to @TERM_INIT, but contains perl package/class names,
		547	which get registered as normal extensions after calling the hooks in
		548	@TERM_INIT but before other extensions. Gets cleared just like
		549	@TERM_INIT.
304		550
305	Functions in the "urxvt" Package	551	Functions in the "urxvt" Package
306	urxvt::fatal $errormessage	552	urxvt::fatal $errormessage
307	Fatally aborts execution with the given error message. Avoid at all	553	Fatally aborts execution with the given error message. Avoid at all
308	costs! The only time this is acceptable is when the terminal process	554	costs! The only time this is acceptable is when the terminal process
…		…
316	Using this function has the advantage that its output ends up in the	562	Using this function has the advantage that its output ends up in the
317	correct place, e.g. on stderr of the connecting urxvtc client.	563	correct place, e.g. on stderr of the connecting urxvtc client.
318		564
319	Messages have a size limit of 1023 bytes currently.	565	Messages have a size limit of 1023 bytes currently.
320		566
321	$is_safe = urxvt::safe	567	@terms = urxvt::termlist
322	Returns true when it is safe to do potentially unsafe things, such	568	Returns all urxvt::term objects that exist in this process,
323	as evaluating perl code specified by the user. This is true when	569	regardless of wether they are started, being destroyed etc., so be
324	urxvt was started setuid or setgid.	570	careful. Only term objects that have perl extensions attached will
		571	be returned (because there is no urxvt::term objet associated with
		572	others).
325		573
326	$time = urxvt::NOW	574	$time = urxvt::NOW
327	Returns the "current time" (as per the event loop).	575	Returns the "current time" (as per the event loop).
328		576
329	urxvt::CurrentTime	577	urxvt::CurrentTime
330	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	578	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
331	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	579	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
332	Button5Mask, AnyModifier	580	Button5Mask, AnyModifier
		581	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		582	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		583	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		584	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		585	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		586	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		587	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		588	ColormapChangeMask, OwnerGrabButtonMask
		589	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		590	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		591	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		592	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		593	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		594	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		595	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
333	Various constants for use in X calls and event processing.	596	Various constants for use in X calls and event processing.
334		597
335	RENDITION	598	RENDITION
336	Rendition bitsets contain information about colour, font, font styles	599	Rendition bitsets contain information about colour, font, font styles
337	and similar information for each screen cell.	600	and similar information for each screen cell.
…		…
358	$background = urxvt::GET_BASEBG $rend	621	$background = urxvt::GET_BASEBG $rend
359	Return the foreground/background colour index, respectively.	622	Return the foreground/background colour index, respectively.
360		623
361	$rend = urxvt::SET_FGCOLOR $rend, $new_colour	624	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
362	$rend = urxvt::SET_BGCOLOR $rend, $new_colour	625	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
		626	$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
363	Replace the foreground/background colour in the rendition mask with	627	Replace the foreground/background colour in the rendition mask with
364	the specified one.	628	the specified one.
365		629
366	$value = urxvt::GET_CUSTOM $rend	630	$value = urxvt::GET_CUSTOM $rend
367	Return the "custom" value: Every rendition has 5 bits for use by	631	Return the "custom" value: Every rendition has 5 bits for use by
…		…
386	%ENV-like hash which defines the environment of the new terminal.	650	%ENV-like hash which defines the environment of the new terminal.
387		651
388	Croaks (and probably outputs an error message) if the new instance	652	Croaks (and probably outputs an error message) if the new instance
389	couldn't be created. Returns "undef" if the new instance didn't	653	couldn't be created. Returns "undef" if the new instance didn't
390	initialise perl, and the terminal object otherwise. The "init" and	654	initialise perl, and the terminal object otherwise. The "init" and
391	"start" hooks will be called during this call.	655	"start" hooks will be called before this call returns, and are free
		656	to refer to global data (which is race free).
392		657
393	$term->destroy	658	$term->destroy
394	Destroy the terminal object (close the window, free resources etc.).	659	Destroy the terminal object (close the window, free resources etc.).
395	Please note that rxvt will not exit as long as any event watchers	660	Please note that rxvt will not exit as long as any event watchers
396	(timers, io watchers) are still active.	661	(timers, io watchers) are still active.
		662
		663	$term->exec_async ($cmd[, @args])
		664	Works like the combination of the "fork"/"exec" builtins, which
		665	executes ("starts") programs in the background. This function takes
		666	care of setting the user environment before exec'ing the command
		667	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		668	or "system".
		669
		670	Returns the pid of the subprocess or "undef" on error.
397		671
398	$isset = $term->option ($optval[, $set])	672	$isset = $term->option ($optval[, $set])
399	Returns true if the option specified by $optval is enabled, and	673	Returns true if the option specified by $optval is enabled, and
400	optionally change it. All option values are stored by name in the	674	optionally change it. All option values are stored by name in the
401	hash %urxvt::OPTION. Options not enabled in this binary are not in	675	hash %urxvt::OPTION. Options not enabled in this binary are not in
…		…
404	Here is a a likely non-exhaustive list of option names, please see	678	Here is a a likely non-exhaustive list of option names, please see
405	the source file /src/optinc.h to see the actual list:	679	the source file /src/optinc.h to see the actual list:
406		680
407	borderLess console cursorBlink cursorUnderline hold iconic insecure	681	borderLess console cursorBlink cursorUnderline hold iconic insecure
408	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	682	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
409	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	683	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
410	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	684	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
411	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	685	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
412	tripleclickwords utmpInhibit visualBell	686	transparent tripleclickwords utmpInhibit visualBell
413		687
414	$value = $term->resource ($name[, $newval])	688	$value = $term->resource ($name[, $newval])
415	Returns the current resource value associated with a given name and	689	Returns the current resource value associated with a given name and
416	optionally sets a new value. Setting values is most useful in the	690	optionally sets a new value. Setting values is most useful in the
417	"init" hook. Unset resources are returned and accepted as "undef".	691	"init" hook. Unset resources are returned and accepted as "undef".
…		…
434		708
435	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	709	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
436	borderLess color cursorBlink cursorUnderline cutchars delete_key	710	borderLess color cursorBlink cursorUnderline cutchars delete_key
437	display_name embed ext_bwidth fade font geometry hold iconName	711	display_name embed ext_bwidth fade font geometry hold iconName
438	imFont imLocale inputMethod insecure int_bwidth intensityStyles	712	imFont imLocale inputMethod insecure int_bwidth intensityStyles
439	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	713	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
440	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	714	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
441	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	715	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
442	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	716	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
443	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	717	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
444	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	718	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		719	secondaryScreen secondaryScroll selectstyle shade term_name title
445	shade term_name title transparent transparent_all tripleclickwords	720	transient_for transparent transparent_all tripleclickwords utmpInhibit
446	utmpInhibit visualBell	721	visualBell
447		722
448	$value = $term->x_resource ($pattern)	723	$value = $term->x_resource ($pattern)
449	Returns the X-Resource for the given pattern, excluding the program	724	Returns the X-Resource for the given pattern, excluding the program
450	or class name, i.e. "$term->x_resource ("boldFont")" should return	725	or class name, i.e. "$term->x_resource ("boldFont")" should return
451	the same value as used by this instance of rxvt-unicode. Returns	726	the same value as used by this instance of rxvt-unicode. Returns
…		…
472	($row, $col) = $term->selection_beg ([$row, $col])	747	($row, $col) = $term->selection_beg ([$row, $col])
473	($row, $col) = $term->selection_end ([$row, $col])	748	($row, $col) = $term->selection_end ([$row, $col])
474	Return the current values of the selection mark, begin or end	749	Return the current values of the selection mark, begin or end
475	positions, and optionally set them to new values.	750	positions, and optionally set them to new values.
476		751
		752	$term->selection_make ($eventtime[, $rectangular])
		753	Tries to make a selection as set by "selection_beg" and
		754	"selection_end". If $rectangular is true (default: false), a
		755	rectangular selection will be made. This is the prefered function to
		756	make a selection.
		757
477	$success = $term->selection_grab ($eventtime)	758	$success = $term->selection_grab ($eventtime)
478	Try to request the primary selection from the server (for example,	759	Try to request the primary selection text from the server (for
479	as set by the next method).	760	example, as set by the next method). No visual feedback will be
		761	given. This function is mostly useful from within "on_sel_grab"
		762	hooks.
480		763
481	$oldtext = $term->selection ([$newtext])	764	$oldtext = $term->selection ([$newtext])
482	Return the current selection text and optionally replace it by	765	Return the current selection text and optionally replace it by
483	$newtext.	766	$newtext.
484		767
…		…
529	$string = $term->locale_decode ($octets)	812	$string = $term->locale_decode ($octets)
530	Convert the given locale-encoded octets into a perl string.	813	Convert the given locale-encoded octets into a perl string.
531		814
532	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	815	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
533	XORs the rendition values in the given span with the provided value	816	XORs the rendition values in the given span with the provided value
534	(default: "RS_RVid"). Useful in refresh hooks to provide effects	817	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
535	similar to the selection.	818	in refresh hooks to provide effects similar to the selection.
536		819
537	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,	820	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
538	$rstyle2]])	821	$rstyle2]])
539	Similar to "scr_xor_span", but xors a rectangle instead. Trailing	822	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
540	whitespace will additionally be xored with the $rstyle2, which	823	whitespace will additionally be xored with the $rstyle2, which
541	defaults to "RS_RVid \| RS_Uline", which removes reverse video again	824	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
542	and underlines it instead.	825	and underlines it instead. Both styles MUST NOT contain font
		826	styles.
543		827
544	$term->scr_bell	828	$term->scr_bell
545	Ring the bell!	829	Ring the bell!
546		830
547	$term->scr_add_lines ($string)	831	$term->scr_add_lines ($string)
…		…
553		837
554	Normally its not a good idea to use this function, as programs might	838	Normally its not a good idea to use this function, as programs might
555	be confused by changes in cursor position or scrolling. Its useful	839	be confused by changes in cursor position or scrolling. Its useful
556	inside a "on_add_lines" hook, though.	840	inside a "on_add_lines" hook, though.
557		841
		842	$term->scr_change_screen ($screen)
		843	Switch to given screen - 0 primary, 1 secondary.
		844
558	$term->cmd_parse ($octets)	845	$term->cmd_parse ($octets)
559	Similar to "scr_add_lines", but the argument must be in the	846	Similar to "scr_add_lines", but the argument must be in the
560	locale-specific encoding of the terminal and can contain command	847	locale-specific encoding of the terminal and can contain command
561	sequences (escape codes) that will be interpreted.	848	sequences (escape codes) that will be interpreted.
562		849
…		…
570	Replaces the event mask of the pty watcher by the given event mask.	857	Replaces the event mask of the pty watcher by the given event mask.
571	Can be used to suppress input and output handling to the pty/tty.	858	Can be used to suppress input and output handling to the pty/tty.
572	See the description of "urxvt::timer->events". Make sure to always	859	See the description of "urxvt::timer->events". Make sure to always
573	restore the previous value.	860	restore the previous value.
574		861
		862	$fd = $term->pty_fd
		863	Returns the master file descriptor for the pty in use, or -1 if no
		864	pty is used.
		865
575	$windowid = $term->parent	866	$windowid = $term->parent
576	Return the window id of the toplevel window.	867	Return the window id of the toplevel window.
577		868
578	$windowid = $term->vt	869	$windowid = $term->vt
579	Return the window id of the terminal window.	870	Return the window id of the terminal window.
		871
		872	$term->vt_emask_add ($x_event_mask)
		873	Adds the specified events to the vt event mask. Useful e.g. when you
		874	want to receive pointer events all the times:
		875
		876	$term->vt_emask_add (urxvt::PointerMotionMask);
		877
		878	$term->focus_in
		879	$term->focus_out
		880	$term->key_press ($state, $keycode[, $time])
		881	$term->key_release ($state, $keycode[, $time])
		882	Deliver various fake events to to terminal.
580		883
581	$window_width = $term->width	884	$window_width = $term->width
582	$window_height = $term->height	885	$window_height = $term->height
583	$font_width = $term->fwidth	886	$font_width = $term->fwidth
584	$font_height = $term->fheight	887	$font_height = $term->fheight
…		…
587	$terminal_columns = $term->ncol	890	$terminal_columns = $term->ncol
588	$has_focus = $term->focus	891	$has_focus = $term->focus
589	$is_mapped = $term->mapped	892	$is_mapped = $term->mapped
590	$max_scrollback = $term->saveLines	893	$max_scrollback = $term->saveLines
591	$nrow_plus_saveLines = $term->total_rows	894	$nrow_plus_saveLines = $term->total_rows
592	$lines_in_scrollback = $term->nsaved	895	$topmost_scrollback_row = $term->top_row
593	Return various integers describing terminal characteristics.	896	Return various integers describing terminal characteristics.
594		897
595	$x_display = $term->display_id	898	$x_display = $term->display_id
596	Return the DISPLAY used by rxvt-unicode.	899	Return the DISPLAY used by rxvt-unicode.
597		900
…		…
607	$modifiermask = $term->ModNumLockMask	910	$modifiermask = $term->ModNumLockMask
608	Return the modifier masks corresponding to the "ISO Level 3 Shift"	911	Return the modifier masks corresponding to the "ISO Level 3 Shift"
609	(often AltGr), the meta key (often Alt) and the num lock key, if	912	(often AltGr), the meta key (often Alt) and the num lock key, if
610	applicable.	913	applicable.
611		914
		915	$screen = $term->current_screen
		916	Returns the currently displayed screen (0 primary, 1 secondary).
		917
		918	$cursor_is_hidden = $term->hidden_cursor
		919	Returns wether the cursor is currently hidden or not.
		920
612	$view_start = $term->view_start ([$newvalue])	921	$view_start = $term->view_start ([$newvalue])
613	Returns the negative row number of the topmost line. Minimum value	922	Returns the row number of the topmost displayed line. Maximum value
614	is 0, which displays the normal terminal contents. Larger values	923	is 0, which displays the normal terminal contents. Lower values
615	scroll this many lines into the scrollback buffer.	924	scroll this many lines into the scrollback buffer.
616		925
617	$term->want_refresh	926	$term->want_refresh
618	Requests a screen refresh. At the next opportunity, rxvt-unicode	927	Requests a screen refresh. At the next opportunity, rxvt-unicode
619	will compare the on-screen display with its stored representation.	928	will compare the on-screen display with its stored representation.
…		…
632	line, starting at column $start_col (default 0), which is useful to	941	line, starting at column $start_col (default 0), which is useful to
633	replace only parts of a line. The font index in the rendition will	942	replace only parts of a line. The font index in the rendition will
634	automatically be updated.	943	automatically be updated.
635		944
636	$text is in a special encoding: tabs and wide characters that use	945	$text is in a special encoding: tabs and wide characters that use
637	more than one cell when displayed are padded with urxvt::NOCHAR	946	more than one cell when displayed are padded with $urxvt::NOCHAR
638	characters ("chr 65535"). Characters with combining characters and	947	(chr 65535) characters. Characters with combining characters and
639	other characters that do not fit into the normal tetx encoding will	948	other characters that do not fit into the normal tetx encoding will
640	be replaced with characters in the private use area.	949	be replaced with characters in the private use area.
641		950
642	You have to obey this encoding when changing text. The advantage is	951	You have to obey this encoding when changing text. The advantage is
643	that "substr" and similar functions work on screen cells and not on	952	that "substr" and similar functions work on screen cells and not on
…		…
687	Return the row number of the first/last row of the line,	996	Return the row number of the first/last row of the line,
688	respectively.	997	respectively.
689		998
690	$offset = $line->offset_of ($row, $col)	999	$offset = $line->offset_of ($row, $col)
691	Returns the character offset of the given row\|col pair within	1000	Returns the character offset of the given row\|col pair within
692	the logical line.	1001	the logical line. Works for rows outside the line, too, and
		1002	returns corresponding offsets outside the string.
693		1003
694	($row, $col) = $line->coord_of ($offset)	1004	($row, $col) = $line->coord_of ($offset)
695	Translates a string offset into terminal coordinates again.	1005	Translates a string offset into terminal coordinates again.
696		1006
697	$text = $term->special_encode $string	1007	$text = $term->special_encode $string
…		…
701		1011
702	$string = $term->special_decode $text	1012	$string = $term->special_decode $text
703	Converts rxvt-unicodes text reprsentation into a perl string. See	1013	Converts rxvt-unicodes text reprsentation into a perl string. See
704	"$term->ROW_t" for details.	1014	"$term->ROW_t" for details.
705		1015
706	$success = $term->grab_button ($button, $modifiermask)	1016	$success = $term->grab_button ($button, $modifiermask[, $window =
		1017	$term->vt])
		1018	$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
707	Registers a synchronous button grab. See the XGrabButton manpage.	1019	Register/unregister a synchronous button grab. See the XGrabButton
		1020	manpage.
708		1021
709	$success = $term->grab ($eventtime[, $sync])	1022	$success = $term->grab ($eventtime[, $sync])
710	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1023	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
711	synchronous ($sync is true). Also remembers the grab timestampe.	1024	synchronous ($sync is true). Also remembers the grab timestampe.
712		1025
…		…
722		1035
723	$term->ungrab	1036	$term->ungrab
724	Calls XUngrab for the most recent grab. Is called automatically on	1037	Calls XUngrab for the most recent grab. Is called automatically on
725	evaluation errors, as it is better to lose the grab in the error	1038	evaluation errors, as it is better to lose the grab in the error
726	case as the session.	1039	case as the session.
		1040
		1041	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1042	$atom_name = $term->XGetAtomName ($atom)
		1043	@atoms = $term->XListProperties ($window)
		1044	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1045	$term->XChangeWindowProperty ($window, $property, $type, $format,
		1046	$octets)
		1047	$term->XDeleteProperty ($window, $property)
		1048	$window = $term->DefaultRootWindow
		1049	$term->XReparentWindow ($window, $parent, [$x, $y])
		1050	$term->XMapWindow ($window)
		1051	$term->XUnmapWindow ($window)
		1052	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1053	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1054	$y)
		1055	$term->XChangeInput ($window, $add_events[, $del_events])
		1056	Various X or X-related functions. The $term object only serves as
		1057	the source of the display, otherwise those functions map
		1058	more-or-less directory onto the X functions of the same name.
727		1059
728	The "urxvt::popup" Class	1060	The "urxvt::popup" Class
729	$popup->add_title ($title)	1061	$popup->add_title ($title)
730	Adds a non-clickable title to the popup.	1062	Adds a non-clickable title to the popup.
731		1063
…		…
779	$timer = $timer->start	1111	$timer = $timer->start
780	Start the timer.	1112	Start the timer.
781		1113
782	$timer = $timer->start ($tstamp)	1114	$timer = $timer->start ($tstamp)
783	Set the event trigger time to $tstamp and start the timer.	1115	Set the event trigger time to $tstamp and start the timer.
		1116
		1117	$timer = $timer->after ($delay)
		1118	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
784		1119
785	$timer = $timer->stop	1120	$timer = $timer->stop
786	Stop the timer.	1121	Stop the timer.
787		1122
788	The "urxvt::iow" Class	1123	The "urxvt::iow" Class
…		…
820	Start watching for requested events on the given handle.	1155	Start watching for requested events on the given handle.
821		1156
822	$iow = $iow->stop	1157	$iow = $iow->stop
823	Stop watching for events on the given filehandle.	1158	Stop watching for events on the given filehandle.
824		1159
		1160	The "urxvt::iw" Class
		1161	This class implements idle watchers, that get called automatically when
		1162	the process is idle. They should return as fast as possible, after doing
		1163	some useful work.
		1164
		1165	$iw = new urxvt::iw
		1166	Create a new idle watcher object in stopped state.
		1167
		1168	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1169	Set the callback to be called when the watcher triggers.
		1170
		1171	$timer = $timer->start
		1172	Start the watcher.
		1173
		1174	$timer = $timer->stop
		1175	Stop the watcher.
		1176
		1177	The "urxvt::pw" Class
		1178	This class implements process watchers. They create an event whenever a
		1179	process exits, after which they stop automatically.
		1180
		1181	my $pid = fork;
		1182	...
		1183	$term->{pw} = urxvt::pw
		1184	->new
		1185	->start ($pid)
		1186	->cb (sub {
		1187	my ($pw, $exit_status) = @_;
		1188	...
		1189	});
		1190
		1191	$pw = new urxvt::pw
		1192	Create a new process watcher in stopped state.
		1193
		1194	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1195	Set the callback to be called when the timer triggers.
		1196
		1197	$pw = $timer->start ($pid)
		1198	Tells the wqtcher to start watching for process $pid.
		1199
		1200	$pw = $pw->stop
		1201	Stop the watcher.
		1202
825	ENVIRONMENT	1203	ENVIRONMENT
826	URXVT_PERL_VERBOSITY	1204	URXVT_PERL_VERBOSITY
827	This variable controls the verbosity level of the perl extension. Higher	1205	This variable controls the verbosity level of the perl extension. Higher
828	numbers indicate more verbose output.	1206	numbers indicate more verbose output.
829		1207
830	== 0 - fatal messages	1208	== 0 - fatal messages
831	>= 3 - script loading and management	1209	>= 3 - script loading and management
832	>=10 - all events received	1210	>=10 - all called hooks
		1211	>=11 - hook reutrn values
833		1212
834	AUTHOR	1213	AUTHOR
835	Marc Lehmann <pcg@goof.com>	1214	Marc Lehmann <pcg@goof.com>
836	http://software.schmorp.de/pkg/rxvt-unicode	1215	http://software.schmorp.de/pkg/rxvt-unicode
837		1216

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC vs. Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC vs.
Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC