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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.14 by root, Sun Jan 8 06:35:38 2006 UTC vs.
Revision 1.36 by root, Wed Jan 25 00:57:57 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
46		79
47	option-popup (enabled by default)	80	option-popup (enabled by default)
48	Binds a popup menu to Ctrl-Button3 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	digital-clock	84	selection-popup (enabled by default)
52	Displays a digital clock using the built-in overlay.	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.
53		187
54	mark-urls	188	mark-urls
55	Uses per-line display filtering ("on_line_update") to underline	189	Uses per-line display filtering ("on_line_update") to underline urls
56	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
57		212
58	block-graphics-to-ascii	213	block-graphics-to-ascii
59	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
60	terminal, by replacing all line-drawing characters (U+2500 ..	215	terminal, by replacing all line-drawing characters (U+2500 ..
61	U+259F) by a similar-looking ascii character.	216	U+259F) by a similar-looking ascii character.
62		217
		218	digital-clock
		219	Displays a digital clock using the built-in overlay.
		220
63	example-refresh-hooks	221	example-refresh-hooks
64	Displays a very simple digital clock in the upper right corner of	222	Displays a very simple digital clock in the upper right corner of
65	the window. Illustrates overwriting the refresh callbacks to create	223	the window. Illustrates overwriting the refresh callbacks to create
66	your own overlays or changes.	224	your own overlays or changes.
67		225
		226	selection-pastebin
		227	This is a little rarely useful extension that Uploads the selection
		228	as textfile to a remote site (or does other things). (The
		229	implementation is not currently secure for use in a multiuser
		230	environment as it writes to /tmp directly.).
		231
		232	It listens to the "selection-pastebin:remote-pastebin" keyboard
		233	command, i.e.
		234
		235	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		236
		237	Pressing this combination runs a command with "%" replaced by the
		238	name of the textfile. This command can be set via a resource:
		239
		240	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		241
		242	And the default is likely not useful to anybody but the few people
		243	around here :)
		244
		245	The name of the textfile is the hex encoded md5 sum of the
		246	selection, so the same content should lead to the same filename.
		247
		248	After a successful upload the selection will be replaced by the text
		249	given in the "selection-pastebin-url" resource (again, the % is the
		250	placeholder for the filename):
		251
		252	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		253
		254	API DOCUMENTATION
68	General API Considerations	255	General API Considerations
69	All objects (such as terminals, time watchers etc.) are typical	256	All objects (such as terminals, time watchers etc.) are typical
70	reference-to-hash objects. The hash can be used to store anything you	257	reference-to-hash objects. The hash can be used to store anything you
71	like. All members starting with an underscore (such as "_ptr" or	258	like. All members starting with an underscore (such as "_ptr" or
72	"_hook") are reserved for internal uses and MUST NOT be accessed or	259	"_hook") are reserved for internal uses and MUST NOT be accessed or
…		…
80	Argument names also often indicate the type of a parameter. Here are	267	Argument names also often indicate the type of a parameter. Here are
81	some hints on what they mean:	268	some hints on what they mean:
82		269
83	$text	270	$text
84	Rxvt-unicodes special way of encoding text, where one "unicode"	271	Rxvt-unicodes special way of encoding text, where one "unicode"
85	character always represents one screen cell. See row_t for a	272	character always represents one screen cell. See ROW_t for a
86	discussion of this format.	273	discussion of this format.
87		274
88	$string	275	$string
89	A perl text string, with an emphasis on text. It can store all	276	A perl text string, with an emphasis on text. It can store all
90	unicode characters and is to be distinguished with text encoded in a	277	unicode characters and is to be distinguished with text encoded in a
…		…
92		279
93	$octets	280	$octets
94	Either binary data or - more common - a text string encoded in a	281	Either binary data or - more common - a text string encoded in a
95	locale-specific way.	282	locale-specific way.
96		283
		284	Extension Objects
		285	Very perl extension is a perl class. A separate perl object is created
		286	for each terminal and each extension and passed as the first parameter
		287	to hooks. So extensions can use their $self object without having to
		288	think about other extensions, with the exception of methods and members
		289	that begin with an underscore character "_": these are reserved for
		290	internal use.
		291
		292	Although it isn't a "urxvt::term" object, you can call all methods of
		293	the "urxvt::term" class on this object.
		294
		295	It has the following methods and data members:
		296
		297	$urxvt_term = $self->{term}
		298	Returns the "urxvt::term" object associated with this instance of
		299	the extension. This member must not be changed in any way.
		300
		301	$self->enable ($hook_name => $cb, [$hook_name => $cb..])
		302	Dynamically enable the given hooks (named without the "on_" prefix)
		303	for this extension, replacing any previous hook. This is useful when
		304	you want to overwrite time-critical hooks only temporarily.
		305
		306	$self->disable ($hook_name[, $hook_name..])
		307	Dynamically disable the given hooks.
		308
