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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.25 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.38 by root, Sun Jan 29 21:45:47 2006 UTC

…		…
28	can find them in /opt/rxvt/lib/urxvt/perl/.	28	can find them in /opt/rxvt/lib/urxvt/perl/.
29		29
30	You can activate them like this:	30	You can activate them like this:
31		31
32	rxvt -pe <extensionname>	32	rxvt -pe <extensionname>
		33
		34	Or by adding them to the resource for extensions loaded by default:
		35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
33		37
34	selection (enabled by default)	38	selection (enabled by default)
35	(More) intelligent selection. This extension tries to be more	39	(More) intelligent selection. This extension tries to be more
36	intelligent when the user extends selections (double-click and	40	intelligent when the user extends selections (double-click and
37	further clicks). Right now, it tries to select words, urls and	41	further clicks). Right now, it tries to select words, urls and
…		…
54	be used for the match. For example, the followign adds a regex that	58	be used for the match. For example, the followign adds a regex that
55	matches everything between two vertical bars:	59	matches everything between two vertical bars:
56		60
57	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	61	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
58		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
59	You can look at the source of the selection extension to see more	70	You can look at the source of the selection extension to see more
60	interesting uses, such as parsing a line from beginning to end.	71	interesting uses, such as parsing a line from beginning to end.
61		72
62	This extension also offers the following bindable keyboard command:	73	This extension also offers following bindable keyboard commands:
63		74
64	rot13	75	rot13
65	Rot-13 the selection when activated. Used via keyboard trigger:	76	Rot-13 the selection when activated. Used via keyboard trigger:
66		77
67	URxvt.keysym.C-M-r: perl:selection:rot13	78	URxvt.keysym.C-M-r: perl:selection:rot13
…		…
71	options at runtime.	82	options at runtime.
72		83
73	selection-popup (enabled by default)	84	selection-popup (enabled by default)
74	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
75	selection text into various other formats/action (such as uri	86	selection text into various other formats/action (such as uri
76	unescaping, perl evalution, web-browser starting etc.), depending on	87	unescaping, perl evaluation, web-browser starting etc.), depending
77	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	};
78		109
79	searchable-scrollback<hotkey> (enabled by default)	110	searchable-scrollback<hotkey> (enabled by default)
80	Adds regex search functionality to the scrollback buffer, triggered	111	Adds regex search functionality to the scrollback buffer, triggered
81	by a hotkey (default: "M-s"). While in search mode, normal terminal	112	by a hotkey (default: "M-s"). While in search mode, normal terminal
82	input/output is suspended and a regex is displayed at the bottom of	113	input/output is suspended and a regex is displayed at the bottom of
…		…
88	"End" jumps to the bottom. "Escape" leaves search mode and returns	119	"End" jumps to the bottom. "Escape" leaves search mode and returns
89	to the point where search was started, while "Enter" or "Return"	120	to the point where search was started, while "Enter" or "Return"
90	stay at the current position and additionally stores the first match	121	stay at the current position and additionally stores the first match
91	in the current line into the primary selection.	122	in the current line into the primary selection.
92		123
		124	readline (enabled by default)
		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
