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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.4 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.37 by root, Wed Jan 25 21:48:47 2006 UTC

…		…
12	# start a rxvt using it:	12	# start a rxvt using it:
13		13
14	rxvt --perl-lib $HOME -pe grab_test	14	rxvt --perl-lib $HOME -pe grab_test
15		15
16	DESCRIPTION	16	DESCRIPTION
17	Everytime a terminal object gets created, scripts specified via the	17	Everytime a terminal object gets created, extension scripts specified
18	"perl" resource are loaded and associated with it.	18	via the "perl" resource are loaded and associated with it.
19		19
20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	20	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
21	thus must be encoded as UTF-8.	21	thus must be encoded as UTF-8.
22		22
23	Each script will only ever be loaded once, even in rxvtd, where scripts	23	Each script will only ever be loaded once, even in rxvtd, where scripts
24	will be shared (But not enabled) for all terminals.	24	will be shared (but not enabled) for all terminals.
25		25
26	PACKAGED EXTENSIONS	26	PREPACKAGED EXTENSIONS
27	This section describes the extensiosn delivered with this version. You	27	This section describes the extensions delivered with this release. You
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		33
34	selection	34	Or by adding them to the resource for extensions loaded by default:
35	Miscellaneous selection modifications.	35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		37
		38	selection (enabled by default)
		39	(More) intelligent selection. This extension tries to be more
		40	intelligent when the user extends selections (double-click and
		41	further clicks). Right now, it tries to select words, urls and
		42	complete shell-quoted arguments, which is very convenient, too, if
		43	your ls supports "--quoting-style=shell".
		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
		73	This extension also offers following bindable keyboard commands:
36		74
37	rot13	75	rot13
38	Rot-13 the selection when activated. Used via keyboard trigger:	76	Rot-13 the selection when activated. Used via keyboard trigger:
39		77
40	URxvt.keysym.C-M-r: perl:selection:rot13	78	URxvt.keysym.C-M-r: perl:selection:rot13
41		79
		80	option-popup (enabled by default)
		81	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		82	options at runtime.
		83
		84	selection-popup (enabled by default)
		85	Binds a popup menu to Ctrl-Button3 that lets you convert the
		86	selection text into various other formats/action (such as uri
		87	unescaping, perl evaluation, web-browser starting etc.), depending
		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	};
		109
		110	searchable-scrollback<hotkey> (enabled by default)
		111	Adds regex search functionality to the scrollback buffer, triggered
		112	by a hotkey (default: "M-s"). While in search mode, normal terminal
		113	input/output is suspended and a regex is displayed at the bottom of
		114	the screen.
		115
		116	Inputting characters appends them to the regex and continues
		117	incremental search. "BackSpace" removes a character from the regex,
		118	"Up" and "Down" search upwards/downwards in the scrollback buffer,
		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.
		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
		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	mark-urls
		189	Uses per-line display filtering ("on_line_update") to underline urls
		190	and make them clickable. When middle-clicked, the program specified
		191	in the resource "urlLauncher" (default "x-www-browser") will be
		192	started with the URL as first argument.
		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
		213	block-graphics-to-ascii
		214	A not very useful example of filtering all text output to the
		215	terminal, by replacing all line-drawing characters (U+2500 ..
		216	U+259F) by a similar-looking ascii character.
		217
42	digital-clock	218	digital-clock
		219	Displays a digital clock using the built-in overlay.
		220
		221	remote-clipboard
		222	Somewhat of a misnomer, this extension adds two menu entries to the
		223	selection popup that allows one ti run external commands to store
		224	the selection somewhere and fetch it again.
		225
		226	We use it to implement a "distributed selection mechanism", which
		227	just means that one command uploads the file to a remote server, and
		228	another reads it.
		229
		230	The commands can be set using the "URxvt.remote-selection.store" and
		231	"URxvt.remote-selection.fetch" resources. The first should read the
		232	selection to store from STDIN (always in UTF-8), the second should
		233	provide the selection data on STDOUT (also in UTF-8).
		234
		235	The defaults (which are likely useless to you) use rsh and cat:
		236
		237	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		238	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		239
		240	selection-pastebin
		241	This is a little rarely useful extension that Uploads the selection
		242	as textfile to a remote site (or does other things). (The
		243	implementation is not currently secure for use in a multiuser
		244	environment as it writes to /tmp directly.).
		245
		246	It listens to the "selection-pastebin:remote-pastebin" keyboard
		247	command, i.e.
		248
		249	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		250
		251	Pressing this combination runs a command with "%" replaced by the
		252	name of the textfile. This command can be set via a resource:
		253
		254	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		255
		256	And the default is likely not useful to anybody but the few people
		257	around here :)
		258
		259	The name of the textfile is the hex encoded md5 sum of the
		260	selection, so the same content should lead to the same filename.
		261
		262	After a successful upload the selection will be replaced by the text
		263	given in the "selection-pastebin-url" resource (again, the % is the
		264	placeholder for the filename):
		265
		266	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		267
		268	example-refresh-hooks
