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

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

…		…
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	Prepackaged 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	Or by adding them to the resource for extensions loaded by default:
		35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		37
34	selection (enabled by default)	38	selection (enabled by default)
35	Intelligent selection. This extension tries to be more intelligent	39	(More) intelligent selection. This extension tries to be more
36	when the user extends selections (double-click). Right now, it tries	40	intelligent when the user extends selections (double-click and
37	to select urls and complete shell-quoted arguments, which is very	41	further clicks). Right now, it tries to select words, urls and
		42	complete shell-quoted arguments, which is very convenient, too, if
38	convenient, too, if your ls supports "--quoting-style=shell".	43	your ls supports "--quoting-style=shell".
39		44
40	It also offers the following bindable event:	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:
41		74
42	rot13	75	rot13
43	Rot-13 the selection when activated. Used via keyboard trigger:	76	Rot-13 the selection when activated. Used via keyboard trigger:
44		77
45	URxvt.keysym.C-M-r: perl:selection:rot13	78	URxvt.keysym.C-M-r: perl:selection:rot13
…		…
48	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)	81	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
49	options at runtime.	82	options at runtime.
50		83
51	selection-popup (enabled by default)	84	selection-popup (enabled by default)
52	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
53	selection text into various other formats/action.	86	selection text into various other formats/action (such as uri
		87	unescaping, perl evaluation, web-browser starting etc.), depending
		88	on content.
54		89
55	digital-clock	90	Other extensions can extend this popup menu by pushing a code
56	Displays a digital clock using the built-in overlay.	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.
57		187
58	mark-urls	188	mark-urls
59	Uses per-line display filtering ("on_line_update") to underline	189	Uses per-line display filtering ("on_line_update") to underline urls
60	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
61		212
62	block-graphics-to-ascii	213	block-graphics-to-ascii
63	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
64	terminal, by replacing all line-drawing characters (U+2500 ..	215	terminal, by replacing all line-drawing characters (U+2500 ..
65	U+259F) by a similar-looking ascii character.	216	U+259F) by a similar-looking ascii character.
66		217
		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
67	example-refresh-hooks	268	example-refresh-hooks
68	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
69	the window. Illustrates overwriting the refresh callbacks to create	270	the window. Illustrates overwriting the refresh callbacks to create
70	your own overlays or changes.	271	your own overlays or changes.
71		272
		273	API DOCUMENTATION