93	selection-autotransform	142	selection-autotransform
94	This selection allows you to do automatic transforms on a selection	143	This selection allows you to do automatic transforms on a selection
95	whenever a selection is made.	144	whenever a selection is made.
96		145
97	It works by specifying perl snippets (most useful is a single "s///"	146	It works by specifying perl snippets (most useful is a single "s///"
…		…
103		152
104	For example, the following will transform selections of the form	153	For example, the following will transform selections of the form
105	"filename:number", often seen in compiler messages, into "vi	154	"filename:number", often seen in compiler messages, into "vi
106	+$filename $word":	155	+$filename $word":
107		156
108	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	157	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
109		158
110	And this example matches the same,but replaces it with vi-commands	159	And this example matches the same,but replaces it with vi-commands
111	you can paste directly into your (vi :) editor:	160	you can paste directly into your (vi :) editor:
112		161
113	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	162	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
114		163
115	Of course, this can be modified to suit your needs and your editor	164	Of course, this can be modified to suit your needs and your editor
116	:)	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.
117		187
118	mark-urls	188	mark-urls
119	Uses per-line display filtering ("on_line_update") to underline urls	189	Uses per-line display filtering ("on_line_update") to underline urls
120	and make them clickable. When middle-clicked, the program specified	190	and make them clickable. When middle-clicked, the program specified
121	in the resource "urlLauncher" (default "x-www-browser") will be	191	in the resource "urlLauncher" (default "x-www-browser") will be
122	started with the URL as first argument.	192	started with the URL as first argument.
123		193
		194	xim-onthespot
		195	This (experimental) perl extension implements OnTheSpot editing. It
		196	does not work perfectly, and some input methods don't seem to work
		197	well with OnTheSpot editing in general, but it seems to work at
		198	leats for SCIM and kinput2.
		199
		200	You enable it by specifying this extension and a preedit style of
		201	"OnTheSpot", i.e.:
		202
		203	rxvt -pt OnTheSpot -pe xim-onthespot
		204
		205	automove-background
		206	This is basically a one-line extension that dynamically changes the
		207	background pixmap offset to the window position, in effect creating
		208	the same effect as pseudo transparency with a custom pixmap. No
		209	scaling is supported in this mode. Exmaple:
		210
		211	rxvt -pixmap background.xpm -pe automove-background
		212
124	block-graphics-to-ascii	213	block-graphics-to-ascii
125	A not very useful example of filtering all text output to the	214	A not very useful example of filtering all text output to the
126	terminal, by replacing all line-drawing characters (U+2500 ..	215	terminal, by replacing all line-drawing characters (U+2500 ..
127	U+259F) by a similar-looking ascii character.	216	U+259F) by a similar-looking ascii character.
128		217
129	digital-clock	218	digital-clock
130	Displays a digital clock using the built-in overlay.	219	Displays a digital clock using the built-in overlay.
		220
		221	remote-clipboard
		222	Somewhat of a misnomer, this extension adds two menu entries to the
		223	selection popup that allows one ti run external commands to store
		224	the selection somewhere and fetch it again.
		225
		226	We use it to implement a "distributed selection mechanism", which
		227	just means that one command uploads the file to a remote server, and
		228	another reads it.
		229
		230	The commands can be set using the "URxvt.remote-selection.store" and
		231	"URxvt.remote-selection.fetch" resources. The first should read the
		232	selection to store from STDIN (always in UTF-8), the second should
		233	provide the selection data on STDOUT (also in UTF-8).
		234
		235	The defaults (which are likely useless to you) use rsh and cat:
		236
		237	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		238	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		239
		240	selection-pastebin
		241	This is a little rarely useful extension that Uploads the selection
		242	as textfile to a remote site (or does other things). (The
		243	implementation is not currently secure for use in a multiuser
		244	environment as it writes to /tmp directly.).
		245
		246	It listens to the "selection-pastebin:remote-pastebin" keyboard
		247	command, i.e.
		248
		249	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		250
		251	Pressing this combination runs a command with "%" replaced by the
		252	name of the textfile. This command can be set via a resource:
		253
		254	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		255
		256	And the default is likely not useful to anybody but the few people
		257	around here :)
		258
		259	The name of the textfile is the hex encoded md5 sum of the
		260	selection, so the same content should lead to the same filename.
		261
		262	After a successful upload the selection will be replaced by the text
		263	given in the "selection-pastebin-url" resource (again, the % is the
		264	placeholder for the filename):
		265
		266	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