43	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
44	the window. Illustrates overwriting the refresh callbacks to create	270	the window. Illustrates overwriting the refresh callbacks to create
45	your own overlays or changes.	271	your own overlays or changes.
46		272
47	simple-overlay-clock	273	API DOCUMENTATION
48	Displays a digital clock using the built-in overlay (colorful,
49	useless).
50
51	General API Considerations	274	General API Considerations
52	All objects (such as terminals, time watchers etc.) are typical	275	All objects (such as terminals, time watchers etc.) are typical
53	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
54	like. All members starting with an underscore (such as "_ptr" or	277	like. All members starting with an underscore (such as "_ptr" or
55	"_hook") are reserved for internal uses and must not be accessed or	278	"_hook") are reserved for internal uses and MUST NOT be accessed or
56	modified).	279	modified).
57		280
58	When objects are destroyed on the C++ side, the perl object hashes are	281	When objects are destroyed on the C++ side, the perl object hashes are
59	emptied, so its best to store related objects such as time watchers and	282	emptied, so its best to store related objects such as time watchers and
60	the like inside the terminal object so they get destroyed as soon as the	283	the like inside the terminal object so they get destroyed as soon as the
61	terminal is destroyed.	284	terminal is destroyed.
62		285
		286	Argument names also often indicate the type of a parameter. Here are
		287	some hints on what they mean:
		288
		289	$text
		290	Rxvt-unicodes special way of encoding text, where one "unicode"
		291	character always represents one screen cell. See ROW_t for a
		292	discussion of this format.
		293
		294	$string
		295	A perl text string, with an emphasis on text. It can store all
		296	unicode characters and is to be distinguished with text encoded in a
		297	specific encoding (often locale-specific) and binary data.
		298
		299	$octets
		300	Either binary data or - more common - a text string encoded in a
		301	locale-specific way.
		302
		303	Extension Objects
		304	Very perl extension is a perl class. A separate perl object is created
		305	for each terminal and each extension and passed as the first parameter
		306	to hooks. So extensions can use their $self object without having to
		307	think about other extensions, with the exception of methods and members
		308	that begin with an underscore character "_": these are reserved for
		309	internal use.
		310
		311	Although it isn't a "urxvt::term" object, you can call all methods of
		312	the "urxvt::term" class on this object.
		313
		314	It has the following methods and data members:
		315
		316	$urxvt_term = $self->{term}
		317	Returns the "urxvt::term" object associated with this instance of
		318	the extension. This member must not be changed in any way.
		319
		320	$self->enable ($hook_name => $cb, [$hook_name => $cb..])
		321	Dynamically enable the given hooks (named without the "on_" prefix)
		322	for this extension, replacing any previous hook. This is useful when
		323	you want to overwrite time-critical hooks only temporarily.
		324
		325	$self->disable ($hook_name[, $hook_name..])
		326	Dynamically disable the given hooks.
		327
63	Hooks	328	Hooks
64	The following subroutines can be declared in loaded scripts, and will be	329	The following subroutines can be declared in extension files, and will
65	called whenever the relevant event happens.	330	be called whenever the relevant event happens.
66		331
67	All of them must return a boolean value. If it is true, then the event	332	The first argument passed to them is an extension oject as described in
68	counts as being consumed, and the invocation of other hooks is	333	the in the "Extension Objects" section.
		334
		335	All of these hooks must return a boolean value. If any of the called
		336	hooks returns true, then the event counts as being consumed, and the
69	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.
70	code.
71		338
72	When in doubt, return a false value (preferably "()").	339	When in doubt, return a false value (preferably "()").
73		340
74	on_init $term	341	on_init $term
75	Called after a new terminal object has been initialized, but before	342	Called after a new terminal object has been initialized, but before
76	windows are created or the command gets run.	343	windows are created or the command gets run. Most methods are unsafe
		344	to call or deliver senseless data, as terminal size and other
		345	characteristics have not yet been determined. You can safely query
		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).
77		357
78	on_reset $term	358	on_reset $term
79	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
80	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
81	size-related variables.	361	size-related variables.
82		362
83	on_start $term	363	on_child_start $term, $pid
84	Called at the very end of initialisation of a new terminal, just	364	Called just after the child process has been "fork"ed.
85	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".
86		369
87	on_sel_make $term, $eventtime	370	on_sel_make $term, $eventtime
88	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
89	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
90	type of the selection will be honored.	373	type of the selection will be honored.
…		…
99	queried and changed by calling "$term->selection".	382	queried and changed by calling "$term->selection".
100		383
101	Returning a true value aborts selection grabbing. It will still be	384	Returning a true value aborts selection grabbing. It will still be
102	hilighted.	385	hilighted.
103		386
104	on_focus_in $term	387	on_sel_extend $term
105	Called whenever the window gets the keyboard focus, before urxvt	388	Called whenever the user tries to extend the selection (e.g. with a
106	does focus in processing.	389	double click) and is either supposed to return false (normal
		390	operation), or should extend the selection itelf and return true to
		391	suppress the built-in processing. This can happen multiple times, as
		392	long as the callback returns true, it will be called on every
		393	further click by the user and is supposed to enlarge the selection
		394	more and more, if possible.