72	General API Considerations	274	General API Considerations
73	All objects (such as terminals, time watchers etc.) are typical	275	All objects (such as terminals, time watchers etc.) are typical
74	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
75	like. All members starting with an underscore (such as "_ptr" or	277	like. All members starting with an underscore (such as "_ptr" or
76	"_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
…		…
84	Argument names also often indicate the type of a parameter. Here are	286	Argument names also often indicate the type of a parameter. Here are
85	some hints on what they mean:	287	some hints on what they mean:
86		288
87	$text	289	$text
88	Rxvt-unicodes special way of encoding text, where one "unicode"	290	Rxvt-unicodes special way of encoding text, where one "unicode"
89	character always represents one screen cell. See row_t for a	291	character always represents one screen cell. See ROW_t for a
90	discussion of this format.	292	discussion of this format.
91		293
92	$string	294	$string
93	A perl text string, with an emphasis on text. It can store all	295	A perl text string, with an emphasis on text. It can store all
94	unicode characters and is to be distinguished with text encoded in a	296	unicode characters and is to be distinguished with text encoded in a
…		…
96		298
97	$octets	299	$octets
98	Either binary data or - more common - a text string encoded in a	300	Either binary data or - more common - a text string encoded in a
99	locale-specific way.	301	locale-specific way.
100		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
101	Hooks	328	Hooks
102	The following subroutines can be declared in extension files, and will	329	The following subroutines can be declared in extension files, and will
103	be called whenever the relevant event happens.	330	be called whenever the relevant event happens.
104		331
105	The first argument passed to them is an object private to each terminal	332	The first argument passed to them is an extension oject as described in
106	and extension package. You can call all "urxvt::term" methods on it, but	333	the in the "Extension Objects" section.
107	its not a real "urxvt::term" object. Instead, the real "urxvt::term"
108	object that is shared between all packages is stored in the "term"
109	member. It is, however, blessed intot he package of the extension
110	script, so for all practical purposes you can treat an extension script
111	as a class.
112		334
113	All of them must return a boolean value. If it is true, then the event	335	All of these hooks must return a boolean value. If any of the called
114	counts as being consumed, and the invocation of other hooks is	336	hooks returns true, then the event counts as being consumed, and the
115	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.
116	code.
117		338
118	When in doubt, return a false value (preferably "()").	339	When in doubt, return a false value (preferably "()").
119		340
120	on_init $term	341	on_init $term
121	Called after a new terminal object has been initialized, but before	342	Called after a new terminal object has been initialized, but before
122	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
123	to call or deliver senseless data, as terminal size and other	344	to call or deliver senseless data, as terminal size and other
124	characteristics have not yet been determined. You can safely query	345	characteristics have not yet been determined. You can safely query
125	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).
126		357
127	on_reset $term	358	on_reset $term
128	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
129	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
130	size-related variables.	361	size-related variables.
131		362
132	on_start $term	363	on_child_start $term, $pid
133	Called at the very end of initialisation of a new terminal, just	364	Called just after the child process has been "fork"ed.
134	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".
135		369
136	on_sel_make $term, $eventtime	370	on_sel_make $term, $eventtime
137	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
138	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
139	type of the selection will be honored.	373	type of the selection will be honored.
…		…
152		386
153	on_sel_extend $term	387	on_sel_extend $term
154	Called whenever the user tries to extend the selection (e.g. with a	388	Called whenever the user tries to extend the selection (e.g. with a
155	double click) and is either supposed to return false (normal	389	double click) and is either supposed to return false (normal
156	operation), or should extend the selection itelf and return true to	390	operation), or should extend the selection itelf and return true to
157	suppress the built-in processing.	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.
158		395
159	See the selection example extension.	396	See the selection example extension.
160		397
161	on_view_change $term, $offset	398	on_view_change $term, $offset
162	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
…		…
189	argument. You can filter/change and output the text yourself by	426	argument. You can filter/change and output the text yourself by
190	returning a true value and calling "$term->scr_add_lines" yourself.	427	returning a true value and calling "$term->scr_add_lines" yourself.
191	Please note that this might be very slow, however, as your hook is	428	Please note that this might be very slow, however, as your hook is
192	called for all text being output.	429	called for all text being output.
193		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
194	on_line_update $term, $row	435	on_line_update $term, $row
195	Called whenever a line was updated or changed. Can be used to filter	436	Called whenever a line was updated or changed. Can be used to filter
196	screen output (e.g. underline urls or other useless stuff). Only	437	screen output (e.g. underline urls or other useless stuff). Only
197	lines that are being shown will be filtered, and, due to performance	438	lines that are being shown will be filtered, and, due to performance
198	reasons, not always immediately.	439	reasons, not always immediately.
…		…
212	display code is run after this hook, and takes precedence.	453	display code is run after this hook, and takes precedence.
213		454
214	on_refresh_end $term	455	on_refresh_end $term
215	Called just after the screen gets redrawn. See "on_refresh_begin".	456	Called just after the screen gets redrawn. See "on_refresh_begin".
216		457
217	on_keyboard_command $term, $string	458	on_user_command $term, $string
218	Called whenever the user presses a key combination that has a	459	Called whenever the a user-configured event is being activated (e.g.
219	"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
220	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.
221		470
222	on_focus_in $term	471	on_focus_in $term
223	Called whenever the window gets the keyboard focus, before	472	Called whenever the window gets the keyboard focus, before
224	rxvt-unicode does focus in processing.	473	rxvt-unicode does focus in processing.
225		474
226	on_focus_out $term	475	on_focus_out $term
227	Called wheneever the window loses keyboard focus, before	476	Called wheneever the window loses keyboard focus, before
228	rxvt-unicode does focus out processing.	477	rxvt-unicode does focus out processing.
229		478
		479	on_configure_notify $term, $event
		480	on_property_notify $term, $event
230	on_key_press $term, $event, $octets	481	on_key_press $term, $event, $keysym, $octets
231	on_key_release $term, $event	482	on_key_release $term, $event, $keysym
232	on_button_press $term, $event	483	on_button_press $term, $event
233	on_button_release $term, $event	484	on_button_release $term, $event
234	on_motion_notify $term, $event	485	on_motion_notify $term, $event
235	on_map_notify $term, $event	486	on_map_notify $term, $event
236	on_unmap_notify $term, $event	487	on_unmap_notify $term, $event
…		…
238	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
239	rxvt-unicode.	490	rxvt-unicode.
240		491
241	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
242	XEvent manpage), with the additional members "row" and "col", which	493	XEvent manpage), with the additional members "row" and "col", which
243	are the row and column under the mouse cursor.	494	are the (real, not screen-based) row and column under the mouse
		495	cursor.