131		267
132	example-refresh-hooks	268	example-refresh-hooks
133	Displays a very simple digital clock in the upper right corner of	269	Displays a very simple digital clock in the upper right corner of
134	the window. Illustrates overwriting the refresh callbacks to create	270	the window. Illustrates overwriting the refresh callbacks to create
135	your own overlays or changes.	271	your own overlays or changes.
…		…
194	be called whenever the relevant event happens.	330	be called whenever the relevant event happens.
195		331
196	The first argument passed to them is an extension oject as described in	332	The first argument passed to them is an extension oject as described in
197	the in the "Extension Objects" section.	333	the in the "Extension Objects" section.
198		334
199	All of these hooks must return a boolean value. If it is true, then the	335	All of these hooks must return a boolean value. If any of the called
200	event counts as being consumed, and the invocation of other hooks is	336	hooks returns true, then the event counts as being consumed, and the
201	skipped, and the relevant action might not be carried out by the C++	337	relevant action might not be carried out by the C++ code.
202	code.
203		338
204	When in doubt, return a false value (preferably "()").	339	When in doubt, return a false value (preferably "()").
205		340
206	on_init $term	341	on_init $term
207	Called after a new terminal object has been initialized, but before	342	Called after a new terminal object has been initialized, but before
208	windows are created or the command gets run. Most methods are unsafe	343	windows are created or the command gets run. Most methods are unsafe
209	to call or deliver senseless data, as terminal size and other	344	to call or deliver senseless data, as terminal size and other
210	characteristics have not yet been determined. You can safely query	345	characteristics have not yet been determined. You can safely query
211	and change resources, though.	346	and change resources and options, though. For many purposes the
		347	"on_start" hook is a better place.
		348
		349	on_start $term
		350	Called at the very end of initialisation of a new terminal, just
		351	before trying to map (display) the toplevel and returning to the
		352	mainloop.
		353
		354	on_destroy $term
		355	Called whenever something tries to destroy terminal, when the
		356	terminal is still fully functional (not for long, though).
212		357
213	on_reset $term	358	on_reset $term
214	Called after the screen is "reset" for any reason, such as resizing	359	Called after the screen is "reset" for any reason, such as resizing
215	or control sequences. Here is where you can react on changes to	360	or control sequences. Here is where you can react on changes to
216	size-related variables.	361	size-related variables.
217		362
218	on_start $term	363	on_child_start $term, $pid
219	Called at the very end of initialisation of a new terminal, just	364	Called just after the child process has been "fork"ed.
220	before returning to the mainloop.	365
		366	on_child_exit $term, $status
		367	Called just after the child process has exited. $status is the
		368	status from "waitpid".
221		369
222	on_sel_make $term, $eventtime	370	on_sel_make $term, $eventtime
223	Called whenever a selection has been made by the user, but before	371	Called whenever a selection has been made by the user, but before
224	the selection text is copied, so changes to the beginning, end or	372	the selection text is copied, so changes to the beginning, end or
225	type of the selection will be honored.	373	type of the selection will be honored.
…		…
305	display code is run after this hook, and takes precedence.	453	display code is run after this hook, and takes precedence.
306		454
307	on_refresh_end $term	455	on_refresh_end $term
308	Called just after the screen gets redrawn. See "on_refresh_begin".	456	Called just after the screen gets redrawn. See "on_refresh_begin".
309		457
310	on_keyboard_command $term, $string	458	on_user_command $term, $string
311	Called whenever the user presses a key combination that has a	459	Called whenever the a user-configured event is being activated (e.g.
312	"perl:string" action bound to it (see description of the keysym	460	via a "perl:string" action bound to a key, see description of the
313	resource in the rxvt(1) manpage).	461	keysym resource in the rxvt(1) manpage).
		462
		463	The event is simply the action string. This interface is assumed to
		464	change slightly in the future.
		465
		466	on_x_event $term, $event
		467	Called on every X event received on the vt window (and possibly
		468	other windows). Should only be used as a last resort. Most event
		469	structure members are not passed.
314		470
315	on_focus_in $term	471	on_focus_in $term
316	Called whenever the window gets the keyboard focus, before	472	Called whenever the window gets the keyboard focus, before
317	rxvt-unicode does focus in processing.	473	rxvt-unicode does focus in processing.
318		474
319	on_focus_out $term	475	on_focus_out $term
320	Called wheneever the window loses keyboard focus, before	476	Called wheneever the window loses keyboard focus, before
321	rxvt-unicode does focus out processing.	477	rxvt-unicode does focus out processing.
322		478
		479	on_configure_notify $term, $event
		480	on_property_notify $term, $event
