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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC vs.
Revision 1.37 by root, Wed Jan 25 21:48:47 2006 UTC

…		…
28	can find them in /opt/rxvt/lib/urxvt/perl/.	28	can find them in /opt/rxvt/lib/urxvt/perl/.
29		29
30	You can activate them like this:	30	You can activate them like this:
31		31
32	rxvt -pe <extensionname>	32	rxvt -pe <extensionname>
		33
		34	Or by adding them to the resource for extensions loaded by default:
		35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
33		37
34	selection (enabled by default)	38	selection (enabled by default)
35	(More) intelligent selection. This extension tries to be more	39	(More) intelligent selection. This extension tries to be more
36	intelligent when the user extends selections (double-click and	40	intelligent when the user extends selections (double-click and
37	further clicks). Right now, it tries to select words, urls and	41	further clicks). Right now, it tries to select words, urls and
…		…
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 following bindable keyboard commands:	73	This extension also offers following bindable keyboard commands:
63		74
…		…
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///"
…		…
108	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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	:)
117		166
118	To expand the example above to typical perl error messages ("XXX at	167	To expand the example above to typical perl error messages ("XXX at
119	FILENAME line YYY."), you need a slightly more elaborate solution:	168	FILENAME line YYY."), you need a slightly more elaborate solution:
120		169
121	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	170	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
122	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	171	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
123		172
124	The first line tells the selection code to treat the unchanging part	173	The first line tells the selection code to treat the unchanging part
125	of every error message as a selection pattern, and the second line	174	of every error message as a selection pattern, and the second line
126	transforms the message into vi commands to load the file.	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.
127		187
128	mark-urls	188	mark-urls
129	Uses per-line display filtering ("on_line_update") to underline urls	189	Uses per-line display filtering ("on_line_update") to underline urls
130	and make them clickable. When middle-clicked, the program specified	190	and make them clickable. When middle-clicked, the program specified
131	in the resource "urlLauncher" (default "x-www-browser") will be	191	in the resource "urlLauncher" (default "x-www-browser") will be
132	started with the URL as first argument.	192	started with the URL as first argument.
133		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
134	block-graphics-to-ascii	213	block-graphics-to-ascii
135	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
136	terminal, by replacing all line-drawing characters (U+2500 ..	215	terminal, by replacing all line-drawing characters (U+2500 ..
137	U+259F) by a similar-looking ascii character.	216	U+259F) by a similar-looking ascii character.
138		217
139	digital-clock	218	digital-clock
140	Displays a digital clock using the built-in overlay.	219	Displays a digital clock using the built-in overlay.
141		220
142	example-refresh-hooks	221	remote-clipboard
143	Displays a very simple digital clock in the upper right corner of	222	Somewhat of a misnomer, this extension adds two menu entries to the
144	the window. Illustrates overwriting the refresh callbacks to create	223	selection popup that allows one ti run external commands to store
145	your own overlays or changes.	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'
146		239
147	selection-pastebin	240	selection-pastebin
148	This is a little rarely useful extension that Uploads the selection	241	This is a little rarely useful extension that Uploads the selection
149	as textfile to a remote site (or does other things). (The	242	as textfile to a remote site (or does other things). (The
150	implementation is not currently secure for use in a multiuser	243	implementation is not currently secure for use in a multiuser
…		…
169	After a successful upload the selection will be replaced by the text	262	After a successful upload the selection will be replaced by the text
170	given in the "selection-pastebin-url" resource (again, the % is the	263	given in the "selection-pastebin-url" resource (again, the % is the
171	placeholder for the filename):	264	placeholder for the filename):
172		265
173	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	266	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		267
		268	example-refresh-hooks
		269	Displays a very simple digital clock in the upper right corner of
		270	the window. Illustrates overwriting the refresh callbacks to create
		271	your own overlays or changes.
174		272
175	API DOCUMENTATION	273	API DOCUMENTATION
176	General API Considerations	274	General API Considerations
177	All objects (such as terminals, time watchers etc.) are typical	275	All objects (such as terminals, time watchers etc.) are typical
178	reference-to-hash objects. The hash can be used to store anything you	276	reference-to-hash objects. The hash can be used to store anything you
…		…
232	be called whenever the relevant event happens.	330	be called whenever the relevant event happens.
233		331
234	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
235	the in the "Extension Objects" section.	333	the in the "Extension Objects" section.
236		334
237	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
238	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
239	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.
240	code.
241		338
242	When in doubt, return a false value (preferably "()").	339	When in doubt, return a false value (preferably "()").
243		340
244	on_init $term	341	on_init $term
245	Called after a new terminal object has been initialized, but before	342	Called after a new terminal object has been initialized, but before
246	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
247	to call or deliver senseless data, as terminal size and other	344	to call or deliver senseless data, as terminal size and other
248	characteristics have not yet been determined. You can safely query	345	characteristics have not yet been determined. You can safely query
249	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).
250		357
251	on_reset $term	358	on_reset $term
252	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
253	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
254	size-related variables.	361	size-related variables.
255		362
256	on_start $term	363	on_child_start $term, $pid
257	Called at the very end of initialisation of a new terminal, just	364	Called just after the child process has been "fork"ed.
258	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".
259		369
260	on_sel_make $term, $eventtime	370	on_sel_make $term, $eventtime
261	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
262	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
263	type of the selection will be honored.	373	type of the selection will be honored.
…		…
343	display code is run after this hook, and takes precedence.	453	display code is run after this hook, and takes precedence.
344		454
345	on_refresh_end $term	455	on_refresh_end $term
346	Called just after the screen gets redrawn. See "on_refresh_begin".	456	Called just after the screen gets redrawn. See "on_refresh_begin".
347		457
348	on_keyboard_command $term, $string	458	on_user_command $term, $string
349	Called whenever the user presses a key combination that has a	459	Called whenever the a user-configured event is being activated (e.g.
350	"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
351	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.
352		465
353	on_x_event $term, $event	466	on_x_event $term, $event
354	Called on every X event received on the vt window (and possibly	467	Called on every X event received on the vt window (and possibly
355	other windows). Should only be used as a last resort. Most event	468	other windows). Should only be used as a last resort. Most event
356	structure members are not passed.	469	structure members are not passed.
…		…
361		474
362	on_focus_out $term	475	on_focus_out $term
363	Called wheneever the window loses keyboard focus, before	476	Called wheneever the window loses keyboard focus, before
364	rxvt-unicode does focus out processing.	477	rxvt-unicode does focus out processing.
365		478
		479	on_configure_notify $term, $event
		480	on_property_notify $term, $event
366	on_key_press $term, $event, $keysym, $octets	481	on_key_press $term, $event, $keysym, $octets
367	on_key_release $term, $event, $keysym	482	on_key_release $term, $event, $keysym
368	on_button_press $term, $event	483	on_button_press $term, $event
369	on_button_release $term, $event	484	on_button_release $term, $event
370	on_motion_notify $term, $event	485	on_motion_notify $term, $event
…		…
374	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
375	rxvt-unicode.	490	rxvt-unicode.
376		491
377	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
378	XEvent manpage), with the additional members "row" and "col", which	493	XEvent manpage), with the additional members "row" and "col", which
379	are the row and column under the mouse cursor.	494	are the (real, not screen-based) row and column under the mouse
		495	cursor.