244		496
245	"on_key_press" additionally receives the string rxvt-unicode would	497	"on_key_press" additionally receives the string rxvt-unicode would
246	output, if any, in locale-specific encoding.	498	output, if any, in locale-specific encoding.
247		499
248	subwindow.	500	subwindow.
249		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
250	Variables in the "urxvt" Package	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
251	$urxvt::TERM	520	$urxvt::TERM
252	The current terminal. This variable stores the current "urxvt::term"	521	The current terminal. This variable stores the current "urxvt::term"
253	object, whenever a callback/hook is executing.	522	object, whenever a callback/hook is executing.
254		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.
		539
255	Functions in the "urxvt" Package	540	Functions in the "urxvt" Package
256	$term = new urxvt [arg...]
257	Creates a new terminal, very similar as if you had started it with
258	"system $binfile, arg...". Croaks (and probably outputs an error
259	message) if the new instance couldn't be created. Returns "undef" if
260	the new instance didn't initialise perl, and the terminal object
261	otherwise. The "init" and "start" hooks will be called during the
262	call.
263
264	urxvt::fatal $errormessage	541	urxvt::fatal $errormessage
265	Fatally aborts execution with the given error message. Avoid at all	542	Fatally aborts execution with the given error message. Avoid at all
266	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
267	starts up.	544	starts up.
268		545
…		…
272	function that calls this function.	549	function that calls this function.
273		550
274	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
275	correct place, e.g. on stderr of the connecting urxvtc client.	552	correct place, e.g. on stderr of the connecting urxvtc client.
276		553
		554	Messages have a size limit of 1023 bytes currently.
		555
277	$time = urxvt::NOW	556	$time = urxvt::NOW
278	Returns the "current time" (as per the event loop).	557	Returns the "current time" (as per the event loop).
279		558
280	urxvt::CurrentTime	559	urxvt::CurrentTime
281	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	560	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
282	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	561	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
283	Button5Mask, AnyModifier	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
284	Various constants for use in X calls and event processing.	578	Various constants for use in X calls and event processing.
285		579
286	RENDITION	580	RENDITION
287	Rendition bitsets contain information about colour, font, font styles	581	Rendition bitsets contain information about colour, font, font styles
288	and similar information for each screen cell.	582	and similar information for each screen cell.
…		…
307		601
308	$foreground = urxvt::GET_BASEFG $rend	602	$foreground = urxvt::GET_BASEFG $rend
309	$background = urxvt::GET_BASEBG $rend	603	$background = urxvt::GET_BASEBG $rend
310	Return the foreground/background colour index, respectively.	604	Return the foreground/background colour index, respectively.
311		605
312	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	606	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
313	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	607	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
314	Replace the foreground/background colour in the rendition mask with	608	Replace the foreground/background colour in the rendition mask with
315	the specified one.	609	the specified one.
316		610
317	$value = urxvt::GET_CUSTOM ($rend)	611	$value = urxvt::GET_CUSTOM $rend
318	Return the "custom" value: Every rendition has 5 bits for use by	612	Return the "custom" value: Every rendition has 5 bits for use by
319	extensions. They can be set and changed as you like and are	613	extensions. They can be set and changed as you like and are
320	initially zero.	614	initially zero.
321		615
322	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	616	$rend = urxvt::SET_CUSTOM $rend, $new_value
323	Change the custom value.	617	Change the custom value.
324		618
325	The "urxvt::anyevent" Class	619	The "urxvt::anyevent" Class
326	The sole purpose of this class is to deliver an interface to the	620	The sole purpose of this class is to deliver an interface to the
327	"AnyEvent" module - any module using it will work inside urxvt without	621	"AnyEvent" module - any module using it will work inside urxvt without
328	further work. The only exception is that you cannot wait on condition	622	further programming. The only exception is that you cannot wait on
329	variables, but non-blocking condvar use is ok. What this means is that	623	condition variables, but non-blocking condvar use is ok. What this means
330	you cannot use blocking APIs, but the non-blocking variant should work.	624	is that you cannot use blocking APIs, but the non-blocking variant
		625	should work.