97	Hooks	309	Hooks
98	The following subroutines can be declared in extension files, and will	310	The following subroutines can be declared in extension files, and will
99	be called whenever the relevant event happens.	311	be called whenever the relevant event happens.
100		312
101	The first argument passed to them is an object private to each terminal	313	The first argument passed to them is an extension oject as described in
102	and extension package. You can call all "urxvt::term" methods on it, but	314	the in the "Extension Objects" section.
103	its not a real "urxvt::term" object. Instead, the real "urxvt::term"
104	object that is shared between all packages is stored in the "term"
105	member. It is, however, blessed intot he package of the extension
106	script, so for all practical purposes you can treat an extension script
107	as a class.
108		315
109	All of them must return a boolean value. If it is true, then the event	316	All of these hooks must return a boolean value. If any of the called
110	counts as being consumed, and the invocation of other hooks is	317	hooks returns true, then the event counts as being consumed, and the
111	skipped, and the relevant action might not be carried out by the C++	318	relevant action might not be carried out by the C++ code.
112	code.
113		319
114	When in doubt, return a false value (preferably "()").	320	When in doubt, return a false value (preferably "()").
115		321
116	on_init $term	322	on_init $term
117	Called after a new terminal object has been initialized, but before	323	Called after a new terminal object has been initialized, but before
118	windows are created or the command gets run. Most methods are unsafe	324	windows are created or the command gets run. Most methods are unsafe
119	to call or deliver senseless data, as terminal size and other	325	to call or deliver senseless data, as terminal size and other
120	characteristics have not yet been determined. You can safely query	326	characteristics have not yet been determined. You can safely query
121	and change resources, though.	327	and change resources and options, though. For many purposes the
		328	"on_start" hook is a better place.
		329
		330	on_start $term
		331	Called at the very end of initialisation of a new terminal, just
		332	before trying to map (display) the toplevel and returning to the
		333	mainloop.
		334
		335	on_destroy $term
		336	Called whenever something tries to destroy terminal, when the
		337	terminal is still fully functional (not for long, though).
122		338
123	on_reset $term	339	on_reset $term
124	Called after the screen is "reset" for any reason, such as resizing	340	Called after the screen is "reset" for any reason, such as resizing
125	or control sequences. Here is where you can react on changes to	341	or control sequences. Here is where you can react on changes to
126	size-related variables.	342	size-related variables.
127		343
128	on_start $term	344	on_child_start $term, $pid
129	Called at the very end of initialisation of a new terminal, just	345	Called just after the child process has been "fork"ed.
130	before returning to the mainloop.	346
		347	on_child_exit $term, $status
		348	Called just after the child process has exited. $status is the
		349	status from "waitpid".
131		350
132	on_sel_make $term, $eventtime	351	on_sel_make $term, $eventtime
133	Called whenever a selection has been made by the user, but before	352	Called whenever a selection has been made by the user, but before
134	the selection text is copied, so changes to the beginning, end or	353	the selection text is copied, so changes to the beginning, end or
135	type of the selection will be honored.	354	type of the selection will be honored.
…		…
148		367
149	on_sel_extend $term	368	on_sel_extend $term
150	Called whenever the user tries to extend the selection (e.g. with a	369	Called whenever the user tries to extend the selection (e.g. with a
151	double click) and is either supposed to return false (normal	370	double click) and is either supposed to return false (normal
152	operation), or should extend the selection itelf and return true to	371	operation), or should extend the selection itelf and return true to
153	suppress the built-in processing.	372	suppress the built-in processing. This can happen multiple times, as
		373	long as the callback returns true, it will be called on every
		374	further click by the user and is supposed to enlarge the selection
		375	more and more, if possible.
