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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.32 by root, Fri Jan 20 16:02:20 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	selection	34	Or by adding them to the resource for extensions loaded by default:
35	Intelligent selection. This extension tries to be more intelligent	35
		36	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		37
		38	selection (enabled by default)
		39	(More) intelligent selection. This extension tries to be more
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	You can look at the source of the selection extension to see more
		64	interesting uses, such as parsing a line from beginning to end.
		65
		66	This extension also offers following bindable keyboard commands:
41		67
42	rot13	68	rot13
43	Rot-13 the selection when activated. Used via keyboard trigger:	69	Rot-13 the selection when activated. Used via keyboard trigger:
44		70
45	URxvt.keysym.C-M-r: perl:selection:rot13	71	URxvt.keysym.C-M-r: perl:selection:rot13
46		72
47	digital-clock	73	option-popup (enabled by default)
48	Displays a digital clock using the built-in overlay.	74	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
		75	options at runtime.
		76
		77	selection-popup (enabled by default)
		78	Binds a popup menu to Ctrl-Button3 that lets you convert the
		79	selection text into various other formats/action (such as uri
		80	unescaping, perl evalution, web-browser starting etc.), depending on
		81	content.
		82
		83	Other extensions can extend this popup menu by pushing a code
		84	reference onto "@{ $term-"{selection_popup_hook} }>, that is called
		85	whenever the popup is displayed.
		86
		87	It's sole argument is the popup menu, which can be modified. The
		88	selection is in $_, which can be used to decide wether to add
		89	something or not. It should either return nothing or a string and a
		90	code reference. The string will be used as button text and the code
		91	reference will be called when the button gets activated and should
		92	transform $_.
		93
		94	The following will add an entry "a to b" that transforms all "a"s in
		95	the selection to "b"s, but only if the selection currently contains
		96	any "a"s:
		97
		98	push @{ $self->{term}{selection_popup_hook} }, sub {
		99	/a/ ? ("a to be" => sub { s/a/b/g }
		100	: ()
		101	};
		102
		103	searchable-scrollback<hotkey> (enabled by default)
		104	Adds regex search functionality to the scrollback buffer, triggered
		105	by a hotkey (default: "M-s"). While in search mode, normal terminal
		106	input/output is suspended and a regex is displayed at the bottom of
		107	the screen.
		108
		109	Inputting characters appends them to the regex and continues
		110	incremental search. "BackSpace" removes a character from the regex,
		111	"Up" and "Down" search upwards/downwards in the scrollback buffer,
		112	"End" jumps to the bottom. "Escape" leaves search mode and returns
		113	to the point where search was started, while "Enter" or "Return"
		114	stay at the current position and additionally stores the first match
		115	in the current line into the primary selection.
		116
		117	selection-autotransform
		118	This selection allows you to do automatic transforms on a selection
		119	whenever a selection is made.
		120
		121	It works by specifying perl snippets (most useful is a single "s///"
		122	operator) that modify $_ as resources:
		123
		124	URxvt.selection-autotransform.0: transform
		125	URxvt.selection-autotransform.1: transform
		126	...
		127
		128	For example, the following will transform selections of the form
		129	"filename:number", often seen in compiler messages, into "vi
		130	+$filename $word":
		131
		132	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		133
		134	And this example matches the same,but replaces it with vi-commands
		135	you can paste directly into your (vi :) editor:
		136
		137	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		138
		139	Of course, this can be modified to suit your needs and your editor
		140	:)
		141
		142	To expand the example above to typical perl error messages ("XXX at
		143	FILENAME line YYY."), you need a slightly more elaborate solution:
		144
		145	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		146	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		147
		148	The first line tells the selection code to treat the unchanging part
		149	of every error message as a selection pattern, and the second line
		150	transforms the message into vi commands to load the file.
		151
		152	tabbed
		153	This transforms the terminal into a tabbar with additional
		154	terminals, that is, it implements what is commonly refered to as
		155	"tabbed terminal". The topmost line displays a "[NEW]" button,
		156	which, when clicked, will add a new tab, followed by one button per
		157	tab.
		158
		159	Clicking a button will activate that tab. Pressing Shift-Left and
		160	Shift-Right will switch to the tab left or right of the current one.
49		161
50	mark-urls	162	mark-urls
51	Uses per-line display filtering ("on_line_update") to underline	163	Uses per-line display filtering ("on_line_update") to underline urls
52	urls.	164	and make them clickable. When middle-clicked, the program specified
		165	in the resource "urlLauncher" (default "x-www-browser") will be
		166	started with the URL as first argument.
		167
		168	automove-background
		169	This is basically a one-line extension that dynamically changes the
		170	background pixmap offset to the window position, in effect creating
		171	the same effect as pseudo transparency with a custom pixmap. No
		172	scaling is supported in this mode. Exmaple:
		173
		174	rxvt -pixmap background.xpm -pe automove-background
53		175
54	block-graphics-to-ascii	176	block-graphics-to-ascii
55	A not very useful example of filtering all text output to the	177	A not very useful example of filtering all text output to the
56	terminal, by replacing all line-drawing characters (U+2500 ..	178	terminal, by replacing all line-drawing characters (U+2500 ..
57	U+259F) by a similar-looking ascii character.	179	U+259F) by a similar-looking ascii character.
58		180
		181	digital-clock
		182	Displays a digital clock using the built-in overlay.
		183
59	example-refresh-hooks	184	example-refresh-hooks
60	Displays a very simple digital clock in the upper right corner of	185	Displays a very simple digital clock in the upper right corner of
61	the window. Illustrates overwriting the refresh callbacks to create	186	the window. Illustrates overwriting the refresh callbacks to create
62	your own overlays or changes.	187	your own overlays or changes.
63		188
		189	selection-pastebin
		190	This is a little rarely useful extension that Uploads the selection
		191	as textfile to a remote site (or does other things). (The
		192	implementation is not currently secure for use in a multiuser
		193	environment as it writes to /tmp directly.).
		194
		195	It listens to the "selection-pastebin:remote-pastebin" keyboard
		196	command, i.e.
		197
		198	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		199
		200	Pressing this combination runs a command with "%" replaced by the
		201	name of the textfile. This command can be set via a resource:
		202
		203	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		204
		205	And the default is likely not useful to anybody but the few people
		206	around here :)
		207
		208	The name of the textfile is the hex encoded md5 sum of the
		209	selection, so the same content should lead to the same filename.
		210
		211	After a successful upload the selection will be replaced by the text
		212	given in the "selection-pastebin-url" resource (again, the % is the
		213	placeholder for the filename):
		214
		215	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		216
		217	API DOCUMENTATION