331		626
332	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
333	$term->destroy	638	$term->destroy
334	Destroy the terminal object (close the window, free resources etc.).	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.
335		651
336	$isset = $term->option ($optval[, $set])	652	$isset = $term->option ($optval[, $set])
337	Returns true if the option specified by $optval is enabled, and	653	Returns true if the option specified by $optval is enabled, and
338	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
339	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
…		…
342	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
343	the source file /src/optinc.h to see the actual list:	659	the source file /src/optinc.h to see the actual list:
344		660
345	borderLess console cursorBlink cursorUnderline hold iconic insecure	661	borderLess console cursorBlink cursorUnderline hold iconic insecure
346	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	662	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
347	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	663	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
348	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	664	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
349	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	665	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
350	tripleclickwords utmpInhibit visualBell	666	transparent tripleclickwords utmpInhibit visualBell
351		667
352	$value = $term->resource ($name[, $newval])	668	$value = $term->resource ($name[, $newval])
353	Returns the current resource value associated with a given name and	669	Returns the current resource value associated with a given name and
354	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
355	"init" hook. Unset resources are returned and accepted as "undef".	671	"init" hook. Unset resources are returned and accepted as "undef".
…		…
372		688
373	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	689	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
374	borderLess color cursorBlink cursorUnderline cutchars delete_key	690	borderLess color cursorBlink cursorUnderline cutchars delete_key
375	display_name embed ext_bwidth fade font geometry hold iconName	691	display_name embed ext_bwidth fade font geometry hold iconName
376	imFont imLocale inputMethod insecure int_bwidth intensityStyles	692	imFont imLocale inputMethod insecure int_bwidth intensityStyles
377	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	693	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
378	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	694	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
379	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	695	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
380	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	696	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
381	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	697	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
382	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	698	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		699	secondaryScreen secondaryScroll selectstyle shade term_name title
383	shade term_name title transparent transparent_all tripleclickwords	700	transient_for transparent transparent_all tripleclickwords utmpInhibit
384	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.
385		716
386	$rend = $term->rstyle ([$new_rstyle])	717	$rend = $term->rstyle ([$new_rstyle])
387	Return and optionally change the current rendition. Text that is	718	Return and optionally change the current rendition. Text that is
388	output by the terminal application will use this style.	719	output by the terminal application will use this style.
389		720
…		…
396	($row, $col) = $term->selection_beg ([$row, $col])	727	($row, $col) = $term->selection_beg ([$row, $col])
397	($row, $col) = $term->selection_end ([$row, $col])	728	($row, $col) = $term->selection_end ([$row, $col])
398	Return the current values of the selection mark, begin or end	729	Return the current values of the selection mark, begin or end
399	positions, and optionally set them to new values.	730	positions, and optionally set them to new values.
400		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
401	$success = $term->selection_grab ($eventtime)	738	$success = $term->selection_grab ($eventtime)
402	Try to request the primary selection from the server (for example,	739	Try to request the primary selection text from the server (for
403	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.
404		743
405	$oldtext = $term->selection ([$newtext])	744	$oldtext = $term->selection ([$newtext])
406	Return the current selection text and optionally replace it by	745	Return the current selection text and optionally replace it by
407	$newtext.	746	$newtext.
408		747
409	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	748	$term->overlay_simple ($x, $y, $text)
410	overlay box. See the next method for details. # #=cut # #sub	749	Create a simple multi-line overlay box. See the next method for
411	urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my	750	details.
412	@lines = split /\n/, $text; # # my $w = 0; # for (map
413	$self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # #
414	$self->scr_overlay_new ($x, $y, $w, scalar @lines); #
415	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #}
416		751
417	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	752	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
418	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
419	width/height. $rstyle defines the initial rendition style (default:	754	width/height. $rstyle defines the initial rendition style (default:
420	"OVERLAY_RSTYLE").	755	"OVERLAY_RSTYLE").
…		…
454	Convert the given text string into the corresponding locale	789	Convert the given text string into the corresponding locale
455	encoding.	790	encoding.
456		791
457	$string = $term->locale_decode ($octets)	792	$string = $term->locale_decode ($octets)
458	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!
459		810
460	$term->scr_add_lines ($string)	811	$term->scr_add_lines ($string)
461	Write the given text string to the screen, as if output by the	812	Write the given text string to the screen, as if output by the
462	application running inside the terminal. It may not contain command	813	application running inside the terminal. It may not contain command
463	sequences (escape codes), but is free to use line feeds, carriage	814	sequences (escape codes), but is free to use line feeds, carriage
…		…
466		817
467	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
468	be confused by changes in cursor position or scrolling. Its useful	819	be confused by changes in cursor position or scrolling. Its useful
469	inside a "on_add_lines" hook, though.	820	inside a "on_add_lines" hook, though.
470		821
		822	$term->scr_change_screen ($screen)
		823	Switch to given screen - 0 primary, 1 secondary.
		824
471	$term->cmd_parse ($octets)	825	$term->cmd_parse ($octets)
472	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
473	locale-specific encoding of the terminal and can contain command	827	locale-specific encoding of the terminal and can contain command
474	sequences (escape codes) that will be interpreted.	828	sequences (escape codes) that will be interpreted.
475		829
…		…
477	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).
478	To pass characters instead of octets, you should convert your	832	To pass characters instead of octets, you should convert your
479	strings first to the locale-specific encoding using	833	strings first to the locale-specific encoding using
480	"$term->locale_encode".	834	"$term->locale_encode".
481		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
482	$windowid = $term->parent	846	$windowid = $term->parent
483	Return the window id of the toplevel window.	847	Return the window id of the toplevel window.
484		848
485	$windowid = $term->vt	849	$windowid = $term->vt
486	Return the window id of the terminal window.	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);
487		857
488	$window_width = $term->width	858	$window_width = $term->width
489	$window_height = $term->height	859	$window_height = $term->height
490	$font_width = $term->fwidth	860	$font_width = $term->fwidth
491	$font_height = $term->fheight	861	$font_height = $term->fheight
…		…
494	$terminal_columns = $term->ncol	864	$terminal_columns = $term->ncol
495	$has_focus = $term->focus	865	$has_focus = $term->focus
496	$is_mapped = $term->mapped	866	$is_mapped = $term->mapped
497	$max_scrollback = $term->saveLines	867	$max_scrollback = $term->saveLines
498	$nrow_plus_saveLines = $term->total_rows	868	$nrow_plus_saveLines = $term->total_rows
499	$lines_in_scrollback = $term->nsaved	869	$topmost_scrollback_row = $term->top_row
500	Return various integers describing terminal characteristics.	870	Return various integers describing terminal characteristics.
		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
		878	$env = $term->env
		879	Returns a copy of the environment in effect for the terminal as a
		880	hashref similar to "\%ENV".