154		376
155	See the selection example extension.	377	See the selection example extension.
156		378
157	on_view_change $term, $offset	379	on_view_change $term, $offset
158	Called whenever the view offset changes, i..e the user or program	380	Called whenever the view offset changes, i..e the user or program
…		…
165	may be larger than the scroll back buffer or the terminal.	387	may be larger than the scroll back buffer or the terminal.
166		388
167	It is called before lines are scrolled out (so rows 0 .. min ($lines	389	It is called before lines are scrolled out (so rows 0 .. min ($lines
168	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	390	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
169	the total number of lines that will be in the scrollback buffer.	391	the total number of lines that will be in the scrollback buffer.
170
171	on_tty_activity $term NYI
172	Called whenever the program(s) running in the urxvt window send
173	output.
174		392
175	on_osc_seq $term, $string	393	on_osc_seq $term, $string
176	Called whenever the ESC ] 777 ; string ST command sequence (OSC =	394	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
177	operating system command) is processed. Cursor position and other	395	operating system command) is processed. Cursor position and other
178	state information is up-to-date when this happens. For	396	state information is up-to-date when this happens. For
…		…
189	argument. You can filter/change and output the text yourself by	407	argument. You can filter/change and output the text yourself by
190	returning a true value and calling "$term->scr_add_lines" yourself.	408	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	409	Please note that this might be very slow, however, as your hook is
192	called for all text being output.	410	called for all text being output.
193		411
		412	on_tt_write $term, $octets
		413	Called whenever some data is written to the tty/pty and can be used
		414	to suppress or filter tty input.
		415
194	on_line_update $term, $row	416	on_line_update $term, $row
195	Called whenever a line was updated or changed. Can be used to filter	417	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	418	screen output (e.g. underline urls or other useless stuff). Only
197	lines that are being shown will be filtered, and, due to performance	419	lines that are being shown will be filtered, and, due to performance
198	reasons, not always immediately.	420	reasons, not always immediately.
…		…
217	on_keyboard_command $term, $string	439	on_keyboard_command $term, $string
218	Called whenever the user presses a key combination that has a	440	Called whenever the user presses a key combination that has a
219	"perl:string" action bound to it (see description of the keysym	441	"perl:string" action bound to it (see description of the keysym
220	resource in the rxvt(1) manpage).	442	resource in the rxvt(1) manpage).
221		443
		444	on_x_event $term, $event
		445	Called on every X event received on the vt window (and possibly
		446	other windows). Should only be used as a last resort. Most event
		447	structure members are not passed.
		448
222	on_focus_in $term	449	on_focus_in $term
223	Called whenever the window gets the keyboard focus, before	450	Called whenever the window gets the keyboard focus, before
224	rxvt-unicode does focus in processing.	451	rxvt-unicode does focus in processing.
225		452
226	on_focus_out $term	453	on_focus_out $term
227	Called wheneever the window loses keyboard focus, before	454	Called wheneever the window loses keyboard focus, before
228	rxvt-unicode does focus out processing.	455	rxvt-unicode does focus out processing.
229		456
		457	on_configure_notify $term, $event
		458	on_property_notify $term, $event
230	on_key_press $term, $event, $octets	459	on_key_press $term, $event, $keysym, $octets
231	on_key_release $term, $event	460	on_key_release $term, $event, $keysym
232	on_button_press $term, $event	461	on_button_press $term, $event
233	on_button_release $term, $event	462	on_button_release $term, $event
234	on_motion_notify $term, $event	463	on_motion_notify $term, $event
235	on_map_notify $term, $event	464	on_map_notify $term, $event
236	on_unmap_notify $term, $event	465	on_unmap_notify $term, $event
…		…
238	terminal If the hook returns true, then the even will be ignored by	467	terminal If the hook returns true, then the even will be ignored by
239	rxvt-unicode.	468	rxvt-unicode.
240		469
241	The event is a hash with most values as named by Xlib (see the	470	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	471	XEvent manpage), with the additional members "row" and "col", which
243	are the row and column under the mouse cursor.	472	are the (real, not screen-based) row and column under the mouse
		473	cursor.
244		474
245	"on_key_press" additionally receives the string rxvt-unicode would	475	"on_key_press" additionally receives the string rxvt-unicode would
246	output, if any, in locale-specific encoding.	476	output, if any, in locale-specific encoding.
247		477
248	subwindow.	478	subwindow.
249		479
		480	on_client_message $term, $event
		481	on_wm_protocols $term, $event
		482	on_wm_delete_window $term, $event
		483	Called when various types of ClientMessage events are received (all
		484	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		485
250	Variables in the "urxvt" Package	486	Variables in the "urxvt" Package
		487	$urxvt::LIBDIR
		488	The rxvt-unicode library directory, where, among other things, the
		489	perl modules and scripts are stored.
		490
		491	$urxvt::RESCLASS, $urxvt::RESCLASS
		492	The resource class and name rxvt-unicode uses to look up X
		493	resources.
		494
		495	$urxvt::RXVTNAME
		496	The basename of the installed binaries, usually "urxvt".
		497
251	$urxvt::TERM	498	$urxvt::TERM
252	The current terminal. This variable stores the current "urxvt::term"	499	The current terminal. This variable stores the current "urxvt::term"
253	object, whenever a callback/hook is executing.	500	object, whenever a callback/hook is executing.
254		501
		502	@urxvt::TERM_INIT
		503	All coderefs in this array will be called as methods of the next
		504	newly created "urxvt::term" object (during the "on_init" phase). The
		505	array gets cleared before the codereferences that were in it are
		506	being executed, so coderefs can push themselves onto it again if
		507	they so desire.
		508
		509	This complements to the perl-eval commandline option, but gets
		510	executed first.
		511
		512	@urxvt::TERM_EXT
		513	Works similar to @TERM_INIT, but contains perl package/class names,
		514	which get registered as normal extensions after calling the hooks in
		515	@TERM_INIT but before other extensions. Gets cleared just like
		516	@TERM_INIT.
		517
255	Functions in the "urxvt" Package	518	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	519	urxvt::fatal $errormessage
265	Fatally aborts execution with the given error message. Avoid at all	520	Fatally aborts execution with the given error message. Avoid at all
266	costs! The only time this is acceptable is when the terminal process	521	costs! The only time this is acceptable is when the terminal process
267	starts up.	522	starts up.
268		523
…		…
272	function that calls this function.	527	function that calls this function.
273		528
274	Using this function has the advantage that its output ends up in the	529	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.	530	correct place, e.g. on stderr of the connecting urxvtc client.
276		531
		532	Messages have a size limit of 1023 bytes currently.
		533
277	$time = urxvt::NOW	534	$time = urxvt::NOW
278	Returns the "current time" (as per the event loop).	535	Returns the "current time" (as per the event loop).
279		536
280	urxvt::CurrentTime	537	urxvt::CurrentTime
281	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	538	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
282	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	539	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
283	Button5Mask, AnyModifier	540	Button5Mask, AnyModifier
		541	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		542	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		543	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		544	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		545	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		546	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		547	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		548	ColormapChangeMask, OwnerGrabButtonMask
		549	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		550	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		551	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		552	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		553	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		554	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		555	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
284	Various constants for use in X calls and event processing.	556	Various constants for use in X calls and event processing.
285		557
286	RENDITION	558	RENDITION
287	Rendition bitsets contain information about colour, font, font styles	559	Rendition bitsets contain information about colour, font, font styles
288	and similar information for each screen cell.	560	and similar information for each screen cell.
…		…
307		579
308	$foreground = urxvt::GET_BASEFG $rend	580	$foreground = urxvt::GET_BASEFG $rend
309	$background = urxvt::GET_BASEBG $rend	581	$background = urxvt::GET_BASEBG $rend
310	Return the foreground/background colour index, respectively.	582	Return the foreground/background colour index, respectively.
311		583
312	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	584	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
313	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	585	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
314	Replace the foreground/background colour in the rendition mask with	586	Replace the foreground/background colour in the rendition mask with
315	the specified one.	587	the specified one.
316		588
317	$value = urxvt::GET_CUSTOM ($rend)	589	$value = urxvt::GET_CUSTOM $rend
318	Return the "custom" value: Every rendition has 5 bits for use by	590	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	591	extensions. They can be set and changed as you like and are
320	initially zero.	592	initially zero.
321		593
322	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	594	$rend = urxvt::SET_CUSTOM $rend, $new_value
323	Change the custom value.	595	Change the custom value.
324		596
325	The "urxvt::anyevent" Class	597	The "urxvt::anyevent" Class
326	The sole purpose of this class is to deliver an interface to the	598	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	599	"AnyEvent" module - any module using it will work inside urxvt without
328	further work. The only exception is that you cannot wait on condition	600	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	601	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.	602	is that you cannot use blocking APIs, but the non-blocking variant
		603	should work.
331		604
332	The "urxvt::term" Class	605	The "urxvt::term" Class
		606	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		607	Creates a new terminal, very similar as if you had started it with
		608	system "$rxvtname, arg...". $envhashref must be a reference to a
		609	%ENV-like hash which defines the environment of the new terminal.
		610
		611	Croaks (and probably outputs an error message) if the new instance
		612	couldn't be created. Returns "undef" if the new instance didn't
		613	initialise perl, and the terminal object otherwise. The "init" and
		614	"start" hooks will be called during this call.
		615
333	$term->destroy	616	$term->destroy
334	Destroy the terminal object (close the window, free resources etc.).	617	Destroy the terminal object (close the window, free resources etc.).
		618	Please note that rxvt will not exit as long as any event watchers
		619	(timers, io watchers) are still active.
		620
		621	$term->exec_async ($cmd[, @args])
		622	Works like the combination of the "fork"/"exec" builtins, which
		623	executes ("starts") programs in the background. This function takes
		624	care of setting the user environment before exec'ing the command
		625	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		626	or "system".
		627
		628	Returns the pid of the subprocess or "undef" on error.
335		629
336	$isset = $term->option ($optval[, $set])	630	$isset = $term->option ($optval[, $set])
337	Returns true if the option specified by $optval is enabled, and	631	Returns true if the option specified by $optval is enabled, and
338	optionally change it. All option values are stored by name in the	632	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	633	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	636	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:	637	the source file /src/optinc.h to see the actual list:
344		638
345	borderLess console cursorBlink cursorUnderline hold iconic insecure	639	borderLess console cursorBlink cursorUnderline hold iconic insecure
346	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	640	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
347	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	641	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
348	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	642	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
349	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	643	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
350	tripleclickwords utmpInhibit visualBell	644	transparent tripleclickwords utmpInhibit visualBell
351		645
352	$value = $term->resource ($name[, $newval])	646	$value = $term->resource ($name[, $newval])
353	Returns the current resource value associated with a given name and	647	Returns the current resource value associated with a given name and
354	optionally sets a new value. Setting values is most useful in the	648	optionally sets a new value. Setting values is most useful in the
355	"init" hook. Unset resources are returned and accepted as "undef".	649	"init" hook. Unset resources are returned and accepted as "undef".
…		…
372		666
373	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	667	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
374	borderLess color cursorBlink cursorUnderline cutchars delete_key	668	borderLess color cursorBlink cursorUnderline cutchars delete_key
375	display_name embed ext_bwidth fade font geometry hold iconName	669	display_name embed ext_bwidth fade font geometry hold iconName
376	imFont imLocale inputMethod insecure int_bwidth intensityStyles	670	imFont imLocale inputMethod insecure int_bwidth intensityStyles
377	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	671	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
378	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	672	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
379	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	673	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
380	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	674	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
381	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	675	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
382	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	676	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		677	secondaryScreen secondaryScroll selectstyle shade term_name title
383	shade term_name title transparent transparent_all tripleclickwords	678	transient_for transparent transparent_all tripleclickwords utmpInhibit
384	utmpInhibit visualBell	679	visualBell
		680
		681	$value = $term->x_resource ($pattern)
		682	Returns the X-Resource for the given pattern, excluding the program
		683	or class name, i.e. "$term->x_resource ("boldFont")" should return
		684	the same value as used by this instance of rxvt-unicode. Returns
		685	"undef" if no resource with that pattern exists.
		686
		687	This method should only be called during the "on_start" hook, as
		688	there is only one resource database per display, and later
		689	invocations might return the wrong resources.
		690
		691	$success = $term->parse_keysym ($keysym_spec, $command_string)
		692	Adds a keymap translation exactly as specified via a resource. See
		693	the "keysym" resource in the rxvt(1) manpage.
385		694
386	$rend = $term->rstyle ([$new_rstyle])	695	$rend = $term->rstyle ([$new_rstyle])
387	Return and optionally change the current rendition. Text that is	696	Return and optionally change the current rendition. Text that is
388	output by the terminal application will use this style.	697	output by the terminal application will use this style.
389		698
…		…
396	($row, $col) = $term->selection_beg ([$row, $col])	705	($row, $col) = $term->selection_beg ([$row, $col])
397	($row, $col) = $term->selection_end ([$row, $col])	706	($row, $col) = $term->selection_end ([$row, $col])
398	Return the current values of the selection mark, begin or end	707	Return the current values of the selection mark, begin or end
399	positions, and optionally set them to new values.	708	positions, and optionally set them to new values.
400		709
		710	$term->selection_make ($eventtime[, $rectangular])
		711	Tries to make a selection as set by "selection_beg" and
		712	"selection_end". If $rectangular is true (default: false), a
		713	rectangular selection will be made. This is the prefered function to
		714	make a selection.
		715
401	$success = $term->selection_grab ($eventtime)	716	$success = $term->selection_grab ($eventtime)
402	Try to request the primary selection from the server (for example,	717	Try to request the primary selection text from the server (for
403	as set by the next method).	718	example, as set by the next method). No visual feedback will be
		719	given. This function is mostly useful from within "on_sel_grab"
		720	hooks.
404		721
405	$oldtext = $term->selection ([$newtext])	722	$oldtext = $term->selection ([$newtext])
406	Return the current selection text and optionally replace it by	723	Return the current selection text and optionally replace it by
407	$newtext.	724	$newtext.
408		725
409	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	726	$term->overlay_simple ($x, $y, $text)
410	overlay box. See the next method for details. # #=cut # #sub	727	Create a simple multi-line overlay box. See the next method for
411	urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my	728	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		729
417	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	730	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
418	Create a new (empty) overlay at the given position with the given	731	Create a new (empty) overlay at the given position with the given
419	width/height. $rstyle defines the initial rendition style (default:	732	width/height. $rstyle defines the initial rendition style (default:
420	"OVERLAY_RSTYLE").	733	"OVERLAY_RSTYLE").
…		…
454	Convert the given text string into the corresponding locale	767	Convert the given text string into the corresponding locale
455	encoding.	768	encoding.
456		769
457	$string = $term->locale_decode ($octets)	770	$string = $term->locale_decode ($octets)
458	Convert the given locale-encoded octets into a perl string.	771	Convert the given locale-encoded octets into a perl string.
		772
		773	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		774	XORs the rendition values in the given span with the provided value
		775	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
		776	in refresh hooks to provide effects similar to the selection.
		777
		778	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
		779	$rstyle2]])
		780	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
		781	whitespace will additionally be xored with the $rstyle2, which
		782	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
		783	and underlines it instead. Both styles MUST NOT contain font
		784	styles.
		785
		786	$term->scr_bell
		787	Ring the bell!