64	General API Considerations	218	General API Considerations
65	All objects (such as terminals, time watchers etc.) are typical	219	All objects (such as terminals, time watchers etc.) are typical
66	reference-to-hash objects. The hash can be used to store anything you	220	reference-to-hash objects. The hash can be used to store anything you
67	like. All members starting with an underscore (such as "_ptr" or	221	like. All members starting with an underscore (such as "_ptr" or
68	"_hook") are reserved for internal uses and MUST NOT be accessed or	222	"_hook") are reserved for internal uses and MUST NOT be accessed or
…		…
76	Argument names also often indicate the type of a parameter. Here are	230	Argument names also often indicate the type of a parameter. Here are
77	some hints on what they mean:	231	some hints on what they mean:
78		232
79	$text	233	$text
80	Rxvt-unicodes special way of encoding text, where one "unicode"	234	Rxvt-unicodes special way of encoding text, where one "unicode"
81	character always represents one screen cell. See row_t for a	235	character always represents one screen cell. See ROW_t for a
82	discussion of this format.	236	discussion of this format.
83		237
84	$string	238	$string
85	A perl text string, with an emphasis on text. It can store all	239	A perl text string, with an emphasis on text. It can store all
86	unicode characters and is to be distinguished with text encoded in a	240	unicode characters and is to be distinguished with text encoded in a
…		…
88		242
89	$octets	243	$octets
90	Either binary data or - more common - a text string encoded in a	244	Either binary data or - more common - a text string encoded in a
91	locale-specific way.	245	locale-specific way.
92		246
		247	Extension Objects
		248	Very perl extension is a perl class. A separate perl object is created
		249	for each terminal and each extension and passed as the first parameter
		250	to hooks. So extensions can use their $self object without having to
		251	think about other extensions, with the exception of methods and members
		252	that begin with an underscore character "_": these are reserved for
		253	internal use.
		254
		255	Although it isn't a "urxvt::term" object, you can call all methods of
		256	the "urxvt::term" class on this object.
		257
		258	It has the following methods and data members:
		259
		260	$urxvt_term = $self->{term}
		261	Returns the "urxvt::term" object associated with this instance of
		262	the extension. This member must not be changed in any way.
		263
		264	$self->enable ($hook_name => $cb, [$hook_name => $cb..])
		265	Dynamically enable the given hooks (named without the "on_" prefix)
		266	for this extension, replacing any previous hook. This is useful when
		267	you want to overwrite time-critical hooks only temporarily.
		268
		269	$self->disable ($hook_name[, $hook_name..])
		270	Dynamically disable the given hooks.
		271
93	Hooks	272	Hooks
94	The following subroutines can be declared in extension files, and will	273	The following subroutines can be declared in extension files, and will
95	be called whenever the relevant event happens.	274	be called whenever the relevant event happens.
96		275
97	The first argument passed to them is an object private to each terminal	276	The first argument passed to them is an extension oject as described in
98	and extension package. You can call all "urxvt::term" methods on it, but	277	the in the "Extension Objects" section.
99	its not a real "urxvt::term" object. Instead, the real "urxvt::term"
100	object that is shared between all packages is stored in the "term"
101	member. It is, however, blessed intot he package of the extension
102	script, so for all practical purposes you can treat an extension script
103	as a class.
104		278
105	All of them must return a boolean value. If it is true, then the event	279	All of these hooks must return a boolean value. If any of the called
106	counts as being consumed, and the invocation of other hooks is	280	hooks returns true, then the event counts as being consumed, and the
107	skipped, and the relevant action might not be carried out by the C++	281	relevant action might not be carried out by the C++ code.
108	code.
109		282
110	When in doubt, return a false value (preferably "()").	283	When in doubt, return a false value (preferably "()").
111		284
112	on_init $term	285	on_init $term
113	Called after a new terminal object has been initialized, but before	286	Called after a new terminal object has been initialized, but before
114	windows are created or the command gets run. Most methods are unsafe	287	windows are created or the command gets run. Most methods are unsafe
115	to call or deliver senseless data, as terminal size and other	288	to call or deliver senseless data, as terminal size and other
116	characteristics have not yet been determined. You can safely query	289	characteristics have not yet been determined. You can safely query
117	and change resources, though.	290	and change resources and options, though. For many purposes the
		291	"on_start" hook is a better place.
		292
		293	on_start $term
		294	Called at the very end of initialisation of a new terminal, just
		295	before trying to map (display) the toplevel and returning to the
		296	mainloop.
		297
		298	on_destroy $term
		299	Called whenever something tries to destroy terminal, before doing
		300	anything yet. If this hook returns true, then destruction is
		301	skipped, but this is rarely a good idea.