501		881
502	$modifiermask = $term->ModLevel3Mask	882	$modifiermask = $term->ModLevel3Mask
503	$modifiermask = $term->ModMetaMask	883	$modifiermask = $term->ModMetaMask
504	$modifiermask = $term->ModNumLockMask	884	$modifiermask = $term->ModNumLockMask
505	Return the modifier masks corresponding to the "ISO Level 3 Shift"	885	Return the modifier masks corresponding to the "ISO Level 3 Shift"
506	(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
507	applicable.	887	applicable.
508		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
509	$view_start = $term->view_start ([$newvalue])	895	$view_start = $term->view_start ([$newvalue])
510	Returns the negative row number of the topmost line. Minimum value	896	Returns the row number of the topmost displayed line. Maximum value
511	is 0, which displays the normal terminal contents. Larger values	897	is 0, which displays the normal terminal contents. Lower values
512	scroll this many lines into the scrollback buffer.	898	scroll this many lines into the scrollback buffer.
513		899
514	$term->want_refresh	900	$term->want_refresh
515	Requests a screen refresh. At the next opportunity, rxvt-unicode	901	Requests a screen refresh. At the next opportunity, rxvt-unicode
516	will compare the on-screen display with its stored representation.	902	will compare the on-screen display with its stored representation.
…		…
529	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
530	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
531	automatically be updated.	917	automatically be updated.
532		918
533	$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
534	more than one cell when displayed are padded with urxvt::NOCHAR	920	more than one cell when displayed are padded with $urxvt::NOCHAR
535	characters ("chr 65535"). Characters with combining characters and	921	(chr 65535) characters. Characters with combining characters and
536	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
537	be replaced with characters in the private use area.	923	be replaced with characters in the private use area.
538		924
539	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
540	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
…		…
584	Return the row number of the first/last row of the line,	970	Return the row number of the first/last row of the line,
585	respectively.	971	respectively.
586		972
587	$offset = $line->offset_of ($row, $col)	973	$offset = $line->offset_of ($row, $col)
588	Returns the character offset of the given row\|col pair within	974	Returns the character offset of the given row\|col pair within
589	the logical line.	975	the logical line. Works for rows outside the line, too, and
		976	returns corresponding offsets outside the string.
590		977
591	($row, $col) = $line->coord_of ($offset)	978	($row, $col) = $line->coord_of ($offset)
592	Translates a string offset into terminal coordinates again.	979	Translates a string offset into terminal coordinates again.
593		980
594	$text = $term->special_encode $string	981	$text = $term->special_encode $string
…		…
599	$string = $term->special_decode $text	986	$string = $term->special_decode $text
600	Converts rxvt-unicodes text reprsentation into a perl string. See	987	Converts rxvt-unicodes text reprsentation into a perl string. See
601	"$term->ROW_t" for details.	988	"$term->ROW_t" for details.
602		989
603	$success = $term->grab_button ($button, $modifiermask)	990	$success = $term->grab_button ($button, $modifiermask)
604	Registers a synchronous button grab. See XGrabButton.	991	Registers a synchronous button grab. See the XGrabButton manpage.
605		992
606	$success = $term->grab ($eventtime[, $sync])	993	$success = $term->grab ($eventtime[, $sync])
607	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	994	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
608	synchronous ($sync is true). Also remembers the grab timestampe.	995	synchronous ($sync is true). Also remembers the grab timestampe.
609		996
…		…
620	$term->ungrab	1007	$term->ungrab
621	Calls XUngrab for the most recent grab. Is called automatically on	1008	Calls XUngrab for the most recent grab. Is called automatically on
622	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
623	case as the session.	1010	case as the session.
624		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
625	The "urxvt::popup" Class	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).
		1050
626	The "urxvt::timer" Class	1051	The "urxvt::timer" Class
627	This class implements timer watchers/events. Time is represented as	1052	This class implements timer watchers/events. Time is represented as a
628	a fractional number of seconds since the epoch. Example:	1053	fractional number of seconds since the epoch. Example:
629		1054
630	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);	1055	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
631	$term->{timer} = urxvt::timer	1056	$term->{timer} = urxvt::timer
632	->new	1057	->new
633	->interval (1)	1058	->interval (1)
634	->cb (sub {	1059	->cb (sub {
635	$term->{overlay}->set (0, 0,	1060	$term->{overlay}->set (0, 0,
636	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
637	});	1062	});
638		1063
639	$timer = new urxvt::timer	1064	$timer = new urxvt::timer
640	Create a new timer object in started state. It is scheduled to	1065	Create a new timer object in started state. It is scheduled to fire
641	fire immediately.	1066	immediately.
642		1067
643	$timer = $timer->cb (sub { my ($timer) = @_; ... })	1068	$timer = $timer->cb (sub { my ($timer) = @_; ... })
644	Set the callback to be called when the timer triggers.	1069	Set the callback to be called when the timer triggers.
645		1070
646	$tstamp = $timer->at	1071	$tstamp = $timer->at
647	Return the time this watcher will fire next.	1072	Return the time this watcher will fire next.
648		1073
649	$timer = $timer->set ($tstamp)	1074	$timer = $timer->set ($tstamp)
650	Set the time the event is generated to $tstamp.	1075	Set the time the event is generated to $tstamp.
651		1076
652	$timer = $timer->interval ($interval)	1077	$timer = $timer->interval ($interval)
653	Normally (and when $interval is 0), the timer will automatically	1078	Normally (and when $interval is 0), the timer will automatically
654	stop after it has fired once. If $interval is non-zero, then the	1079	stop after it has fired once. If $interval is non-zero, then the
655	timer is automatically rescheduled at the given intervals.	1080	timer is automatically rescheduled at the given intervals.
656		1081
657	$timer = $timer->start	1082	$timer = $timer->start
658	Start the timer.	1083	Start the timer.
659		1084
660	$timer = $timer->start ($tstamp)	1085	$timer = $timer->start ($tstamp)
661	Set the event trigger time to $tstamp and start the timer.	1086	Set the event trigger time to $tstamp and start the timer.
662		1087
		1088	$timer = $timer->after ($delay)
		1089	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
		1090
663	$timer = $timer->stop	1091	$timer = $timer->stop
664	Stop the timer.	1092	Stop the timer.
665		1093
666	The "urxvt::iow" Class	1094	The "urxvt::iow" Class
667	This class implements io watchers/events. Example:	1095	This class implements io watchers/events. Example:
668		1096
669	$term->{socket} = ...	1097	$term->{socket} = ...
670	$term->{iow} = urxvt::iow	1098	$term->{iow} = urxvt::iow
		1099	->new
		1100	->fd (fileno $term->{socket})
		1101	->events (urxvt::EVENT_READ)
		1102	->start
		1103	->cb (sub {
		1104	my ($iow, $revents) = @_;
		1105	# $revents must be 1 here, no need to check
		1106	sysread $term->{socket}, my $buf, 8192
		1107	or end-of-file;
		1108	});
		1109
		1110	$iow = new urxvt::iow
		1111	Create a new io watcher object in stopped state.
		1112
		1113	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
		1114	Set the callback to be called when io events are triggered.
		1115	$reventmask is a bitset as described in the "events" method.
		1116
		1117	$iow = $iow->fd ($fd)
		1118	Set the filedescriptor (not handle) to watch.
		1119
		1120	$iow = $iow->events ($eventmask)
		1121	Set the event mask to watch. The only allowed values are
		1122	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1123	together, or "urxvt::EVENT_NONE".
		1124
		1125	$iow = $iow->start
		1126	Start watching for requested events on the given handle.
		1127
		1128	$iow = $iow->stop
		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
671	->new	1155	->new
672	->fd (fileno $term->{socket})
673	->events (1) # wait for read data
674	->start	1156	->start ($pid)
675	->cb (sub {	1157	->cb (sub {
676	my ($iow, $revents) = @_;	1158	my ($pw, $exit_status) = @_;
677	# $revents must be 1 here, no need to check
678	sysread $term->{socket}, my $buf, 8192
679	or end-of-file;
680	});	1159	...
		1160	});
681		1161
682	$iow = new urxvt::iow	1162	$pw = new urxvt::pw
683	Create a new io watcher object in stopped state.	1163	Create a new process watcher in stopped state.
684		1164
685	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	1165	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
686	Set the callback to be called when io events are triggered.	1166	Set the callback to be called when the timer triggers.
687	$reventmask is a bitset as described in the "events" method.
688		1167
689	$iow = $iow->fd ($fd)	1168	$pw = $timer->start ($pid)
690	Set the filedescriptor (not handle) to watch.	1169	Tells the wqtcher to start watching for process $pid.
691		1170
692	$iow = $iow->events ($eventmask)
693	Set the event mask to watch. Bit #0 (value 1) enables watching
694	for read data, Bit #1 (value 2) enables watching for write data.
695
696	$iow = $iow->start
697	Start watching for requested events on the given handle.
698
699	$iow = $iow->stop	1171	$pw = $pw->stop
700	Stop watching for events on the given filehandle.	1172	Stop the watcher.
701		1173
702	ENVIRONMENT	1174	ENVIRONMENT
703	URXVT_PERL_VERBOSITY	1175	URXVT_PERL_VERBOSITY
704	This variable controls the verbosity level of the perl extension.	1176	This variable controls the verbosity level of the perl extension. Higher
705	Higher numbers indicate more verbose output.	1177	numbers indicate more verbose output.
706		1178
707	== 0 - fatal messages	1179	== 0 - fatal messages
708	>= 3 - script loading and management	1180	>= 3 - script loading and management
709	>=10 - all events received	1181	>=10 - all called hooks
		1182	>=11 - hook reutrn values
710		1183
711	AUTHOR	1184	AUTHOR
712	Marc Lehmann <pcg@goof.com>	1185	Marc Lehmann <pcg@goof.com>
713	http://software.schmorp.de/pkg/rxvt-unicode	1186	http://software.schmorp.de/pkg/rxvt-unicode
714		1187

Diff Legend

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

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