459		788
460	$term->scr_add_lines ($string)	789	$term->scr_add_lines ($string)
461	Write the given text string to the screen, as if output by the	790	Write the given text string to the screen, as if output by the
462	application running inside the terminal. It may not contain command	791	application running inside the terminal. It may not contain command
463	sequences (escape codes), but is free to use line feeds, carriage	792	sequences (escape codes), but is free to use line feeds, carriage
…		…
466		795
467	Normally its not a good idea to use this function, as programs might	796	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	797	be confused by changes in cursor position or scrolling. Its useful
469	inside a "on_add_lines" hook, though.	798	inside a "on_add_lines" hook, though.
470		799
		800	$term->scr_change_screen ($screen)
		801	Switch to given screen - 0 primary, 1 secondary.
		802
471	$term->cmd_parse ($octets)	803	$term->cmd_parse ($octets)
472	Similar to "scr_add_lines", but the argument must be in the	804	Similar to "scr_add_lines", but the argument must be in the
473	locale-specific encoding of the terminal and can contain command	805	locale-specific encoding of the terminal and can contain command
474	sequences (escape codes) that will be interpreted.	806	sequences (escape codes) that will be interpreted.
475		807
…		…
477	Write the octets given in $data to the tty (i.e. as program input).	809	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	810	To pass characters instead of octets, you should convert your
479	strings first to the locale-specific encoding using	811	strings first to the locale-specific encoding using
480	"$term->locale_encode".	812	"$term->locale_encode".
481		813
		814	$old_events = $term->pty_ev_events ([$new_events])
		815	Replaces the event mask of the pty watcher by the given event mask.
		816	Can be used to suppress input and output handling to the pty/tty.
		817	See the description of "urxvt::timer->events". Make sure to always
		818	restore the previous value.
		819
		820	$fd = $term->pty_fd
		821	Returns the master file descriptor for the pty in use, or -1 if no
		822	pty is used.
		823