107		395
108	on_focus_out $term	396	See the selection example extension.
109	Called wheneever the window loses keyboard focus, before urxvt does
110	focus out processing.
111		397
112	on_view_change $term, $offset	398	on_view_change $term, $offset
113	Called whenever the view offset changes, i..e the user or program	399	Called whenever the view offset changes, i..e the user or program
114	scrolls. Offset 0 means display the normal terminal, positive values	400	scrolls. Offset 0 means display the normal terminal, positive values
115	show this many lines of scrollback.	401	show this many lines of scrollback.
…		…
121		407
122	It is called before lines are scrolled out (so rows 0 .. min ($lines	408	It is called before lines are scrolled out (so rows 0 .. min ($lines
123	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	409	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
124	the total number of lines that will be in the scrollback buffer.	410	the total number of lines that will be in the scrollback buffer.
125		411
126	on_tty_activity $term NYI	412	on_osc_seq $term, $string
127	Called whenever the program(s) running in the urxvt window send	413	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
128	output.	414	operating system command) is processed. Cursor position and other
		415	state information is up-to-date when this happens. For
		416	interoperability, the string should start with the extension name
		417	and a colon, to distinguish it from commands for other extensions,
		418	and this might be enforced in the future.
		419
		420	Be careful not ever to trust (in a security sense) the data you
		421	receive, as its source can not easily be controleld (e-mail content,
		422	messages from other users on the same system etc.).
		423
		424	on_add_lines $term, $string
		425	Called whenever text is about to be output, with the text as
		426	argument. You can filter/change and output the text yourself by
		427	returning a true value and calling "$term->scr_add_lines" yourself.
		428	Please note that this might be very slow, however, as your hook is
		429	called for all text being output.
		430
		431	on_tt_write $term, $octets
		432	Called whenever some data is written to the tty/pty and can be used
		433	to suppress or filter tty input.
		434
		435	on_line_update $term, $row
		436	Called whenever a line was updated or changed. Can be used to filter
		437	screen output (e.g. underline urls or other useless stuff). Only
		438	lines that are being shown will be filtered, and, due to performance
		439	reasons, not always immediately.
		440
		441	The row number is always the topmost row of the line if the line
		442	spans multiple rows.
		443
		444	Please note that, if you change the line, then the hook might get
		445	called later with the already-modified line (e.g. if unrelated parts
		446	change), so you cannot just toggle rendition bits, but only set
		447	them.
129		448
130	on_refresh_begin $term	449	on_refresh_begin $term
131	Called just before the screen gets redrawn. Can be used for overlay	450	Called just before the screen gets redrawn. Can be used for overlay
132	or similar effects by modify terminal contents in refresh_begin, and	451	or similar effects by modify terminal contents in refresh_begin, and
133	restoring them in refresh_end. The built-in overlay and selection	452	restoring them in refresh_end. The built-in overlay and selection
134	display code is run after this hook, and takes precedence.	453	display code is run after this hook, and takes precedence.
135		454
136	on_refresh_end $term	455	on_refresh_end $term
137	Called just after the screen gets redrawn. See "on_refresh_begin".	456	Called just after the screen gets redrawn. See "on_refresh_begin".
138		457
139	on_keyboard_command $term, $string	458	on_user_command $term, $string
140	Called whenever the user presses a key combination that has a	459	Called whenever the a user-configured event is being activated (e.g.
141	"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
142	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.
		470
		471	on_focus_in $term
		472	Called whenever the window gets the keyboard focus, before
		473	rxvt-unicode does focus in processing.
		474
		475	on_focus_out $term
		476	Called wheneever the window loses keyboard focus, before
		477	rxvt-unicode does focus out processing.
		478
		479	on_configure_notify $term, $event
		480	on_property_notify $term, $event
		481	on_key_press $term, $event, $keysym, $octets
		482	on_key_release $term, $event, $keysym
		483	on_button_press $term, $event
		484	on_button_release $term, $event
		485	on_motion_notify $term, $event
		486	on_map_notify $term, $event
		487	on_unmap_notify $term, $event
		488	Called whenever the corresponding X event is received for the
		489	terminal If the hook returns true, then the even will be ignored by
		490	rxvt-unicode.
		491
		492	The event is a hash with most values as named by Xlib (see the
		493	XEvent manpage), with the additional members "row" and "col", which
		494	are the (real, not screen-based) row and column under the mouse
		495	cursor.
		496
		497	"on_key_press" additionally receives the string rxvt-unicode would
		498	output, if any, in locale-specific encoding.
		499
		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).
		507
		508	Variables in the "urxvt" Package
		509	$urxvt::LIBDIR
		510	The rxvt-unicode library directory, where, among other things, the
		511	perl modules and scripts are stored.
		512
		513	$urxvt::RESCLASS, $urxvt::RESCLASS
		514	The resource class and name rxvt-unicode uses to look up X
		515	resources.
		516
		517	$urxvt::RXVTNAME
		518	The basename of the installed binaries, usually "urxvt".
		519
		520	$urxvt::TERM
		521	The current terminal. This variable stores the current "urxvt::term"
		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.
143		539
144	Functions in the "urxvt" Package	540	Functions in the "urxvt" Package
145	urxvt::fatal $errormessage	541	urxvt::fatal $errormessage
146	Fatally aborts execution with the given error message. Avoid at all	542	Fatally aborts execution with the given error message. Avoid at all
147	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
…		…
153	function that calls this function.	549	function that calls this function.
154		550
155	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
156	correct place, e.g. on stderr of the connecting urxvtc client.	552	correct place, e.g. on stderr of the connecting urxvtc client.
157		553
		554	Messages have a size limit of 1023 bytes currently.
		555
158	$time = urxvt::NOW	556	$time = urxvt::NOW
159	Returns the "current time" (as per the event loop).	557	Returns the "current time" (as per the event loop).
160		558
		559	urxvt::CurrentTime
		560	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
		561	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
		562	Button5Mask, AnyModifier
		563	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		564	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		565	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		566	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		567	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		568	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		569	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		570	ColormapChangeMask, OwnerGrabButtonMask
		571	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		572	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		573	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		574	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		575	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		578	Various constants for use in X calls and event processing.
		579
		580	RENDITION
		581	Rendition bitsets contain information about colour, font, font styles
		582	and similar information for each screen cell.
		583
		584	The following "macros" deal with changes in rendition sets. You should
		585	never just create a bitset, you should always modify an existing one, as
		586	they contain important information required for correct operation of
		587	rxvt-unicode.
		588
		589	$rend = urxvt::DEFAULT_RSTYLE
		590	Returns the default rendition, as used when the terminal is starting
		591	up or being reset. Useful as a base to start when creating
		592	renditions.
		593
		594	$rend = urxvt::OVERLAY_RSTYLE
		595	Return the rendition mask used for overlays by default.
		596
		597	$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		598	Return the bit that enabled bold, italic, blink, reverse-video and
		599	underline, respectively. To enable such a style, just logically OR
		600	it into the bitset.
		601
		602	$foreground = urxvt::GET_BASEFG $rend
		603	$background = urxvt::GET_BASEBG $rend
		604	Return the foreground/background colour index, respectively.
		605
		606	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
		607	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
		608	Replace the foreground/background colour in the rendition mask with
		609	the specified one.
		610
		611	$value = urxvt::GET_CUSTOM $rend
		612	Return the "custom" value: Every rendition has 5 bits for use by
		613	extensions. They can be set and changed as you like and are
		614	initially zero.
		615
		616	$rend = urxvt::SET_CUSTOM $rend, $new_value
		617	Change the custom value.
		618
		619	The "urxvt::anyevent" Class
		620	The sole purpose of this class is to deliver an interface to the
		621	"AnyEvent" module - any module using it will work inside urxvt without
		622	further programming. The only exception is that you cannot wait on
		623	condition variables, but non-blocking condvar use is ok. What this means
		624	is that you cannot use blocking APIs, but the non-blocking variant
		625	should work.
		626
161	The "urxvt::term" Class	627	The "urxvt::term" Class
		628	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		629	Creates a new terminal, very similar as if you had started it with
		630	system "$rxvtname, arg...". $envhashref must be a reference to a
		631	%ENV-like hash which defines the environment of the new terminal.
		632
		633	Croaks (and probably outputs an error message) if the new instance
		634	couldn't be created. Returns "undef" if the new instance didn't
		635	initialise perl, and the terminal object otherwise. The "init" and
		636	"start" hooks will be called during this call.
		637
		638	$term->destroy
		639	Destroy the terminal object (close the window, free resources etc.).
		640	Please note that rxvt will not exit as long as any event watchers
		641	(timers, io watchers) are still active.
		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
		652	$isset = $term->option ($optval[, $set])
		653	Returns true if the option specified by $optval is enabled, and
		654	optionally change it. All option values are stored by name in the
		655	hash %urxvt::OPTION. Options not enabled in this binary are not in
		656	the hash.
		657
		658	Here is a a likely non-exhaustive list of option names, please see
		659	the source file /src/optinc.h to see the actual list:
		660
		661	borderLess console cursorBlink cursorUnderline hold iconic insecure
		662	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		663	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		664	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		665	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		666	transparent tripleclickwords utmpInhibit visualBell
		667
162	$value = $term->resource ($name[, $newval])	668	$value = $term->resource ($name[, $newval])
163	Returns the current resource value associated with a given name and	669	Returns the current resource value associated with a given name and
164	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
165	"init" hook. Unset resources are returned and accepted as "undef".	671	"init" hook. Unset resources are returned and accepted as "undef".
166		672
…		…
175	Please note that resource strings will currently only be freed when	681	Please note that resource strings will currently only be freed when
176	the terminal is destroyed, so changing options frequently will eat	682	the terminal is destroyed, so changing options frequently will eat
177	memory.	683	memory.
178		684
179	Here is a a likely non-exhaustive list of resource names, not all of	685	Here is a a likely non-exhaustive list of resource names, not all of
180	which are supported in every build, please see the source to see the	686	which are supported in every build, please see the source file
181	actual list:	687	/src/rsinc.h to see the actual list:
182		688
183	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	689	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
184	borderLess color cursorBlink cursorUnderline cutchars delete_key	690	borderLess color cursorBlink cursorUnderline cutchars delete_key
185	display_name embed ext_bwidth fade font geometry hold iconName	691	display_name embed ext_bwidth fade font geometry hold iconName
186	imFont imLocale inputMethod insecure int_bwidth intensityStyles	692	imFont imLocale inputMethod insecure int_bwidth intensityStyles
187	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	693	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
188	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	694	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
189	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	695	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
190	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	696	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
191	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	697	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
192	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	698	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		699	secondaryScreen secondaryScroll selectstyle shade term_name title
193	shade term_name title transparent transparent_all tripleclickwords	700	transient_for transparent transparent_all tripleclickwords utmpInhibit
194	utmpInhibit visualBell	701	visualBell
		702
		703	$value = $term->x_resource ($pattern)
		704	Returns the X-Resource for the given pattern, excluding the program
		705	or class name, i.e. "$term->x_resource ("boldFont")" should return
		706	the same value as used by this instance of rxvt-unicode. Returns
		707	"undef" if no resource with that pattern exists.
		708
		709	This method should only be called during the "on_start" hook, as
		710	there is only one resource database per display, and later
		711	invocations might return the wrong resources.
		712
		713	$success = $term->parse_keysym ($keysym_spec, $command_string)
		714	Adds a keymap translation exactly as specified via a resource. See
		715	the "keysym" resource in the rxvt(1) manpage.
		716
		717	$rend = $term->rstyle ([$new_rstyle])
		718	Return and optionally change the current rendition. Text that is
		719	output by the terminal application will use this style.
		720
		721	($row, $col) = $term->screen_cur ([$row, $col])
		722	Return the current coordinates of the text cursor position and
		723	optionally set it (which is usually bad as applications don't expect
		724	that).
195		725
196	($row, $col) = $term->selection_mark ([$row, $col])	726	($row, $col) = $term->selection_mark ([$row, $col])
197	($row, $col) = $term->selection_beg ([$row, $col])	727	($row, $col) = $term->selection_beg ([$row, $col])
198	($row, $col) = $term->selection_end ([$row, $col])	728	($row, $col) = $term->selection_end ([$row, $col])
199	Return the current values of the selection mark, begin or end	729	Return the current values of the selection mark, begin or end
200	positions, and optionally set them to new values.	730	positions, and optionally set them to new values.
201		731
		732	$term->selection_make ($eventtime[, $rectangular])
		733	Tries to make a selection as set by "selection_beg" and
		734	"selection_end". If $rectangular is true (default: false), a
		735	rectangular selection will be made. This is the prefered function to
		736	make a selection.
		737
202	$success = $term->selection_grab ($eventtime)	738	$success = $term->selection_grab ($eventtime)
203	Try to request the primary selection from the server (for example,	739	Try to request the primary selection text from the server (for
204	as set by the next method).	740	example, as set by the next method). No visual feedback will be
		741	given. This function is mostly useful from within "on_sel_grab"
		742	hooks.
205		743
206	$oldtext = $term->selection ([$newtext])	744	$oldtext = $term->selection ([$newtext])
207	Return the current selection text and optionally replace it by	745	Return the current selection text and optionally replace it by
208	$newtext.	746	$newtext.
209		747
210	$term->scr_overlay ($x, $y, $text)	748	$term->overlay_simple ($x, $y, $text)
211	Create a simple multi-line overlay box. See the next method for	749	Create a simple multi-line overlay box. See the next method for
212	details.	750	details.
213		751
214	$term->scr_overlay_new ($x, $y, $width, $height)	752	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
215	Create a new (empty) overlay at the given position with the given	753	Create a new (empty) overlay at the given position with the given
216	width/height. A border will be put around the box. If either $x or	754	width/height. $rstyle defines the initial rendition style (default:
		755	"OVERLAY_RSTYLE").
		756
		757	If $border is 2 (default), then a decorative border will be put
		758	around the box.
		759
217	$y is negative, then this is counted from the right/bottom side,	760	If either $x or $y is negative, then this is counted from the
218	respectively.	761	right/bottom side, respectively.
219		762
220	$term->scr_overlay_off	763	This method returns an urxvt::overlay object. The overlay will be
221	Switch the overlay off again.	764	visible as long as the perl object is referenced.
222		765
223	$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	766	The methods currently supported on "urxvt::overlay" objects are:
224	Put a single character (specified numerically) at the given overlay
225	position.
226		767
227	$term->scr_overlay_set ($x, $y, $text)	768	$overlay->set ($x, $y, $text, $rend)
228	Write a string at the given position into the overlay.	769	Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
		770	text in rxvt-unicode's special encoding and an array of
		771	rendition values at a specific position inside the overlay.
229		772
		773	$overlay->hide
		774	If visible, hide the overlay, but do not destroy it.
		775
		776	$overlay->show
		777	If hidden, display the overlay again.
		778
		779	$popup = $term->popup ($event)
		780	Creates a new "urxvt::popup" object that implements a popup menu.
		781	The $event must be the event causing the menu to pop up (a button
		782	event, currently).
		783
230	$cellwidth = $term->strwidth $string	784	$cellwidth = $term->strwidth ($string)
231	Returns the number of screen-cells this string would need. Correctly	785	Returns the number of screen-cells this string would need. Correctly
232	accounts for wide and combining characters.	786	accounts for wide and combining characters.
233		787
234	$octets = $term->locale_encode $string	788	$octets = $term->locale_encode ($string)
235	Convert the given text string into the corresponding locale	789	Convert the given text string into the corresponding locale
236	encoding.	790	encoding.
237		791
238	$string = $term->locale_decode $octets	792	$string = $term->locale_decode ($octets)
239	Convert the given locale-encoded octets into a perl string.	793	Convert the given locale-encoded octets into a perl string.
		794
		795	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		796	XORs the rendition values in the given span with the provided value
		797	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
		798	in refresh hooks to provide effects similar to the selection.
		799
		800	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
		801	$rstyle2]])
		802	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
		803	whitespace will additionally be xored with the $rstyle2, which
		804	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
		805	and underlines it instead. Both styles MUST NOT contain font
		806	styles.
		807
		808	$term->scr_bell
		809	Ring the bell!
		810
		811	$term->scr_add_lines ($string)
		812	Write the given text string to the screen, as if output by the
		813	application running inside the terminal. It may not contain command
		814	sequences (escape codes), but is free to use line feeds, carriage
		815	returns and tabs. The string is a normal text string, not in
		816	locale-dependent encoding.
		817
		818	Normally its not a good idea to use this function, as programs might
		819	be confused by changes in cursor position or scrolling. Its useful
		820	inside a "on_add_lines" hook, though.
		821
		822	$term->scr_change_screen ($screen)
		823	Switch to given screen - 0 primary, 1 secondary.
		824
		825	$term->cmd_parse ($octets)
		826	Similar to "scr_add_lines", but the argument must be in the
		827	locale-specific encoding of the terminal and can contain command
		828	sequences (escape codes) that will be interpreted.
240		829
241	$term->tt_write ($octets)	830	$term->tt_write ($octets)
242	Write the octets given in $data to the tty (i.e. as program input).	831	Write the octets given in $data to the tty (i.e. as program input).
243	To pass characters instead of octets, you should convert your	832	To pass characters instead of octets, you should convert your
244	strings first to the locale-specific encoding using	833	strings first to the locale-specific encoding using
245	"$term->locale_encode".	834	"$term->locale_encode".
246		835
		836	$old_events = $term->pty_ev_events ([$new_events])
		837	Replaces the event mask of the pty watcher by the given event mask.
		838	Can be used to suppress input and output handling to the pty/tty.
		839	See the description of "urxvt::timer->events". Make sure to always
		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.
		845
		846	$windowid = $term->parent
		847	Return the window id of the toplevel window.
		848
		849	$windowid = $term->vt
		850	Return the window id of the terminal window.
		851
		852	$term->vt_emask_add ($x_event_mask)
		853	Adds the specified events to the vt event mask. Useful e.g. when you
		854	want to receive pointer events all the times:
		855
		856	$term->vt_emask_add (urxvt::PointerMotionMask);
		857
		858	$window_width = $term->width
		859	$window_height = $term->height
		860	$font_width = $term->fwidth
		861	$font_height = $term->fheight
		862	$font_ascent = $term->fbase
247	$nrow = $term->nrow	863	$terminal_rows = $term->nrow
248	$ncol = $term->ncol	864	$terminal_columns = $term->ncol
249	Return the number of rows/columns of the terminal window (i.e. as	865	$has_focus = $term->focus
250	specified by "-geometry", excluding any scrollback).	866	$is_mapped = $term->mapped
		867	$max_scrollback = $term->saveLines
		868	$nrow_plus_saveLines = $term->total_rows
		869	$topmost_scrollback_row = $term->top_row
		870	Return various integers describing terminal characteristics.
251		871
		872	$x_display = $term->display_id
		873	Return the DISPLAY used by rxvt-unicode.
		874
		875	$lc_ctype = $term->locale
		876	Returns the LC_CTYPE category string used by this rxvt-unicode.
		877
252	$nsaved = $term->nsaved	878	$env = $term->env
253	Returns the number of lines in the scrollback buffer.	879	Returns a copy of the environment in effect for the terminal as a
		880	hashref similar to "\%ENV".
		881
		882	$modifiermask = $term->ModLevel3Mask
		883	$modifiermask = $term->ModMetaMask
		884	$modifiermask = $term->ModNumLockMask
		885	Return the modifier masks corresponding to the "ISO Level 3 Shift"
		886	(often AltGr), the meta key (often Alt) and the num lock key, if
		887	applicable.
		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.
254		894
255	$view_start = $term->view_start ([$newvalue])	895	$view_start = $term->view_start ([$newvalue])
256	Returns the negative row number of the topmost line. Minimum value	896	Returns the row number of the topmost displayed line. Maximum value
257	is 0, which displays the normal terminal contents. Larger values	897	is 0, which displays the normal terminal contents. Lower values
258	scroll this many lines into the scrollback buffer.	898	scroll this many lines into the scrollback buffer.
259		899
260	$term->want_refresh	900	$term->want_refresh
261	Requests a screen refresh. At the next opportunity, rxvt-unicode	901	Requests a screen refresh. At the next opportunity, rxvt-unicode
262	will compare the on-screen display with its stored representation.	902	will compare the on-screen display with its stored representation.
…		…
266		906
267	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	907	$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
268	Returns the text of the entire row with number $row_number. Row 0 is	908	Returns the text of the entire row with number $row_number. Row 0 is
269	the topmost terminal line, row "$term->$ncol-1" is the bottommost	909	the topmost terminal line, row "$term->$ncol-1" is the bottommost
270	terminal line. The scrollback buffer starts at line -1 and extends	910	terminal line. The scrollback buffer starts at line -1 and extends
271	to line "-$term->nsaved".	911	to line "-$term->nsaved". Nothing will be returned if a nonexistent
		912	line is requested.
272		913
273	If $new_text is specified, it will replace characters in the current	914	If $new_text is specified, it will replace characters in the current
274	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
275	replace only parts of a line. The font iindex in the rendition will	916	replace only parts of a line. The font index in the rendition will
276	automatically be updated.	917	automatically be updated.
277		918
278	$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
279	more than one cell when displayed are padded with urxvt::NOCHAR	920	more than one cell when displayed are padded with $urxvt::NOCHAR
280	characters ("chr 65535"). Characters with combining characters and	921	(chr 65535) characters. Characters with combining characters and
281	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
282	be replaced with characters in the private use area.	923	be replaced with characters in the private use area.
283		924
284	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
285	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
…		…
293	Rendition bitsets contain information about colour, font, font	934	Rendition bitsets contain information about colour, font, font
294	styles and similar information. See also "$term->ROW_t".	935	styles and similar information. See also "$term->ROW_t".
295		936
296	When setting rendition, the font mask will be ignored.	937	When setting rendition, the font mask will be ignored.
297		938
298	See the section on RENDITION, below.	939	See the section on RENDITION, above.
299		940
300	$length = $term->ROW_l ($row_number[, $new_length])	941	$length = $term->ROW_l ($row_number[, $new_length])
301	Returns the number of screen cells that are in use ("the line	942	Returns the number of screen cells that are in use ("the line
302	length"). If it is -1, then the line is part of a multiple-row	943	length"). Unlike the urxvt core, this returns "$term->ncol" if the
303	logical "line", which means all characters are in use and it is	944	line is joined with the following one.
304	continued on the next row.	945
		946	$bool = $term->is_longer ($row_number)
		947	Returns true if the row is part of a multiple-row logical "line"
		948	(i.e. joined with the following row), which means all characters are
		949	in use and it is continued on the next row (and possibly a
		950	continuation of the previous row(s)).
		951
		952	$line = $term->line ($row_number)
		953	Create and return a new "urxvt::line" object that stores information
		954	about the logical line that row $row_number is part of. It supports
		955	the following methods:
		956
		957	$text = $line->t ([$new_text])
		958	Returns or replaces the full text of the line, similar to
		959	"ROW_t"
		960
		961	$rend = $line->r ([$new_rend])
		962	Returns or replaces the full rendition array of the line,
		963	similar to "ROW_r"
		964
		965	$length = $line->l
		966	Returns the length of the line in cells, similar to "ROW_l".
		967
		968	$rownum = $line->beg
		969	$rownum = $line->end
		970	Return the row number of the first/last row of the line,
		971	respectively.
		972
		973	$offset = $line->offset_of ($row, $col)
		974	Returns the character offset of the given row\|col pair within
		975	the logical line. Works for rows outside the line, too, and
		976	returns corresponding offsets outside the string.
		977
		978	($row, $col) = $line->coord_of ($offset)
		979	Translates a string offset into terminal coordinates again.
305		980
306	$text = $term->special_encode $string	981	$text = $term->special_encode $string
307	Converts a perl string into the special encoding used by	982	Converts a perl string into the special encoding used by
308	rxvt-unicode, where one character corresponds to one screen cell.	983	rxvt-unicode, where one character corresponds to one screen cell.
309	See "$term->ROW_t" for details.	984	See "$term->ROW_t" for details.
310		985
311	$string = $term->special_decode $text	986	$string = $term->special_decode $text
312	Converts rxvt-unicodes text reprsentation into a perl string. See	987	Converts rxvt-unicodes text reprsentation into a perl string. See
313	"$term->ROW_t" for details.	988	"$term->ROW_t" for details.
314		989
315	RENDITION	990	$success = $term->grab_button ($button, $modifiermask)
316	Rendition bitsets contain information about colour, font, font styles	991	Registers a synchronous button grab. See the XGrabButton manpage.
317	and similar information for each screen cell.
318		992
319	The following "macros" deal with changes in rendition sets. You should	993	$success = $term->grab ($eventtime[, $sync])
320	never just create a bitset, you should always modify an existing one, as	994	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
321	they contain important information required for correct operation of	995	synchronous ($sync is true). Also remembers the grab timestampe.
322	rxvt-unicode.
323		996
324	$rend = urxvt::DEFAULT_RSTYLE	997	$term->allow_events_async
325	Returns the default rendition, as used when the terminal is starting	998	Calls XAllowEvents with AsyncBoth for the most recent grab.
326	up or being reset. Useful as a base	999
		1000	$term->allow_events_sync
		1001	Calls XAllowEvents with SyncBoth for the most recent grab.
		1002
		1003	$term->allow_events_replay
		1004	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		1005	the most recent grab.
		1006
		1007	$term->ungrab
		1008	Calls XUngrab for the most recent grab. Is called automatically on
		1009	evaluation errors, as it is better to lose the grab in the error
		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.
		1030
		1031	The "urxvt::popup" Class
		1032	$popup->add_title ($title)
		1033	Adds a non-clickable title to the popup.
		1034
		1035	$popup->add_separator ([$sepchr])
		1036	Creates a separator, optionally using the character given as
		1037	$sepchr.
		1038
		1039	$popup->add_button ($text, $cb)
		1040	Adds a clickable button to the popup. $cb is called whenever it is
		1041	selected.
		1042
		1043	$popup->add_toggle ($text, $cb, $initial_value)
		1044	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1045	whenever it gets toggled, with a boolean indicating its value as its
		1046	first argument.
		1047
		1048	$popup->show
		1049	Displays the popup (which is initially hidden).