380		496
381	"on_key_press" additionally receives the string rxvt-unicode would	497	"on_key_press" additionally receives the string rxvt-unicode would
382	output, if any, in locale-specific encoding.	498	output, if any, in locale-specific encoding.
383		499
384	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).
385		507
386	Variables in the "urxvt" Package	508	Variables in the "urxvt" Package
387	$urxvt::LIBDIR	509	$urxvt::LIBDIR
388	The rxvt-unicode library directory, where, among other things, the	510	The rxvt-unicode library directory, where, among other things, the
389	perl modules and scripts are stored.	511	perl modules and scripts are stored.
…		…
396	The basename of the installed binaries, usually "urxvt".	518	The basename of the installed binaries, usually "urxvt".
397		519
398	$urxvt::TERM	520	$urxvt::TERM
399	The current terminal. This variable stores the current "urxvt::term"	521	The current terminal. This variable stores the current "urxvt::term"
400	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.
401		539
402	Functions in the "urxvt" Package	540	Functions in the "urxvt" Package
403	urxvt::fatal $errormessage	541	urxvt::fatal $errormessage
404	Fatally aborts execution with the given error message. Avoid at all	542	Fatally aborts execution with the given error message. Avoid at all
405	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
…		…
500	$term->destroy	638	$term->destroy
501	Destroy the terminal object (close the window, free resources etc.).	639	Destroy the terminal object (close the window, free resources etc.).
502	Please note that rxvt will not exit as long as any event watchers	640	Please note that rxvt will not exit as long as any event watchers
503	(timers, io watchers) are still active.	641	(timers, io watchers) are still active.
504		642
		643	$term->exec_async ($cmd[, @args])
		644	Works like the combination of the "fork"/"exec" builtins, which
		645	executes ("starts") programs in the background. This function takes
		646	care of setting the user environment before exec'ing the command
		647	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		648	or "system".
		649
		650	Returns the pid of the subprocess or "undef" on error.
		651