482	$windowid = $term->parent	824	$windowid = $term->parent
483	Return the window id of the toplevel window.	825	Return the window id of the toplevel window.
484		826
485	$windowid = $term->vt	827	$windowid = $term->vt
486	Return the window id of the terminal window.	828	Return the window id of the terminal window.
		829
		830	$term->vt_emask_add ($x_event_mask)
		831	Adds the specified events to the vt event mask. Useful e.g. when you
		832	want to receive pointer events all the times:
		833
		834	$term->vt_emask_add (urxvt::PointerMotionMask);
487		835
488	$window_width = $term->width	836	$window_width = $term->width
489	$window_height = $term->height	837	$window_height = $term->height
490	$font_width = $term->fwidth	838	$font_width = $term->fwidth
491	$font_height = $term->fheight	839	$font_height = $term->fheight
…		…
494	$terminal_columns = $term->ncol	842	$terminal_columns = $term->ncol
495	$has_focus = $term->focus	843	$has_focus = $term->focus
496	$is_mapped = $term->mapped	844	$is_mapped = $term->mapped
497	$max_scrollback = $term->saveLines	845	$max_scrollback = $term->saveLines
498	$nrow_plus_saveLines = $term->total_rows	846	$nrow_plus_saveLines = $term->total_rows
499	$lines_in_scrollback = $term->nsaved	847	$topmost_scrollback_row = $term->top_row
500	Return various integers describing terminal characteristics.	848	Return various integers describing terminal characteristics.
		849
		850	$x_display = $term->display_id
		851	Return the DISPLAY used by rxvt-unicode.
		852
		853	$lc_ctype = $term->locale
		854	Returns the LC_CTYPE category string used by this rxvt-unicode.
		855
		856	$env = $term->env
		857	Returns a copy of the environment in effect for the terminal as a
		858	hashref similar to "\%ENV".