323	on_key_press $term, $event, $keysym, $octets	481	on_key_press $term, $event, $keysym, $octets
324	on_key_release $term, $event, $keysym	482	on_key_release $term, $event, $keysym
325	on_button_press $term, $event	483	on_button_press $term, $event
326	on_button_release $term, $event	484	on_button_release $term, $event
327	on_motion_notify $term, $event	485	on_motion_notify $term, $event
…		…
331	terminal If the hook returns true, then the even will be ignored by	489	terminal If the hook returns true, then the even will be ignored by
332	rxvt-unicode.	490	rxvt-unicode.
333		491
334	The event is a hash with most values as named by Xlib (see the	492	The event is a hash with most values as named by Xlib (see the
335	XEvent manpage), with the additional members "row" and "col", which	493	XEvent manpage), with the additional members "row" and "col", which
336	are the row and column under the mouse cursor.	494	are the (real, not screen-based) row and column under the mouse
		495	cursor.
337		496
338	"on_key_press" additionally receives the string rxvt-unicode would	497	"on_key_press" additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	498	output, if any, in locale-specific encoding.
340		499
341	subwindow.	500	subwindow.
		501
		502	on_client_message $term, $event
		503	on_wm_protocols $term, $event
		504	on_wm_delete_window $term, $event
		505	Called when various types of ClientMessage events are received (all
		506	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
342		507
343	Variables in the "urxvt" Package	508	Variables in the "urxvt" Package
344	$urxvt::LIBDIR	509	$urxvt::LIBDIR
345	The rxvt-unicode library directory, where, among other things, the	510	The rxvt-unicode library directory, where, among other things, the
346	perl modules and scripts are stored.	511	perl modules and scripts are stored.
…		…
353	The basename of the installed binaries, usually "urxvt".	518	The basename of the installed binaries, usually "urxvt".
354		519
355	$urxvt::TERM	520	$urxvt::TERM
356	The current terminal. This variable stores the current "urxvt::term"	521	The current terminal. This variable stores the current "urxvt::term"
357	object, whenever a callback/hook is executing.	522	object, whenever a callback/hook is executing.
		523
		524	@urxvt::TERM_INIT
		525	All coderefs in this array will be called as methods of the next
		526	newly created "urxvt::term" object (during the "on_init" phase). The
		527	array gets cleared before the codereferences that were in it are
		528	being executed, so coderefs can push themselves onto it again if
		529	they so desire.
		530
		531	This complements to the perl-eval commandline option, but gets
		532	executed first.
		533
		534	@urxvt::TERM_EXT
		535	Works similar to @TERM_INIT, but contains perl package/class names,
		536	which get registered as normal extensions after calling the hooks in
		537	@TERM_INIT but before other extensions. Gets cleared just like
		538	@TERM_INIT.
358		539
359	Functions in the "urxvt" Package	540	Functions in the "urxvt" Package
360	urxvt::fatal $errormessage	541	urxvt::fatal $errormessage
361	Fatally aborts execution with the given error message. Avoid at all	542	Fatally aborts execution with the given error message. Avoid at all
362	costs! The only time this is acceptable is when the terminal process	543	costs! The only time this is acceptable is when the terminal process
…		…
370	Using this function has the advantage that its output ends up in the	551	Using this function has the advantage that its output ends up in the
371	correct place, e.g. on stderr of the connecting urxvtc client.	552	correct place, e.g. on stderr of the connecting urxvtc client.
372		553
373	Messages have a size limit of 1023 bytes currently.	554	Messages have a size limit of 1023 bytes currently.
374		555
375	$is_safe = urxvt::safe	556	@terms = urxvt::termlist
376	Returns true when it is safe to do potentially unsafe things, such	557	Returns all urxvt::term objects that exist in this process,
377	as evaluating perl code specified by the user. This is true when	558	regardless of wether they are started, being destroyed etc., so be
378	urxvt was started setuid or setgid.	559	careful. Only term objects that have perl extensions attached will
		560	be returned (because there is no urxvt::term objet associated with
		561	others).
379		562
380	$time = urxvt::NOW	563	$time = urxvt::NOW
381	Returns the "current time" (as per the event loop).	564	Returns the "current time" (as per the event loop).
382		565
383	urxvt::CurrentTime	566	urxvt::CurrentTime
384	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	567	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
385	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	568	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
386	Button5Mask, AnyModifier	569	Button5Mask, AnyModifier
		570	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		571	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		572	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		573	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		574	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		575	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		576	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		577	ColormapChangeMask, OwnerGrabButtonMask
		578	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		579	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		580	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		581	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		582	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		583	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		584	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
387	Various constants for use in X calls and event processing.	585	Various constants for use in X calls and event processing.
388		586
389	RENDITION	587	RENDITION
390	Rendition bitsets contain information about colour, font, font styles	588	Rendition bitsets contain information about colour, font, font styles
391	and similar information for each screen cell.	589	and similar information for each screen cell.
…		…
440	%ENV-like hash which defines the environment of the new terminal.	638	%ENV-like hash which defines the environment of the new terminal.
441		639
442	Croaks (and probably outputs an error message) if the new instance	640	Croaks (and probably outputs an error message) if the new instance
443	couldn't be created. Returns "undef" if the new instance didn't	641	couldn't be created. Returns "undef" if the new instance didn't
444	initialise perl, and the terminal object otherwise. The "init" and	642	initialise perl, and the terminal object otherwise. The "init" and
445	"start" hooks will be called during this call.	643	"start" hooks will be called before this call returns, and are free
		644	to refer to global data (which is race free).
446		645
447	$term->destroy	646	$term->destroy
448	Destroy the terminal object (close the window, free resources etc.).	647	Destroy the terminal object (close the window, free resources etc.).
449	Please note that rxvt will not exit as long as any event watchers	648	Please note that rxvt will not exit as long as any event watchers
450	(timers, io watchers) are still active.	649	(timers, io watchers) are still active.
		650
		651	$term->exec_async ($cmd[, @args])
		652	Works like the combination of the "fork"/"exec" builtins, which
		653	executes ("starts") programs in the background. This function takes
		654	care of setting the user environment before exec'ing the command
		655	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		656	or "system".
		657
		658	Returns the pid of the subprocess or "undef" on error.
451		659
452	$isset = $term->option ($optval[, $set])	660	$isset = $term->option ($optval[, $set])
453	Returns true if the option specified by $optval is enabled, and	661	Returns true if the option specified by $optval is enabled, and
454	optionally change it. All option values are stored by name in the	662	optionally change it. All option values are stored by name in the
455	hash %urxvt::OPTION. Options not enabled in this binary are not in	663	hash %urxvt::OPTION. Options not enabled in this binary are not in
…		…
458	Here is a a likely non-exhaustive list of option names, please see	666	Here is a a likely non-exhaustive list of option names, please see
459	the source file /src/optinc.h to see the actual list:	667	the source file /src/optinc.h to see the actual list:
460		668
461	borderLess console cursorBlink cursorUnderline hold iconic insecure	669	borderLess console cursorBlink cursorUnderline hold iconic insecure
462	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	670	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
463	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	671	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
464	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	672	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
465	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	673	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
466	tripleclickwords utmpInhibit visualBell	674	transparent tripleclickwords utmpInhibit visualBell
467		675
468	$value = $term->resource ($name[, $newval])	676	$value = $term->resource ($name[, $newval])
469	Returns the current resource value associated with a given name and	677	Returns the current resource value associated with a given name and
470	optionally sets a new value. Setting values is most useful in the	678	optionally sets a new value. Setting values is most useful in the
471	"init" hook. Unset resources are returned and accepted as "undef".	679	"init" hook. Unset resources are returned and accepted as "undef".
…		…
488		696
489	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	697	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
490	borderLess color cursorBlink cursorUnderline cutchars delete_key	698	borderLess color cursorBlink cursorUnderline cutchars delete_key
491	display_name embed ext_bwidth fade font geometry hold iconName	699	display_name embed ext_bwidth fade font geometry hold iconName
492	imFont imLocale inputMethod insecure int_bwidth intensityStyles	700	imFont imLocale inputMethod insecure int_bwidth intensityStyles
493	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	701	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
494	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	702	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
495	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	703	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
496	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	704	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
497	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	705	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
498	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	706	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		707	secondaryScreen secondaryScroll selectstyle shade term_name title
499	shade term_name title transparent transparent_all tripleclickwords	708	transient_for transparent transparent_all tripleclickwords utmpInhibit
500	utmpInhibit visualBell	709	visualBell
501		710
502	$value = $term->x_resource ($pattern)	711	$value = $term->x_resource ($pattern)
503	Returns the X-Resource for the given pattern, excluding the program	712	Returns the X-Resource for the given pattern, excluding the program
504	or class name, i.e. "$term->x_resource ("boldFont")" should return	713	or class name, i.e. "$term->x_resource ("boldFont")" should return
505	the same value as used by this instance of rxvt-unicode. Returns	714	the same value as used by this instance of rxvt-unicode. Returns
…		…
616		825
617	Normally its not a good idea to use this function, as programs might	826	Normally its not a good idea to use this function, as programs might
618	be confused by changes in cursor position or scrolling. Its useful	827	be confused by changes in cursor position or scrolling. Its useful
619	inside a "on_add_lines" hook, though.	828	inside a "on_add_lines" hook, though.
620		829
		830	$term->scr_change_screen ($screen)
		831	Switch to given screen - 0 primary, 1 secondary.
		832
621	$term->cmd_parse ($octets)	833	$term->cmd_parse ($octets)
622	Similar to "scr_add_lines", but the argument must be in the	834	Similar to "scr_add_lines", but the argument must be in the
623	locale-specific encoding of the terminal and can contain command	835	locale-specific encoding of the terminal and can contain command
624	sequences (escape codes) that will be interpreted.	836	sequences (escape codes) that will be interpreted.
625		837
…		…
633	Replaces the event mask of the pty watcher by the given event mask.	845	Replaces the event mask of the pty watcher by the given event mask.
634	Can be used to suppress input and output handling to the pty/tty.	846	Can be used to suppress input and output handling to the pty/tty.
635	See the description of "urxvt::timer->events". Make sure to always	847	See the description of "urxvt::timer->events". Make sure to always
636	restore the previous value.	848	restore the previous value.
637		849
		850	$fd = $term->pty_fd
		851	Returns the master file descriptor for the pty in use, or -1 if no
		852	pty is used.
		853
638	$windowid = $term->parent	854	$windowid = $term->parent
639	Return the window id of the toplevel window.	855	Return the window id of the toplevel window.
640		856
641	$windowid = $term->vt	857	$windowid = $term->vt
642	Return the window id of the terminal window.	858	Return the window id of the terminal window.
		859
		860	$term->vt_emask_add ($x_event_mask)
		861	Adds the specified events to the vt event mask. Useful e.g. when you
		862	want to receive pointer events all the times:
		863
		864	$term->vt_emask_add (urxvt::PointerMotionMask);
643		865
644	$window_width = $term->width	866	$window_width = $term->width
645	$window_height = $term->height	867	$window_height = $term->height
646	$font_width = $term->fwidth	868	$font_width = $term->fwidth
647	$font_height = $term->fheight	869	$font_height = $term->fheight
…		…
650	$terminal_columns = $term->ncol	872	$terminal_columns = $term->ncol
651	$has_focus = $term->focus	873	$has_focus = $term->focus
652	$is_mapped = $term->mapped	874	$is_mapped = $term->mapped
653	$max_scrollback = $term->saveLines	875	$max_scrollback = $term->saveLines
654	$nrow_plus_saveLines = $term->total_rows	876	$nrow_plus_saveLines = $term->total_rows
655	$lines_in_scrollback = $term->nsaved	877	$topmost_scrollback_row = $term->top_row
656	Return various integers describing terminal characteristics.	878	Return various integers describing terminal characteristics.
657		879
658	$x_display = $term->display_id	880	$x_display = $term->display_id
659	Return the DISPLAY used by rxvt-unicode.	881	Return the DISPLAY used by rxvt-unicode.
660		882
…		…
670	$modifiermask = $term->ModNumLockMask	892	$modifiermask = $term->ModNumLockMask
671	Return the modifier masks corresponding to the "ISO Level 3 Shift"	893	Return the modifier masks corresponding to the "ISO Level 3 Shift"
672	(often AltGr), the meta key (often Alt) and the num lock key, if	894	(often AltGr), the meta key (often Alt) and the num lock key, if
673	applicable.	895	applicable.
674		896
		897	$screen = $term->current_screen
		898	Returns the currently displayed screen (0 primary, 1 secondary).
		899
		900	$cursor_is_hidden = $term->hidden_cursor
		901	Returns wether the cursor is currently hidden or not.
		902
675	$view_start = $term->view_start ([$newvalue])	903	$view_start = $term->view_start ([$newvalue])
676	Returns the negative row number of the topmost line. Minimum value	904	Returns the row number of the topmost displayed line. Maximum value
677	is 0, which displays the normal terminal contents. Larger values	905	is 0, which displays the normal terminal contents. Lower values
678	scroll this many lines into the scrollback buffer.	906	scroll this many lines into the scrollback buffer.
679		907
680	$term->want_refresh	908	$term->want_refresh
681	Requests a screen refresh. At the next opportunity, rxvt-unicode	909	Requests a screen refresh. At the next opportunity, rxvt-unicode
682	will compare the on-screen display with its stored representation.	910	will compare the on-screen display with its stored representation.
…		…
695	line, starting at column $start_col (default 0), which is useful to	923	line, starting at column $start_col (default 0), which is useful to
696	replace only parts of a line. The font index in the rendition will	924	replace only parts of a line. The font index in the rendition will
697	automatically be updated.	925	automatically be updated.
698		926
699	$text is in a special encoding: tabs and wide characters that use	927	$text is in a special encoding: tabs and wide characters that use
700	more than one cell when displayed are padded with urxvt::NOCHAR	928	more than one cell when displayed are padded with $urxvt::NOCHAR
701	characters ("chr 65535"). Characters with combining characters and	929	(chr 65535) characters. Characters with combining characters and
702	other characters that do not fit into the normal tetx encoding will	930	other characters that do not fit into the normal tetx encoding will
703	be replaced with characters in the private use area.	931	be replaced with characters in the private use area.
704		932
705	You have to obey this encoding when changing text. The advantage is	933	You have to obey this encoding when changing text. The advantage is
706	that "substr" and similar functions work on screen cells and not on	934	that "substr" and similar functions work on screen cells and not on
…		…
765		993
766	$string = $term->special_decode $text	994	$string = $term->special_decode $text
767	Converts rxvt-unicodes text reprsentation into a perl string. See	995	Converts rxvt-unicodes text reprsentation into a perl string. See
768	"$term->ROW_t" for details.	996	"$term->ROW_t" for details.
769		997
770	$success = $term->grab_button ($button, $modifiermask)	998	$success = $term->grab_button ($button, $modifiermask[, $window =
		999	$term->vt])
		1000	$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
771	Registers a synchronous button grab. See the XGrabButton manpage.	1001	Register/unregister a synchronous button grab. See the XGrabButton
		1002	manpage.
772		1003
773	$success = $term->grab ($eventtime[, $sync])	1004	$success = $term->grab ($eventtime[, $sync])
774	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1005	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
775	synchronous ($sync is true). Also remembers the grab timestampe.	1006	synchronous ($sync is true). Also remembers the grab timestampe.
776		1007
…		…
786		1017
787	$term->ungrab	1018	$term->ungrab
788	Calls XUngrab for the most recent grab. Is called automatically on	1019	Calls XUngrab for the most recent grab. Is called automatically on
789	evaluation errors, as it is better to lose the grab in the error	1020	evaluation errors, as it is better to lose the grab in the error
790	case as the session.	1021	case as the session.
		1022
		1023	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1024	$atom_name = $term->XGetAtomName ($atom)
		1025	@atoms = $term->XListProperties ($window)
		1026	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1027	$term->XChangeWindowProperty ($window, $property, $type, $format,
		1028	$octets)
		1029	$term->XDeleteProperty ($window, $property)
		1030	$window = $term->DefaultRootWindow
		1031	$term->XReparentWindow ($window, $parent, [$x, $y])
		1032	$term->XMapWindow ($window)
		1033	$term->XUnmapWindow ($window)
		1034	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1035	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1036	$y)
		1037	$term->XChangeInput ($window, $add_events[, $del_events])
		1038	Various X or X-related functions. The $term object only serves as
		1039	the source of the display, otherwise those functions map
		1040	more-or-less directory onto the X functions of the same name.