327		1050
328	The "urxvt::timer" Class	1051	The "urxvt::timer" Class
329	This class implements timer watchers/events. Time is represented as a	1052	This class implements timer watchers/events. Time is represented as a
330	fractional number of seconds since the epoch. Example:	1053	fractional number of seconds since the epoch. Example:
331		1054
332	# create a digital clock display in upper right corner	1055	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
333	$term->{timer} = urxvt::timer	1056	$term->{timer} = urxvt::timer
334	->new	1057	->new
335	->start (urxvt::NOW)	1058	->interval (1)
336	->cb (sub {	1059	->cb (sub {
337	my ($timer) = @_;
338	my $time = $timer->at;
339	$timer->start ($time + 1);
340	$self->scr_overlay (-1, 0,	1060	$term->{overlay}->set (0, 0,
341	POSIX::strftime "%H:%M:%S", localtime $time);	1061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
342	});	1062	});
343		1063
344	$timer = new urxvt::timer	1064	$timer = new urxvt::timer
345	Create a new timer object in stopped state.	1065	Create a new timer object in started state. It is scheduled to fire
		1066	immediately.
346		1067
347	$timer = $timer->cb (sub { my ($timer) = @_; ... })	1068	$timer = $timer->cb (sub { my ($timer) = @_; ... })
348	Set the callback to be called when the timer triggers.	1069	Set the callback to be called when the timer triggers.
349		1070
350	$tstamp = $timer->at	1071	$tstamp = $timer->at
351	Return the time this watcher will fire next.	1072	Return the time this watcher will fire next.
352		1073
353	$timer = $timer->set ($tstamp)	1074	$timer = $timer->set ($tstamp)
354	Set the time the event is generated to $tstamp.	1075	Set the time the event is generated to $tstamp.
355		1076
		1077	$timer = $timer->interval ($interval)
		1078	Normally (and when $interval is 0), the timer will automatically
		1079	stop after it has fired once. If $interval is non-zero, then the
		1080	timer is automatically rescheduled at the given intervals.
		1081
356	$timer = $timer->start	1082	$timer = $timer->start
357	Start the timer.	1083	Start the timer.
358		1084
359	$timer = $timer->start ($tstamp)	1085	$timer = $timer->start ($tstamp)
360	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>.
361		1090
362	$timer = $timer->stop	1091	$timer = $timer->stop
363	Stop the timer.	1092	Stop the timer.
364		1093
365	The "urxvt::iow" Class	1094	The "urxvt::iow" Class
…		…
367		1096
368	$term->{socket} = ...	1097	$term->{socket} = ...
369	$term->{iow} = urxvt::iow	1098	$term->{iow} = urxvt::iow
370	->new	1099	->new
371	->fd (fileno $term->{socket})	1100	->fd (fileno $term->{socket})
372	->events (1) # wait for read data	1101	->events (urxvt::EVENT_READ)
373	->start	1102	->start
374	->cb (sub {	1103	->cb (sub {
375	my ($iow, $revents) = @_;	1104	my ($iow, $revents) = @_;
376	# $revents must be 1 here, no need to check	1105	# $revents must be 1 here, no need to check
377	sysread $term->{socket}, my $buf, 8192	1106	sysread $term->{socket}, my $buf, 8192
…		…
387		1116
388	$iow = $iow->fd ($fd)	1117	$iow = $iow->fd ($fd)
389	Set the filedescriptor (not handle) to watch.	1118	Set the filedescriptor (not handle) to watch.
390		1119
391	$iow = $iow->events ($eventmask)	1120	$iow = $iow->events ($eventmask)
392	Set the event mask to watch. Bit #0 (value 1) enables watching for	1121	Set the event mask to watch. The only allowed values are
393	read data, Bit #1 (value 2) enables watching for write data.	1122	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1123	together, or "urxvt::EVENT_NONE".
394		1124
395	$iow = $iow->start	1125	$iow = $iow->start
396	Start watching for requested events on the given handle.	1126	Start watching for requested events on the given handle.
397		1127
398	$iow = $iow->stop	1128	$iow = $iow->stop
399	Stop watching for events on the given filehandle.	1129	Stop watching for events on the given filehandle.
		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.
400		1173
401	ENVIRONMENT	1174	ENVIRONMENT
402	URXVT_PERL_VERBOSITY	1175	URXVT_PERL_VERBOSITY
403	This variable controls the verbosity level of the perl extension. Higher	1176	This variable controls the verbosity level of the perl extension. Higher
404	numbers indicate more verbose output.	1177	numbers indicate more verbose output.
405		1178
406	0 - only fatal messages	1179	== 0 - fatal messages
407	3 - script loading and management	1180	>= 3 - script loading and management
408	10 - all events received	1181	>=10 - all called hooks
		1182	>=11 - hook reutrn values
409		1183
410	AUTHOR	1184	AUTHOR
411	Marc Lehmann <pcg@goof.com>	1185	Marc Lehmann <pcg@goof.com>
412	http://software.schmorp.de/pkg/rxvt-unicode	1186	http://software.schmorp.de/pkg/rxvt-unicode
413		1187

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.4 by root, Tue Jan 3 01:39:56 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.4 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.37 by root, Wed Jan 25 21:48:47 2006 UTC