501		859
502	$modifiermask = $term->ModLevel3Mask	860	$modifiermask = $term->ModLevel3Mask
503	$modifiermask = $term->ModMetaMask	861	$modifiermask = $term->ModMetaMask
504	$modifiermask = $term->ModNumLockMask	862	$modifiermask = $term->ModNumLockMask
505	Return the modifier masks corresponding to the "ISO Level 3 Shift"	863	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	864	(often AltGr), the meta key (often Alt) and the num lock key, if
507	applicable.	865	applicable.
508		866
		867	$screen = $term->current_screen
		868	Returns the currently displayed screen (0 primary, 1 secondary).
		869
		870	$cursor_is_hidden = $term->hidden_cursor
		871	Returns wether the cursor is currently hidden or not.
		872
509	$view_start = $term->view_start ([$newvalue])	873	$view_start = $term->view_start ([$newvalue])
510	Returns the negative row number of the topmost line. Minimum value	874	Returns the row number of the topmost displayed line. Maximum value
511	is 0, which displays the normal terminal contents. Larger values	875	is 0, which displays the normal terminal contents. Lower values
512	scroll this many lines into the scrollback buffer.	876	scroll this many lines into the scrollback buffer.
513		877
514	$term->want_refresh	878	$term->want_refresh
515	Requests a screen refresh. At the next opportunity, rxvt-unicode	879	Requests a screen refresh. At the next opportunity, rxvt-unicode
516	will compare the on-screen display with its stored representation.	880	will compare the on-screen display with its stored representation.
…		…
529	line, starting at column $start_col (default 0), which is useful to	893	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	894	replace only parts of a line. The font index in the rendition will
531	automatically be updated.	895	automatically be updated.
532		896
533	$text is in a special encoding: tabs and wide characters that use	897	$text is in a special encoding: tabs and wide characters that use
534	more than one cell when displayed are padded with urxvt::NOCHAR	898	more than one cell when displayed are padded with $urxvt::NOCHAR
535	characters ("chr 65535"). Characters with combining characters and	899	(chr 65535) characters. Characters with combining characters and
536	other characters that do not fit into the normal tetx encoding will	900	other characters that do not fit into the normal tetx encoding will
537	be replaced with characters in the private use area.	901	be replaced with characters in the private use area.
538		902
539	You have to obey this encoding when changing text. The advantage is	903	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	904	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,	948	Return the row number of the first/last row of the line,
585	respectively.	949	respectively.
586		950
587	$offset = $line->offset_of ($row, $col)	951	$offset = $line->offset_of ($row, $col)
588	Returns the character offset of the given row\|col pair within	952	Returns the character offset of the given row\|col pair within
589	the logical line.	953	the logical line. Works for rows outside the line, too, and
		954	returns corresponding offsets outside the string.