118		302
119	on_reset $term	303	on_reset $term
120	Called after the screen is "reset" for any reason, such as resizing	304	Called after the screen is "reset" for any reason, such as resizing
121	or control sequences. Here is where you can react on changes to	305	or control sequences. Here is where you can react on changes to
122	size-related variables.	306	size-related variables.
123		307
124	on_start $term	308	on_child_start $term, $pid
125	Called at the very end of initialisation of a new terminal, just	309	Called just after the child process has been "fork"ed.
126	before returning to the mainloop.	310
		311	on_child_exit $term, $status
		312	Called just after the child process has exited. $status is the
		313	status from "waitpid".
127		314
128	on_sel_make $term, $eventtime	315	on_sel_make $term, $eventtime
129	Called whenever a selection has been made by the user, but before	316	Called whenever a selection has been made by the user, but before
130	the selection text is copied, so changes to the beginning, end or	317	the selection text is copied, so changes to the beginning, end or
131	type of the selection will be honored.	318	type of the selection will be honored.
…		…
144		331
145	on_sel_extend $term	332	on_sel_extend $term
146	Called whenever the user tries to extend the selection (e.g. with a	333	Called whenever the user tries to extend the selection (e.g. with a
147	double click) and is either supposed to return false (normal	334	double click) and is either supposed to return false (normal
148	operation), or should extend the selection itelf and return true to	335	operation), or should extend the selection itelf and return true to
149	suppress the built-in processing.	336	suppress the built-in processing. This can happen multiple times, as
		337	long as the callback returns true, it will be called on every
		338	further click by the user and is supposed to enlarge the selection
		339	more and more, if possible.
150		340
151	See the selection example extension.	341	See the selection example extension.
152		342
153	on_view_change $term, $offset	343	on_view_change $term, $offset
154	Called whenever the view offset changes, i..e the user or program	344	Called whenever the view offset changes, i..e the user or program
…		…
161	may be larger than the scroll back buffer or the terminal.	351	may be larger than the scroll back buffer or the terminal.
162		352
163	It is called before lines are scrolled out (so rows 0 .. min ($lines	353	It is called before lines are scrolled out (so rows 0 .. min ($lines
164	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is	354	- 1, $nrow - 1) represent the lines to be scrolled out). $saved is
165	the total number of lines that will be in the scrollback buffer.	355	the total number of lines that will be in the scrollback buffer.
166
167	on_tty_activity $term NYI
168	Called whenever the program(s) running in the urxvt window send
169	output.
170		356
171	on_osc_seq $term, $string	357	on_osc_seq $term, $string
172	Called whenever the ESC ] 777 ; string ST command sequence (OSC =	358	Called whenever the ESC ] 777 ; string ST command sequence (OSC =
173	operating system command) is processed. Cursor position and other	359	operating system command) is processed. Cursor position and other
174	state information is up-to-date when this happens. For	360	state information is up-to-date when this happens. For
…		…
185	argument. You can filter/change and output the text yourself by	371	argument. You can filter/change and output the text yourself by
186	returning a true value and calling "$term->scr_add_lines" yourself.	372	returning a true value and calling "$term->scr_add_lines" yourself.
187	Please note that this might be very slow, however, as your hook is	373	Please note that this might be very slow, however, as your hook is
188	called for all text being output.	374	called for all text being output.
189		375
		376	on_tt_write $term, $octets
		377	Called whenever some data is written to the tty/pty and can be used
		378	to suppress or filter tty input.
		379
190	on_line_update $term, $row	380	on_line_update $term, $row
191	Called whenever a line was updated or changed. Can be used to filter	381	Called whenever a line was updated or changed. Can be used to filter
192	screen output (e.g. underline urls or other useless stuff). Only	382	screen output (e.g. underline urls or other useless stuff). Only
193	lines that are being shown will be filtered, and, due to performance	383	lines that are being shown will be filtered, and, due to performance
194	reasons, not always immediately.	384	reasons, not always immediately.
…		…
213	on_keyboard_command $term, $string	403	on_keyboard_command $term, $string
214	Called whenever the user presses a key combination that has a	404	Called whenever the user presses a key combination that has a
215	"perl:string" action bound to it (see description of the keysym	405	"perl:string" action bound to it (see description of the keysym
216	resource in the rxvt(1) manpage).	406	resource in the rxvt(1) manpage).
217		407
		408	on_x_event $term, $event
		409	Called on every X event received on the vt window (and possibly
		410	other windows). Should only be used as a last resort. Most event
		411	structure members are not passed.
		412
218	on_focus_in $term	413	on_focus_in $term
219	Called whenever the window gets the keyboard focus, before	414	Called whenever the window gets the keyboard focus, before
220	rxvt-unicode does focus in processing.	415	rxvt-unicode does focus in processing.
221		416
222	on_focus_out $term	417	on_focus_out $term
223	Called wheneever the window loses keyboard focus, before	418	Called wheneever the window loses keyboard focus, before
224	rxvt-unicode does focus out processing.	419	rxvt-unicode does focus out processing.
225		420
		421	on_configure_notify $term, $event