505	$isset = $term->option ($optval[, $set])	652	$isset = $term->option ($optval[, $set])
506	Returns true if the option specified by $optval is enabled, and	653	Returns true if the option specified by $optval is enabled, and
507	optionally change it. All option values are stored by name in the	654	optionally change it. All option values are stored by name in the
508	hash %urxvt::OPTION. Options not enabled in this binary are not in	655	hash %urxvt::OPTION. Options not enabled in this binary are not in
509	the hash.	656	the hash.
…		…
511	Here is a a likely non-exhaustive list of option names, please see	658	Here is a a likely non-exhaustive list of option names, please see
512	the source file /src/optinc.h to see the actual list:	659	the source file /src/optinc.h to see the actual list:
513		660
514	borderLess console cursorBlink cursorUnderline hold iconic insecure	661	borderLess console cursorBlink cursorUnderline hold iconic insecure
515	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	662	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
516	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	663	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
517	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	664	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
518	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	665	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
519	tripleclickwords utmpInhibit visualBell	666	transparent tripleclickwords utmpInhibit visualBell
520		667
521	$value = $term->resource ($name[, $newval])	668	$value = $term->resource ($name[, $newval])
522	Returns the current resource value associated with a given name and	669	Returns the current resource value associated with a given name and
523	optionally sets a new value. Setting values is most useful in the	670	optionally sets a new value. Setting values is most useful in the
524	"init" hook. Unset resources are returned and accepted as "undef".	671	"init" hook. Unset resources are returned and accepted as "undef".
…		…
541		688
542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	689	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
543	borderLess color cursorBlink cursorUnderline cutchars delete_key	690	borderLess color cursorBlink cursorUnderline cutchars delete_key
544	display_name embed ext_bwidth fade font geometry hold iconName	691	display_name embed ext_bwidth fade font geometry hold iconName
545	imFont imLocale inputMethod insecure int_bwidth intensityStyles	692	imFont imLocale inputMethod insecure int_bwidth intensityStyles
546	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	693	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
547	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	694	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
548	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	695	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
549	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	696	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	697	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	698	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		699	secondaryScreen secondaryScroll selectstyle shade term_name title
552	shade term_name title transparent transparent_all tripleclickwords	700	transient_for transparent transparent_all tripleclickwords utmpInhibit
553	utmpInhibit visualBell	701	visualBell
554		702
555	$value = $term->x_resource ($pattern)	703	$value = $term->x_resource ($pattern)
556	Returns the X-Resource for the given pattern, excluding the program	704	Returns the X-Resource for the given pattern, excluding the program
557	or class name, i.e. "$term->x_resource ("boldFont")" should return	705	or class name, i.e. "$term->x_resource ("boldFont")" should return
558	the same value as used by this instance of rxvt-unicode. Returns	706	the same value as used by this instance of rxvt-unicode. Returns
…		…
669		817
670	Normally its not a good idea to use this function, as programs might	818	Normally its not a good idea to use this function, as programs might
671	be confused by changes in cursor position or scrolling. Its useful	819	be confused by changes in cursor position or scrolling. Its useful
672	inside a "on_add_lines" hook, though.	820	inside a "on_add_lines" hook, though.
673		821
		822	$term->scr_change_screen ($screen)
		823	Switch to given screen - 0 primary, 1 secondary.
		824
674	$term->cmd_parse ($octets)	825	$term->cmd_parse ($octets)
675	Similar to "scr_add_lines", but the argument must be in the	826	Similar to "scr_add_lines", but the argument must be in the
676	locale-specific encoding of the terminal and can contain command	827	locale-specific encoding of the terminal and can contain command
677	sequences (escape codes) that will be interpreted.	828	sequences (escape codes) that will be interpreted.
678		829
…		…
685	$old_events = $term->pty_ev_events ([$new_events])	836	$old_events = $term->pty_ev_events ([$new_events])
686	Replaces the event mask of the pty watcher by the given event mask.	837	Replaces the event mask of the pty watcher by the given event mask.
687	Can be used to suppress input and output handling to the pty/tty.	838	Can be used to suppress input and output handling to the pty/tty.
688	See the description of "urxvt::timer->events". Make sure to always	839	See the description of "urxvt::timer->events". Make sure to always
689	restore the previous value.	840	restore the previous value.
		841
		842	$fd = $term->pty_fd
		843	Returns the master file descriptor for the pty in use, or -1 if no
		844	pty is used.
690		845
691	$windowid = $term->parent	846	$windowid = $term->parent
692	Return the window id of the toplevel window.	847	Return the window id of the toplevel window.
693		848
694	$windowid = $term->vt	849	$windowid = $term->vt
…		…
729	$modifiermask = $term->ModNumLockMask	884	$modifiermask = $term->ModNumLockMask
730	Return the modifier masks corresponding to the "ISO Level 3 Shift"	885	Return the modifier masks corresponding to the "ISO Level 3 Shift"
731	(often AltGr), the meta key (often Alt) and the num lock key, if	886	(often AltGr), the meta key (often Alt) and the num lock key, if
732	applicable.	887	applicable.
733		888
		889	$screen = $term->current_screen
		890	Returns the currently displayed screen (0 primary, 1 secondary).
		891
		892	$cursor_is_hidden = $term->hidden_cursor
		893	Returns wether the cursor is currently hidden or not.
		894
734	$view_start = $term->view_start ([$newvalue])	895	$view_start = $term->view_start ([$newvalue])
735	Returns the row number of the topmost displayed line. Maximum value	896	Returns the row number of the topmost displayed line. Maximum value
736	is 0, which displays the normal terminal contents. Lower values	897	is 0, which displays the normal terminal contents. Lower values
737	scroll this many lines into the scrollback buffer.	898	scroll this many lines into the scrollback buffer.
738		899
…		…
754	line, starting at column $start_col (default 0), which is useful to	915	line, starting at column $start_col (default 0), which is useful to
755	replace only parts of a line. The font index in the rendition will	916	replace only parts of a line. The font index in the rendition will
756	automatically be updated.	917	automatically be updated.
757		918
758	$text is in a special encoding: tabs and wide characters that use	919	$text is in a special encoding: tabs and wide characters that use
759	more than one cell when displayed are padded with urxvt::NOCHAR	920	more than one cell when displayed are padded with $urxvt::NOCHAR
760	characters ("chr 65535"). Characters with combining characters and	921	(chr 65535) characters. Characters with combining characters and
761	other characters that do not fit into the normal tetx encoding will	922	other characters that do not fit into the normal tetx encoding will
762	be replaced with characters in the private use area.	923	be replaced with characters in the private use area.
763		924
764	You have to obey this encoding when changing text. The advantage is	925	You have to obey this encoding when changing text. The advantage is
765	that "substr" and similar functions work on screen cells and not on	926	that "substr" and similar functions work on screen cells and not on
…		…
845		1006
846	$term->ungrab	1007	$term->ungrab
847	Calls XUngrab for the most recent grab. Is called automatically on	1008	Calls XUngrab for the most recent grab. Is called automatically on
848	evaluation errors, as it is better to lose the grab in the error	1009	evaluation errors, as it is better to lose the grab in the error
849	case as the session.	1010	case as the session.
		1011
		1012	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1013	$atom_name = $term->XGetAtomName ($atom)
		1014	@atoms = $term->XListProperties ($window)
		1015	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1016	$term->XChangeWindowProperty ($window, $property, $type, $format,
		1017	$octets)
		1018	$term->XDeleteProperty ($window, $property)
		1019	$window = $term->DefaultRootWindow
		1020	$term->XReparentWindow ($window, $parent, [$x, $y])
		1021	$term->XMapWindow ($window)
		1022	$term->XUnmapWindow ($window)
		1023	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1024	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1025	$y)
		1026	$term->XChangeInput ($window, $add_events[, $del_events])
		1027	Various X or X-related functions. The $term object only serves as
		1028	the source of the display, otherwise those functions map
		1029	more-or-less directory onto the X functions of the same name.
850		1030
851	The "urxvt::popup" Class	1031	The "urxvt::popup" Class
852	$popup->add_title ($title)	1032	$popup->add_title ($title)
853	Adds a non-clickable title to the popup.	1033	Adds a non-clickable title to the popup.
854		1034
…		…
902	$timer = $timer->start	1082	$timer = $timer->start
903	Start the timer.	1083	Start the timer.
904		1084
905	$timer = $timer->start ($tstamp)	1085	$timer = $timer->start ($tstamp)
906	Set the event trigger time to $tstamp and start the timer.	1086	Set the event trigger time to $tstamp and start the timer.
		1087
		1088	$timer = $timer->after ($delay)
		1089	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
907		1090
908	$timer = $timer->stop	1091	$timer = $timer->stop
909	Stop the timer.	1092	Stop the timer.
910		1093
911	The "urxvt::iow" Class	1094	The "urxvt::iow" Class
…		…
943	Start watching for requested events on the given handle.	1126	Start watching for requested events on the given handle.
944		1127
945	$iow = $iow->stop	1128	$iow = $iow->stop
946	Stop watching for events on the given filehandle.	1129	Stop watching for events on the given filehandle.
947		1130
		1131	The "urxvt::iw" Class
		1132	This class implements idle watchers, that get called automatically when
		1133	the process is idle. They should return as fast as possible, after doing
		1134	some useful work.
		1135
		1136	$iw = new urxvt::iw
		1137	Create a new idle watcher object in stopped state.
		1138
		1139	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1140	Set the callback to be called when the watcher triggers.
		1141
		1142	$timer = $timer->start
		1143	Start the watcher.
		1144
		1145	$timer = $timer->stop
		1146	Stop the watcher.
		1147
		1148	The "urxvt::pw" Class
		1149	This class implements process watchers. They create an event whenever a
		1150	process exits, after which they stop automatically.
		1151
		1152	my $pid = fork;
		1153	...
		1154	$term->{pw} = urxvt::pw
		1155	->new
		1156	->start ($pid)
		1157	->cb (sub {
		1158	my ($pw, $exit_status) = @_;
		1159	...
		1160	});
		1161
		1162	$pw = new urxvt::pw
		1163	Create a new process watcher in stopped state.
		1164
		1165	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1166	Set the callback to be called when the timer triggers.
		1167
		1168	$pw = $timer->start ($pid)
		1169	Tells the wqtcher to start watching for process $pid.
		1170
		1171	$pw = $pw->stop
		1172	Stop the watcher.
		1173
948	ENVIRONMENT	1174	ENVIRONMENT
949	URXVT_PERL_VERBOSITY	1175	URXVT_PERL_VERBOSITY
950	This variable controls the verbosity level of the perl extension. Higher	1176	This variable controls the verbosity level of the perl extension. Higher
951	numbers indicate more verbose output.	1177	numbers indicate more verbose output.
952		1178

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC vs. Revision 1.37 by root, Wed Jan 25 21:48:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.30 by root, Wed Jan 18 09:40:53 2006 UTC vs.
Revision 1.37 by root, Wed Jan 25 21:48:47 2006 UTC