590		955
591	($row, $col) = $line->coord_of ($offset)	956	($row, $col) = $line->coord_of ($offset)
592	Translates a string offset into terminal coordinates again.	957	Translates a string offset into terminal coordinates again.
593		958
594	($row, $col) = $line->coord_of ($offset) =item $text =
595	$term->special_encode $string	959	$text = $term->special_encode $string
596	Converts a perl string into the special encoding used by	960	Converts a perl string into the special encoding used by
597	rxvt-unicode, where one character corresponds to one screen cell.	961	rxvt-unicode, where one character corresponds to one screen cell.
598	See "$term->ROW_t" for details.	962	See "$term->ROW_t" for details.
599		963
600	$string = $term->special_decode $text	964	$string = $term->special_decode $text
601	Converts rxvt-unicodes text reprsentation into a perl string. See	965	Converts rxvt-unicodes text reprsentation into a perl string. See
602	"$term->ROW_t" for details.	966	"$term->ROW_t" for details.
603		967
		968	$success = $term->grab_button ($button, $modifiermask)
		969	Registers a synchronous button grab. See the XGrabButton manpage.
		970
		971	$success = $term->grab ($eventtime[, $sync])
		972	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		973	synchronous ($sync is true). Also remembers the grab timestampe.
		974
		975	$term->allow_events_async
		976	Calls XAllowEvents with AsyncBoth for the most recent grab.
		977
		978	$term->allow_events_sync
		979	Calls XAllowEvents with SyncBoth for the most recent grab.
		980
		981	$term->allow_events_replay
		982	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		983	the most recent grab.
		984
		985	$term->ungrab
		986	Calls XUngrab for the most recent grab. Is called automatically on
		987	evaluation errors, as it is better to lose the grab in the error
		988	case as the session.
		989
		990	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		991	$atom_name = $term->XGetAtomName ($atom)
		992	@atoms = $term->XListProperties ($window)
		993	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		994	$term->XChangeWindowProperty ($window, $property, $type, $format,
		995	$octets)
		996	$term->XDeleteProperty ($window, $property)
		997	$window = $term->DefaultRootWindow
		998	$term->XReparentWindow ($window, $parent, [$x, $y])
		999	$term->XMapWindow ($window)
		1000	$term->XUnmapWindow ($window)
		1001	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1002	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		1003	$y)
		1004	$term->XChangeInput ($window, $add_events[, $del_events])
		1005	Various X or X-related functions. The $term object only serves as
		1006	the source of the display, otherwise those functions map
		1007	more-or-less directory onto the X functions of the same name.
		1008
604	The "urxvt::popup" Class	1009	The "urxvt::popup" Class
		1010	$popup->add_title ($title)
		1011	Adds a non-clickable title to the popup.
		1012
		1013	$popup->add_separator ([$sepchr])
		1014	Creates a separator, optionally using the character given as
		1015	$sepchr.
		1016
		1017	$popup->add_button ($text, $cb)
		1018	Adds a clickable button to the popup. $cb is called whenever it is
		1019	selected.
		1020
		1021	$popup->add_toggle ($text, $cb, $initial_value)
		1022	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1023	whenever it gets toggled, with a boolean indicating its value as its
		1024	first argument.
		1025
		1026	$popup->show
		1027	Displays the popup (which is initially hidden).
		1028