226	on_key_press $term, $event, $octets	422	on_key_press $term, $event, $keysym, $octets
227	on_key_release $term, $event	423	on_key_release $term, $event, $keysym
228	on_button_press $term, $event	424	on_button_press $term, $event
229	on_button_release $term, $event	425	on_button_release $term, $event
230	on_motion_notify $term, $event	426	on_motion_notify $term, $event
231	on_map_notify $term, $event	427	on_map_notify $term, $event
232	on_unmap_notify $term, $event	428	on_unmap_notify $term, $event
…		…
241	"on_key_press" additionally receives the string rxvt-unicode would	437	"on_key_press" additionally receives the string rxvt-unicode would
242	output, if any, in locale-specific encoding.	438	output, if any, in locale-specific encoding.
243		439
244	subwindow.	440	subwindow.
245		441
		442	on_client_message $term, $event
		443	on_wm_protocols $term, $event
		444	on_wm_delete_window $term, $event
		445	Called when various types of ClientMessage events are received (all
		446	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		447
246	Variables in the "urxvt" Package	448	Variables in the "urxvt" Package
		449	$urxvt::LIBDIR
		450	The rxvt-unicode library directory, where, among other things, the
		451	perl modules and scripts are stored.
		452
		453	$urxvt::RESCLASS, $urxvt::RESCLASS
		454	The resource class and name rxvt-unicode uses to look up X
		455	resources.
		456
		457	$urxvt::RXVTNAME
		458	The basename of the installed binaries, usually "urxvt".
		459
247	$urxvt::TERM	460	$urxvt::TERM
248	The current terminal. This variable stores the current "urxvt::term"	461	The current terminal. This variable stores the current "urxvt::term"
249	object, whenever a callback/hook is executing.	462	object, whenever a callback/hook is executing.
250		463
		464	@urxvt::TERM_INIT
		465	All coderefs in this array will be called as methods of the next
		466	newly created "urxvt::term" object (during the "on_init" phase). The
		467	array gets cleared before the codereferences that were in it are
		468	being executed, so coderefs can push themselves onto it again if
		469	they so desire.
		470
		471	This complements to the perl-eval commandline option, but gets
		472	executed first.
		473
		474	@urxvt::TERM_EXT
		475	Works similar to @TERM_INIT, but contains perl package/class names,
		476	which get registered as normal extensions after calling the hooks in
		477	@TERM_INIT but before other extensions. Gets cleared just like
		478	@TERM_INIT.
		479
251	Functions in the "urxvt" Package	480	Functions in the "urxvt" Package
252	$term = new urxvt [arg...]
253	Creates a new terminal, very similar as if you had started it with
254	"system $binfile, arg...". Croaks (and probably outputs an error
255	message) if the new instance couldn't be created. Returns "undef" if
256	the new instance didn't initialise perl, and the terminal object
257	otherwise. The "init" and "start" hooks will be called during the
258	call.
259
260	urxvt::fatal $errormessage	481	urxvt::fatal $errormessage
261	Fatally aborts execution with the given error message. Avoid at all	482	Fatally aborts execution with the given error message. Avoid at all
262	costs! The only time this is acceptable is when the terminal process	483	costs! The only time this is acceptable is when the terminal process
263	starts up.	484	starts up.
264		485
…		…
268	function that calls this function.	489	function that calls this function.
269		490
270	Using this function has the advantage that its output ends up in the	491	Using this function has the advantage that its output ends up in the
271	correct place, e.g. on stderr of the connecting urxvtc client.	492	correct place, e.g. on stderr of the connecting urxvtc client.
272		493
		494	Messages have a size limit of 1023 bytes currently.
		495
273	$time = urxvt::NOW	496	$time = urxvt::NOW
274	Returns the "current time" (as per the event loop).	497	Returns the "current time" (as per the event loop).
275		498
276	urxvt::CurrentTime	499	urxvt::CurrentTime
277	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	500	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
278	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	501	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
279	Button5Mask, AnyModifier	502	Button5Mask, AnyModifier
		503	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		504	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		505	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		506	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		507	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		508	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		509	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		510	ColormapChangeMask, OwnerGrabButtonMask
		511	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		512	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		513	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		514	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		515	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		516	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		517	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
280	Various constants for use in X events.	518	Various constants for use in X calls and event processing.
281		519
282	RENDITION	520	RENDITION
283	Rendition bitsets contain information about colour, font, font styles	521	Rendition bitsets contain information about colour, font, font styles
284	and similar information for each screen cell.	522	and similar information for each screen cell.
285		523
…		…
303		541
304	$foreground = urxvt::GET_BASEFG $rend	542	$foreground = urxvt::GET_BASEFG $rend
305	$background = urxvt::GET_BASEBG $rend	543	$background = urxvt::GET_BASEBG $rend
306	Return the foreground/background colour index, respectively.	544	Return the foreground/background colour index, respectively.
307		545
308	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	546	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
309	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	547	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
310	Replace the foreground/background colour in the rendition mask with	548	Replace the foreground/background colour in the rendition mask with
311	the specified one.	549	the specified one.
312		550
313	$value = urxvt::GET_CUSTOM ($rend)	551	$value = urxvt::GET_CUSTOM $rend
314	Return the "custom" value: Every rendition has 5 bits for use by	552	Return the "custom" value: Every rendition has 5 bits for use by
315	extensions. They can be set and changed as you like and are	553	extensions. They can be set and changed as you like and are
316	initially zero.	554	initially zero.
317		555
318	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	556	$rend = urxvt::SET_CUSTOM $rend, $new_value
319	Change the custom value.	557	Change the custom value.
320		558
		559	The "urxvt::anyevent" Class
		560	The sole purpose of this class is to deliver an interface to the
		561	"AnyEvent" module - any module using it will work inside urxvt without
		562	further programming. The only exception is that you cannot wait on
		563	condition variables, but non-blocking condvar use is ok. What this means
		564	is that you cannot use blocking APIs, but the non-blocking variant
		565	should work.
		566
321	The "urxvt::term" Class	567	The "urxvt::term" Class
		568	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		569	Creates a new terminal, very similar as if you had started it with
		570	system "$rxvtname, arg...". $envhashref must be a reference to a
		571	%ENV-like hash which defines the environment of the new terminal.
		572
		573	Croaks (and probably outputs an error message) if the new instance
		574	couldn't be created. Returns "undef" if the new instance didn't
		575	initialise perl, and the terminal object otherwise. The "init" and
		576	"start" hooks will be called during this call.
		577
322	$term->destroy	578	$term->destroy
323	Destroy the terminal object (close the window, free resources etc.).	579	Destroy the terminal object (close the window, free resources etc.).
		580	Please note that rxvt will not exit as long as any event watchers
		581	(timers, io watchers) are still active.
		582
		583	$term->exec_async ($cmd[, @args])
		584	Works like the combination of the "fork"/"exec" builtins, which
		585	executes ("starts") programs in the background. This function takes
		586	care of setting the user environment before exec'ing the command
		587	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		588	or "system".
		589
		590	Returns the pid of the subprocess or "undef" on error.
324		591
325	$isset = $term->option ($optval[, $set])	592	$isset = $term->option ($optval[, $set])
326	Returns true if the option specified by $optval is enabled, and	593	Returns true if the option specified by $optval is enabled, and
327	optionally change it. All option values are stored by name in the	594	optionally change it. All option values are stored by name in the
328	hash %urxvt::OPTION. Options not enabled in this binary are not in	595	hash %urxvt::OPTION. Options not enabled in this binary are not in
…		…
331	Here is a a likely non-exhaustive list of option names, please see	598	Here is a a likely non-exhaustive list of option names, please see
332	the source file /src/optinc.h to see the actual list:	599	the source file /src/optinc.h to see the actual list:
333		600
334	borderLess console cursorBlink cursorUnderline hold iconic insecure	601	borderLess console cursorBlink cursorUnderline hold iconic insecure
335	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	602	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
336	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	603	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
337	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	604	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
338	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	605	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
339	tripleclickwords utmpInhibit visualBell	606	transparent tripleclickwords utmpInhibit visualBell
340		607
341	$value = $term->resource ($name[, $newval])	608	$value = $term->resource ($name[, $newval])
342	Returns the current resource value associated with a given name and	609	Returns the current resource value associated with a given name and
343	optionally sets a new value. Setting values is most useful in the	610	optionally sets a new value. Setting values is most useful in the
344	"init" hook. Unset resources are returned and accepted as "undef".	611	"init" hook. Unset resources are returned and accepted as "undef".
…		…
361		628
362	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	629	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
363	borderLess color cursorBlink cursorUnderline cutchars delete_key	630	borderLess color cursorBlink cursorUnderline cutchars delete_key
364	display_name embed ext_bwidth fade font geometry hold iconName	631	display_name embed ext_bwidth fade font geometry hold iconName
365	imFont imLocale inputMethod insecure int_bwidth intensityStyles	632	imFont imLocale inputMethod insecure int_bwidth intensityStyles
366	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	633	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
367	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	634	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
368	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	635	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
369	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	636	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
370	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	637	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
371	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	638	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		639	secondaryScreen secondaryScroll selectstyle shade term_name title
372	shade term_name title transparent transparent_all tripleclickwords	640	transient_for transparent transparent_all tripleclickwords utmpInhibit
373	utmpInhibit visualBell	641	visualBell
		642
		643	$value = $term->x_resource ($pattern)
		644	Returns the X-Resource for the given pattern, excluding the program
		645	or class name, i.e. "$term->x_resource ("boldFont")" should return
		646	the same value as used by this instance of rxvt-unicode. Returns
		647	"undef" if no resource with that pattern exists.
		648
		649	This method should only be called during the "on_start" hook, as
		650	there is only one resource database per display, and later
		651	invocations might return the wrong resources.
		652
		653	$success = $term->parse_keysym ($keysym_spec, $command_string)
		654	Adds a keymap translation exactly as specified via a resource. See
		655	the "keysym" resource in the rxvt(1) manpage.
374		656
375	$rend = $term->rstyle ([$new_rstyle])	657	$rend = $term->rstyle ([$new_rstyle])
376	Return and optionally change the current rendition. Text that is	658	Return and optionally change the current rendition. Text that is
377	output by the terminal application will use this style.	659	output by the terminal application will use this style.
378		660
…		…
385	($row, $col) = $term->selection_beg ([$row, $col])	667	($row, $col) = $term->selection_beg ([$row, $col])
386	($row, $col) = $term->selection_end ([$row, $col])	668	($row, $col) = $term->selection_end ([$row, $col])
387	Return the current values of the selection mark, begin or end	669	Return the current values of the selection mark, begin or end
388	positions, and optionally set them to new values.	670	positions, and optionally set them to new values.
389		671
		672	$term->selection_make ($eventtime[, $rectangular])
		673	Tries to make a selection as set by "selection_beg" and
		674	"selection_end". If $rectangular is true (default: false), a
		675	rectangular selection will be made. This is the prefered function to
		676	make a selection.
		677
390	$success = $term->selection_grab ($eventtime)	678	$success = $term->selection_grab ($eventtime)
391	Try to request the primary selection from the server (for example,	679	Try to request the primary selection text from the server (for
392	as set by the next method).	680	example, as set by the next method). No visual feedback will be
		681	given. This function is mostly useful from within "on_sel_grab"
		682	hooks.
393		683
394	$oldtext = $term->selection ([$newtext])	684	$oldtext = $term->selection ([$newtext])
395	Return the current selection text and optionally replace it by	685	Return the current selection text and optionally replace it by
396	$newtext.	686	$newtext.
397		687
398	#=item $term->overlay ($x, $y, $text) # #Create a simple multi-line	688	$term->overlay_simple ($x, $y, $text)
399	overlay box. See the next method for details. # #=cut # #sub	689	Create a simple multi-line overlay box. See the next method for
400	urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my	690	details.
401	@lines = split /\n/, $text; # # my $w = 0; # for (map
402	$self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # #
403	$self->scr_overlay_new ($x, $y, $w, scalar @lines); #
404	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #}
405		691
406	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	692	$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
407	Create a new (empty) overlay at the given position with the given	693	Create a new (empty) overlay at the given position with the given
408	width/height. $rstyle defines the initial rendition style (default:	694	width/height. $rstyle defines the initial rendition style (default:
409	"OVERLAY_RSTYLE").	695	"OVERLAY_RSTYLE").
…		…
443	Convert the given text string into the corresponding locale	729	Convert the given text string into the corresponding locale
444	encoding.	730	encoding.
445		731
446	$string = $term->locale_decode ($octets)	732	$string = $term->locale_decode ($octets)
447	Convert the given locale-encoded octets into a perl string.	733	Convert the given locale-encoded octets into a perl string.
		734
		735	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		736	XORs the rendition values in the given span with the provided value
		737	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
		738	in refresh hooks to provide effects similar to the selection.
		739
		740	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
		741	$rstyle2]])
		742	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
		743	whitespace will additionally be xored with the $rstyle2, which
		744	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
		745	and underlines it instead. Both styles MUST NOT contain font
		746	styles.
		747
		748	$term->scr_bell
		749	Ring the bell!
448		750
449	$term->scr_add_lines ($string)	751	$term->scr_add_lines ($string)
450	Write the given text string to the screen, as if output by the	752	Write the given text string to the screen, as if output by the
451	application running inside the terminal. It may not contain command	753	application running inside the terminal. It may not contain command
452	sequences (escape codes), but is free to use line feeds, carriage	754	sequences (escape codes), but is free to use line feeds, carriage
…		…
466	Write the octets given in $data to the tty (i.e. as program input).	768	Write the octets given in $data to the tty (i.e. as program input).
467	To pass characters instead of octets, you should convert your	769	To pass characters instead of octets, you should convert your
468	strings first to the locale-specific encoding using	770	strings first to the locale-specific encoding using
469	"$term->locale_encode".	771	"$term->locale_encode".
470		772
		773	$old_events = $term->pty_ev_events ([$new_events])
		774	Replaces the event mask of the pty watcher by the given event mask.
		775	Can be used to suppress input and output handling to the pty/tty.
		776	See the description of "urxvt::timer->events". Make sure to always
		777	restore the previous value.
		778
471	$windowid = $term->parent	779	$windowid = $term->parent
472	Return the window id of the toplevel window.	780	Return the window id of the toplevel window.
473		781
474	$windowid = $term->vt	782	$windowid = $term->vt
475	Return the window id of the terminal window.	783	Return the window id of the terminal window.
		784
		785	$term->vt_emask_add ($x_event_mask)
		786	Adds the specified events to the vt event mask. Useful e.g. when you
		787	want to receive pointer events all the times:
		788
		789	$term->vt_emask_add (urxvt::PointerMotionMask);
476		790
477	$window_width = $term->width	791	$window_width = $term->width
478	$window_height = $term->height	792	$window_height = $term->height
479	$font_width = $term->fwidth	793	$font_width = $term->fwidth
480	$font_height = $term->fheight	794	$font_height = $term->fheight
…		…
483	$terminal_columns = $term->ncol	797	$terminal_columns = $term->ncol
484	$has_focus = $term->focus	798	$has_focus = $term->focus
485	$is_mapped = $term->mapped	799	$is_mapped = $term->mapped
486	$max_scrollback = $term->saveLines	800	$max_scrollback = $term->saveLines
487	$nrow_plus_saveLines = $term->total_rows	801	$nrow_plus_saveLines = $term->total_rows
488	$lines_in_scrollback = $term->nsaved	802	$topmost_scrollback_row = $term->top_row
489	Return various integers describing terminal characteristics.	803	Return various integers describing terminal characteristics.
		804
		805	$x_display = $term->display_id
		806	Return the DISPLAY used by rxvt-unicode.
		807
		808	$lc_ctype = $term->locale
		809	Returns the LC_CTYPE category string used by this rxvt-unicode.
		810
		811	$env = $term->env
		812	Returns a copy of the environment in effect for the terminal as a
		813	hashref similar to "\%ENV".
490		814
491	$modifiermask = $term->ModLevel3Mask	815	$modifiermask = $term->ModLevel3Mask
492	$modifiermask = $term->ModMetaMask	816	$modifiermask = $term->ModMetaMask
493	$modifiermask = $term->ModNumLockMask	817	$modifiermask = $term->ModNumLockMask
494	Return the modifier masks corresponding to the "ISO Level 3 Shift"	818	Return the modifier masks corresponding to the "ISO Level 3 Shift"
495	(often AltGr), the meta key (often Alt) and the num lock key, if	819	(often AltGr), the meta key (often Alt) and the num lock key, if
496	applicable.	820	applicable.
497		821
498	$view_start = $term->view_start ([$newvalue])	822	$view_start = $term->view_start ([$newvalue])
499	Returns the negative row number of the topmost line. Minimum value	823	Returns the row number of the topmost displayed line. Maximum value
500	is 0, which displays the normal terminal contents. Larger values	824	is 0, which displays the normal terminal contents. Lower values
501	scroll this many lines into the scrollback buffer.	825	scroll this many lines into the scrollback buffer.
502		826
503	$term->want_refresh	827	$term->want_refresh
504	Requests a screen refresh. At the next opportunity, rxvt-unicode	828	Requests a screen refresh. At the next opportunity, rxvt-unicode
505	will compare the on-screen display with its stored representation.	829	will compare the on-screen display with its stored representation.
…		…
573	Return the row number of the first/last row of the line,	897	Return the row number of the first/last row of the line,
574	respectively.	898	respectively.
575		899
576	$offset = $line->offset_of ($row, $col)	900	$offset = $line->offset_of ($row, $col)
577	Returns the character offset of the given row\|col pair within	901	Returns the character offset of the given row\|col pair within
578	the logical line.	902	the logical line. Works for rows outside the line, too, and
		903	returns corresponding offsets outside the string.
579		904
580	($row, $col) = $line->coord_of ($offset)	905	($row, $col) = $line->coord_of ($offset)
581	Translates a string offset into terminal coordinates again.	906	Translates a string offset into terminal coordinates again.
582		907
583	($row, $col) = $line->coord_of ($offset) =item $text =
584	$term->special_encode $string	908	$text = $term->special_encode $string
585	Converts a perl string into the special encoding used by	909	Converts a perl string into the special encoding used by
586	rxvt-unicode, where one character corresponds to one screen cell.	910	rxvt-unicode, where one character corresponds to one screen cell.
587	See "$term->ROW_t" for details.	911	See "$term->ROW_t" for details.
588		912
589	$string = $term->special_decode $text	913	$string = $term->special_decode $text
590	Converts rxvt-unicodes text reprsentation into a perl string. See	914	Converts rxvt-unicodes text reprsentation into a perl string. See
591	"$term->ROW_t" for details.	915	"$term->ROW_t" for details.
592		916
		917	$success = $term->grab_button ($button, $modifiermask)
		918	Registers a synchronous button grab. See the XGrabButton manpage.
		919
		920	$success = $term->grab ($eventtime[, $sync])
		921	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		922	synchronous ($sync is true). Also remembers the grab timestampe.
		923
		924	$term->allow_events_async
		925	Calls XAllowEvents with AsyncBoth for the most recent grab.
		926
		927	$term->allow_events_sync
		928	Calls XAllowEvents with SyncBoth for the most recent grab.
		929
		930	$term->allow_events_replay
		931	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
		932	the most recent grab.
		933
		934	$term->ungrab
		935	Calls XUngrab for the most recent grab. Is called automatically on
		936	evaluation errors, as it is better to lose the grab in the error
		937	case as the session.
		938
593	The "urxvt::popup" Class	939	The "urxvt::popup" Class
		940	$popup->add_title ($title)
		941	Adds a non-clickable title to the popup.
		942
		943	$popup->add_separator ([$sepchr])
		944	Creates a separator, optionally using the character given as
		945	$sepchr.
		946
		947	$popup->add_button ($text, $cb)
		948	Adds a clickable button to the popup. $cb is called whenever it is
		949	selected.
		950
		951	$popup->add_toggle ($text, $cb, $initial_value)
		952	Adds a toggle/checkbox item to the popup. Teh callback gets called
		953	whenever it gets toggled, with a boolean indicating its value as its
		954	first argument.
		955
		956	$popup->show
		957	Displays the popup (which is initially hidden).
		958
594	The "urxvt::timer" Class	959	The "urxvt::timer" Class
595	This class implements timer watchers/events. Time is represented as	960	This class implements timer watchers/events. Time is represented as a
596	a fractional number of seconds since the epoch. Example:	961	fractional number of seconds since the epoch. Example:
597		962
598	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);	963	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
599	$term->{timer} = urxvt::timer	964	$term->{timer} = urxvt::timer
600	->new	965	->new
601	->interval (1)	966	->interval (1)
602	->cb (sub {	967	->cb (sub {
603	$term->{overlay}->set (0, 0,	968	$term->{overlay}->set (0, 0,
604	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	969	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
605	});	970	});
606		971
607	$timer = new urxvt::timer	972	$timer = new urxvt::timer
608	Create a new timer object in started state. It is scheduled to	973	Create a new timer object in started state. It is scheduled to fire
609	fire immediately.	974	immediately.
610		975
611	$timer = $timer->cb (sub { my ($timer) = @_; ... })	976	$timer = $timer->cb (sub { my ($timer) = @_; ... })
612	Set the callback to be called when the timer triggers.	977	Set the callback to be called when the timer triggers.
613		978
614	$tstamp = $timer->at	979	$tstamp = $timer->at
615	Return the time this watcher will fire next.	980	Return the time this watcher will fire next.
616		981
617	$timer = $timer->set ($tstamp)	982	$timer = $timer->set ($tstamp)
618	Set the time the event is generated to $tstamp.	983	Set the time the event is generated to $tstamp.
619		984
620	$timer = $timer->interval ($interval)	985	$timer = $timer->interval ($interval)
621	Normally (and when $interval is 0), the timer will automatically	986	Normally (and when $interval is 0), the timer will automatically
622	stop after it has fired once. If $interval is non-zero, then the	987	stop after it has fired once. If $interval is non-zero, then the
623	timer is automatically rescheduled at the given intervals.	988	timer is automatically rescheduled at the given intervals.
624		989
625	$timer = $timer->start	990	$timer = $timer->start
626	Start the timer.	991	Start the timer.
627		992
628	$timer = $timer->start ($tstamp)	993	$timer = $timer->start ($tstamp)
629	Set the event trigger time to $tstamp and start the timer.	994	Set the event trigger time to $tstamp and start the timer.
630		995
		996	$timer = $timer->after ($delay)
		997	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
		998
631	$timer = $timer->stop	999	$timer = $timer->stop
632	Stop the timer.	1000	Stop the timer.
633		1001
634	The "urxvt::iow" Class	1002	The "urxvt::iow" Class
635	This class implements io watchers/events. Example:	1003	This class implements io watchers/events. Example:
636		1004
637	$term->{socket} = ...	1005	$term->{socket} = ...
638	$term->{iow} = urxvt::iow	1006	$term->{iow} = urxvt::iow
		1007	->new
		1008	->fd (fileno $term->{socket})
		1009	->events (urxvt::EVENT_READ)
		1010	->start
		1011	->cb (sub {
		1012	my ($iow, $revents) = @_;
		1013	# $revents must be 1 here, no need to check
		1014	sysread $term->{socket}, my $buf, 8192
		1015	or end-of-file;
		1016	});
		1017
		1018	$iow = new urxvt::iow
		1019	Create a new io watcher object in stopped state.
		1020
		1021	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
		1022	Set the callback to be called when io events are triggered.
		1023	$reventmask is a bitset as described in the "events" method.
		1024
		1025	$iow = $iow->fd ($fd)
		1026	Set the filedescriptor (not handle) to watch.
		1027
		1028	$iow = $iow->events ($eventmask)
		1029	Set the event mask to watch. The only allowed values are
		1030	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1031	together, or "urxvt::EVENT_NONE".
		1032
		1033	$iow = $iow->start
		1034	Start watching for requested events on the given handle.
		1035
		1036	$iow = $iow->stop
		1037	Stop watching for events on the given filehandle.
		1038
		1039	The "urxvt::iw" Class
		1040	This class implements idle watchers, that get called automatically when
		1041	the process is idle. They should return as fast as possible, after doing
		1042	some useful work.
		1043
		1044	$iw = new urxvt::iw
		1045	Create a new idle watcher object in stopped state.
		1046
		1047	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1048	Set the callback to be called when the watcher triggers.
		1049
		1050	$timer = $timer->start
		1051	Start the watcher.
		1052
		1053	$timer = $timer->stop
		1054	Stop the watcher.
		1055
		1056	The "urxvt::pw" Class
		1057	This class implements process watchers. They create an event whenever a
		1058	process exits, after which they stop automatically.
		1059
		1060	my $pid = fork;
		1061	...
		1062	$term->{pw} = urxvt::pw
639	->new	1063	->new
640	->fd (fileno $term->{socket})
641	->events (1) # wait for read data
642	->start	1064	->start ($pid)
643	->cb (sub {	1065	->cb (sub {
644	my ($iow, $revents) = @_;	1066	my ($pw, $exit_status) = @_;
645	# $revents must be 1 here, no need to check
646	sysread $term->{socket}, my $buf, 8192
647	or end-of-file;
648	});	1067	...
		1068	});
649		1069
650	$iow = new urxvt::iow	1070	$pw = new urxvt::pw
651	Create a new io watcher object in stopped state.	1071	Create a new process watcher in stopped state.
652		1072
653	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	1073	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
654	Set the callback to be called when io events are triggered.	1074	Set the callback to be called when the timer triggers.
655	$reventmask is a bitset as described in the "events" method.
656		1075
657	$iow = $iow->fd ($fd)	1076	$pw = $timer->start ($pid)
658	Set the filedescriptor (not handle) to watch.	1077	Tells the wqtcher to start watching for process $pid.
659		1078
660	$iow = $iow->events ($eventmask)
661	Set the event mask to watch. Bit #0 (value 1) enables watching
662	for read data, Bit #1 (value 2) enables watching for write data.
663
664	$iow = $iow->start
665	Start watching for requested events on the given handle.
666
667	$iow = $iow->stop	1079	$pw = $pw->stop
668	Stop watching for events on the given filehandle.	1080	Stop the watcher.
669		1081
670	ENVIRONMENT	1082	ENVIRONMENT
671	URXVT_PERL_VERBOSITY	1083	URXVT_PERL_VERBOSITY
672	This variable controls the verbosity level of the perl extension.	1084	This variable controls the verbosity level of the perl extension. Higher
673	Higher numbers indicate more verbose output.	1085	numbers indicate more verbose output.
674		1086
675	=0 - only fatal messages	1087	== 0 - fatal messages
676	=3 - script loading and management	1088	>= 3 - script loading and management
677	=10 - all events received	1089	>=10 - all called hooks
		1090	>=11 - hook reutrn values
678		1091
679	AUTHOR	1092	AUTHOR
680	Marc Lehmann <pcg@goof.com>	1093	Marc Lehmann <pcg@goof.com>
681	http://software.schmorp.de/pkg/rxvt-unicode	1094	http://software.schmorp.de/pkg/rxvt-unicode
682		1095

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC vs. Revision 1.32 by root, Fri Jan 20 16:02:20 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.32 by root, Fri Jan 20 16:02:20 2006 UTC