791		1041
792	The "urxvt::popup" Class	1042	The "urxvt::popup" Class
793	$popup->add_title ($title)	1043	$popup->add_title ($title)
794	Adds a non-clickable title to the popup.	1044	Adds a non-clickable title to the popup.
795		1045
…		…
843	$timer = $timer->start	1093	$timer = $timer->start
844	Start the timer.	1094	Start the timer.
845		1095
846	$timer = $timer->start ($tstamp)	1096	$timer = $timer->start ($tstamp)
847	Set the event trigger time to $tstamp and start the timer.	1097	Set the event trigger time to $tstamp and start the timer.
		1098
		1099	$timer = $timer->after ($delay)
		1100	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
848		1101
849	$timer = $timer->stop	1102	$timer = $timer->stop
850	Stop the timer.	1103	Stop the timer.
851		1104
852	The "urxvt::iow" Class	1105	The "urxvt::iow" Class
…		…
884	Start watching for requested events on the given handle.	1137	Start watching for requested events on the given handle.
885		1138
886	$iow = $iow->stop	1139	$iow = $iow->stop
887	Stop watching for events on the given filehandle.	1140	Stop watching for events on the given filehandle.
888		1141
		1142	The "urxvt::iw" Class
		1143	This class implements idle watchers, that get called automatically when
		1144	the process is idle. They should return as fast as possible, after doing
		1145	some useful work.
		1146
		1147	$iw = new urxvt::iw
		1148	Create a new idle watcher object in stopped state.
		1149
		1150	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1151	Set the callback to be called when the watcher triggers.
		1152
		1153	$timer = $timer->start
		1154	Start the watcher.
		1155
		1156	$timer = $timer->stop
		1157	Stop the watcher.
		1158
		1159	The "urxvt::pw" Class
		1160	This class implements process watchers. They create an event whenever a
		1161	process exits, after which they stop automatically.
		1162
		1163	my $pid = fork;
		1164	...
		1165	$term->{pw} = urxvt::pw
		1166	->new
		1167	->start ($pid)
		1168	->cb (sub {
		1169	my ($pw, $exit_status) = @_;
		1170	...
		1171	});
		1172
		1173	$pw = new urxvt::pw
		1174	Create a new process watcher in stopped state.
		1175
		1176	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1177	Set the callback to be called when the timer triggers.
		1178
		1179	$pw = $timer->start ($pid)
		1180	Tells the wqtcher to start watching for process $pid.
		1181
		1182	$pw = $pw->stop
		1183	Stop the watcher.
		1184
889	ENVIRONMENT	1185	ENVIRONMENT
890	URXVT_PERL_VERBOSITY	1186	URXVT_PERL_VERBOSITY
891	This variable controls the verbosity level of the perl extension. Higher	1187	This variable controls the verbosity level of the perl extension. Higher
892	numbers indicate more verbose output.	1188	numbers indicate more verbose output.
893		1189

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.25 by root, Thu Jan 12 12:15:10 2006 UTC vs. Revision 1.38 by root, Sun Jan 29 21:45:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.25 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.38 by root, Sun Jan 29 21:45:47 2006 UTC