605	The "urxvt::timer" Class	1029	The "urxvt::timer" Class
606	This class implements timer watchers/events. Time is represented as	1030	This class implements timer watchers/events. Time is represented as a
607	a fractional number of seconds since the epoch. Example:	1031	fractional number of seconds since the epoch. Example:
608		1032
609	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);	1033	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
610	$term->{timer} = urxvt::timer	1034	$term->{timer} = urxvt::timer
611	->new	1035	->new
612	->interval (1)	1036	->interval (1)
613	->cb (sub {	1037	->cb (sub {
614	$term->{overlay}->set (0, 0,	1038	$term->{overlay}->set (0, 0,
615	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1039	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
616	});	1040	});
617		1041
618	$timer = new urxvt::timer	1042	$timer = new urxvt::timer
619	Create a new timer object in started state. It is scheduled to	1043	Create a new timer object in started state. It is scheduled to fire
620	fire immediately.	1044	immediately.
621		1045
622	$timer = $timer->cb (sub { my ($timer) = @_; ... })	1046	$timer = $timer->cb (sub { my ($timer) = @_; ... })
623	Set the callback to be called when the timer triggers.	1047	Set the callback to be called when the timer triggers.
624		1048
625	$tstamp = $timer->at	1049	$tstamp = $timer->at
626	Return the time this watcher will fire next.	1050	Return the time this watcher will fire next.
627		1051
628	$timer = $timer->set ($tstamp)	1052	$timer = $timer->set ($tstamp)
629	Set the time the event is generated to $tstamp.	1053	Set the time the event is generated to $tstamp.
630		1054
631	$timer = $timer->interval ($interval)	1055	$timer = $timer->interval ($interval)
632	Normally (and when $interval is 0), the timer will automatically	1056	Normally (and when $interval is 0), the timer will automatically
633	stop after it has fired once. If $interval is non-zero, then the	1057	stop after it has fired once. If $interval is non-zero, then the
634	timer is automatically rescheduled at the given intervals.	1058	timer is automatically rescheduled at the given intervals.
635		1059
636	$timer = $timer->start	1060	$timer = $timer->start
637	Start the timer.	1061	Start the timer.
638		1062
639	$timer = $timer->start ($tstamp)	1063	$timer = $timer->start ($tstamp)
640	Set the event trigger time to $tstamp and start the timer.	1064	Set the event trigger time to $tstamp and start the timer.
641		1065
		1066	$timer = $timer->after ($delay)
		1067	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
		1068
642	$timer = $timer->stop	1069	$timer = $timer->stop
643	Stop the timer.	1070	Stop the timer.
644		1071
645	The "urxvt::iow" Class	1072	The "urxvt::iow" Class
646	This class implements io watchers/events. Example:	1073	This class implements io watchers/events. Example:
647		1074
648	$term->{socket} = ...	1075	$term->{socket} = ...
649	$term->{iow} = urxvt::iow	1076	$term->{iow} = urxvt::iow
		1077	->new
		1078	->fd (fileno $term->{socket})
		1079	->events (urxvt::EVENT_READ)
		1080	->start
		1081	->cb (sub {
		1082	my ($iow, $revents) = @_;
		1083	# $revents must be 1 here, no need to check
		1084	sysread $term->{socket}, my $buf, 8192
		1085	or end-of-file;
		1086	});
		1087
		1088	$iow = new urxvt::iow
		1089	Create a new io watcher object in stopped state.
		1090
		1091	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
		1092	Set the callback to be called when io events are triggered.
		1093	$reventmask is a bitset as described in the "events" method.
		1094
		1095	$iow = $iow->fd ($fd)
		1096	Set the filedescriptor (not handle) to watch.
		1097
		1098	$iow = $iow->events ($eventmask)
		1099	Set the event mask to watch. The only allowed values are
		1100	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1101	together, or "urxvt::EVENT_NONE".
		1102
		1103	$iow = $iow->start
		1104	Start watching for requested events on the given handle.
		1105
		1106	$iow = $iow->stop
		1107	Stop watching for events on the given filehandle.
		1108
		1109	The "urxvt::iw" Class
		1110	This class implements idle watchers, that get called automatically when
		1111	the process is idle. They should return as fast as possible, after doing
		1112	some useful work.
		1113
		1114	$iw = new urxvt::iw
		1115	Create a new idle watcher object in stopped state.
		1116
		1117	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1118	Set the callback to be called when the watcher triggers.
		1119
		1120	$timer = $timer->start
		1121	Start the watcher.
		1122
		1123	$timer = $timer->stop
		1124	Stop the watcher.
		1125
		1126	The "urxvt::pw" Class
		1127	This class implements process watchers. They create an event whenever a
		1128	process exits, after which they stop automatically.
		1129
		1130	my $pid = fork;
		1131	...
		1132	$term->{pw} = urxvt::pw
650	->new	1133	->new
651	->fd (fileno $term->{socket})
652	->events (1) # wait for read data
653	->start	1134	->start ($pid)
654	->cb (sub {	1135	->cb (sub {
655	my ($iow, $revents) = @_;	1136	my ($pw, $exit_status) = @_;
656	# $revents must be 1 here, no need to check
657	sysread $term->{socket}, my $buf, 8192
658	or end-of-file;
659	});	1137	...
		1138	});
660		1139
661	$iow = new urxvt::iow	1140	$pw = new urxvt::pw
662	Create a new io watcher object in stopped state.	1141	Create a new process watcher in stopped state.
663		1142
664	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	1143	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
665	Set the callback to be called when io events are triggered.	1144	Set the callback to be called when the timer triggers.
666	$reventmask is a bitset as described in the "events" method.
667		1145
668	$iow = $iow->fd ($fd)	1146	$pw = $timer->start ($pid)
669	Set the filedescriptor (not handle) to watch.	1147	Tells the wqtcher to start watching for process $pid.
670		1148
671	$iow = $iow->events ($eventmask)
672	Set the event mask to watch. Bit #0 (value 1) enables watching
673	for read data, Bit #1 (value 2) enables watching for write data.
674
675	$iow = $iow->start
676	Start watching for requested events on the given handle.
677
678	$iow = $iow->stop	1149	$pw = $pw->stop
679	Stop watching for events on the given filehandle.	1150	Stop the watcher.
680		1151
681	ENVIRONMENT	1152	ENVIRONMENT
682	URXVT_PERL_VERBOSITY	1153	URXVT_PERL_VERBOSITY
683	This variable controls the verbosity level of the perl extension.	1154	This variable controls the verbosity level of the perl extension. Higher
684	Higher numbers indicate more verbose output.	1155	numbers indicate more verbose output.
685		1156
686	=0 - only fatal messages	1157	== 0 - fatal messages
687	=3 - script loading and management	1158	>= 3 - script loading and management
688	=10 - all events received	1159	>=10 - all called hooks
		1160	>=11 - hook reutrn values
689		1161
690	AUTHOR	1162	AUTHOR
691	Marc Lehmann <pcg@goof.com>	1163	Marc Lehmann <pcg@goof.com>
692	http://software.schmorp.de/pkg/rxvt-unicode	1164	http://software.schmorp.de/pkg/rxvt-unicode
693		1165

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.14 by root, Sun Jan 8 06:35:38 2006 UTC vs. Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.14 by root, Sun Jan 8 06:35:38 2006 UTC vs.
Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC