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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.17 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.34 by root, Sat Jan 21 19:50:53 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	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
…		…
48	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)	74	Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
49	options at runtime.	75	options at runtime.
50		76
51	selection-popup (enabled by default)	77	selection-popup (enabled by default)
52	Binds a popup menu to Ctrl-Button3 that lets you convert the	78	Binds a popup menu to Ctrl-Button3 that lets you convert the
53	selection text into various other formats/action.	79	selection text into various other formats/action (such as uri
		80	unescaping, perl evaluation, web-browser starting etc.), depending
		81	on 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	};
54		102
55	searchable-scrollback<hotkey> (enabled by default)	103	searchable-scrollback<hotkey> (enabled by default)
56	Adds regex search functionality to the scrollback buffer, triggered	104	Adds regex search functionality to the scrollback buffer, triggered
57	by a hotkey (default: "M-s"). When in search mode, normal terminal	105	by a hotkey (default: "M-s"). While in search mode, normal terminal
58	input/output is suspended.	106	input/output is suspended and a regex is displayed at the bottom of
		107	the screen.
59		108
60	"/" starts an incremental regex search, "n" searches further, "p" or	109	Inputting characters appends them to the regex and continues
61	"N" jump to the previous match, "G" jumps to the bottom and clears	110	incremental search. "BackSpace" removes a character from the regex,
62	the history, "enter" leaves search mode at the current position and	111	"Up" and "Down" search upwards/downwards in the scrollback buffer,
63	"escape" returns to the original position.	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.
64		116
65	digital-clock	117	readline (enabled by default)
66	Displays a digital clock using the built-in overlay.	118	A support package that tries to make editing with readline easier.
		119	At the moment, it reacts to clicking with the left mouse button by
		120	trying to move the text cursor to this position. It does so by
		121	generating as many cursor-left or cursor-right keypresses as
		122	required (the this only works for programs that correctly support
		123	wide characters).
		124
		125	To avoid too many false positives, this is only done when:
		126
		127	- the mouse is on the same (multi-row-) line as the text cursor.
		128	- the primary screen is currently being displayed.
		129	- the text cursor is visible.
		130
		131	The normal selection mechanism isn't disabled, so quick successive
		132	clicks might interfere with selection creation in harmless ways.
		133
		134	selection-autotransform
		135	This selection allows you to do automatic transforms on a selection
		136	whenever a selection is made.
		137
		138	It works by specifying perl snippets (most useful is a single "s///"
		139	operator) that modify $_ as resources:
		140
		141	URxvt.selection-autotransform.0: transform
		142	URxvt.selection-autotransform.1: transform
		143	...
		144
		145	For example, the following will transform selections of the form
		146	"filename:number", often seen in compiler messages, into "vi
		147	+$filename $word":
		148
		149	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		150
		151	And this example matches the same,but replaces it with vi-commands
		152	you can paste directly into your (vi :) editor:
		153
		154	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		155
		156	Of course, this can be modified to suit your needs and your editor
		157	:)
		158
		159	To expand the example above to typical perl error messages ("XXX at
		160	FILENAME line YYY."), you need a slightly more elaborate solution:
		161
		162	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		163	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		164
		165	The first line tells the selection code to treat the unchanging part
		166	of every error message as a selection pattern, and the second line
		167	transforms the message into vi commands to load the file.
		168
		169	tabbed
		170	This transforms the terminal into a tabbar with additional
		171	terminals, that is, it implements what is commonly refered to as
		172	"tabbed terminal". The topmost line displays a "[NEW]" button,
		173	which, when clicked, will add a new tab, followed by one button per
		174	tab.
		175
		176	Clicking a button will activate that tab. Pressing Shift-Left and
		177	Shift-Right will switch to the tab left or right of the current one,
		178	while Shift-Down creates a new tab.
67		179
68	mark-urls	180	mark-urls
69	Uses per-line display filtering ("on_line_update") to underline	181	Uses per-line display filtering ("on_line_update") to underline urls
70	urls.	182	and make them clickable. When middle-clicked, the program specified
		183	in the resource "urlLauncher" (default "x-www-browser") will be
		184	started with the URL as first argument.
		185
		186	automove-background
		187	This is basically a one-line extension that dynamically changes the
		188	background pixmap offset to the window position, in effect creating
		189	the same effect as pseudo transparency with a custom pixmap. No
		190	scaling is supported in this mode. Exmaple:
		191
		192	rxvt -pixmap background.xpm -pe automove-background
71		193
72	block-graphics-to-ascii	194	block-graphics-to-ascii
73	A not very useful example of filtering all text output to the	195	A not very useful example of filtering all text output to the
74	terminal, by replacing all line-drawing characters (U+2500 ..	196	terminal, by replacing all line-drawing characters (U+2500 ..
75	U+259F) by a similar-looking ascii character.	197	U+259F) by a similar-looking ascii character.
76		198
		199	digital-clock
		200	Displays a digital clock using the built-in overlay.
		201
77	example-refresh-hooks	202	example-refresh-hooks
78	Displays a very simple digital clock in the upper right corner of	203	Displays a very simple digital clock in the upper right corner of
79	the window. Illustrates overwriting the refresh callbacks to create	204	the window. Illustrates overwriting the refresh callbacks to create
80	your own overlays or changes.	205	your own overlays or changes.
81		206
		207	selection-pastebin
		208	This is a little rarely useful extension that Uploads the selection
		209	as textfile to a remote site (or does other things). (The
		210	implementation is not currently secure for use in a multiuser
		211	environment as it writes to /tmp directly.).
		212
		213	It listens to the "selection-pastebin:remote-pastebin" keyboard
		214	command, i.e.
		215
		216	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		217
		218	Pressing this combination runs a command with "%" replaced by the
		219	name of the textfile. This command can be set via a resource:
		220
		221	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		222
		223	And the default is likely not useful to anybody but the few people
		224	around here :)
		225
		226	The name of the textfile is the hex encoded md5 sum of the
		227	selection, so the same content should lead to the same filename.
		228
		229	After a successful upload the selection will be replaced by the text
		230	given in the "selection-pastebin-url" resource (again, the % is the
		231	placeholder for the filename):
		232
		233	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		234
		235	API DOCUMENTATION
82	General API Considerations	236	General API Considerations
83	All objects (such as terminals, time watchers etc.) are typical	237	All objects (such as terminals, time watchers etc.) are typical
84	reference-to-hash objects. The hash can be used to store anything you	238	reference-to-hash objects. The hash can be used to store anything you
85	like. All members starting with an underscore (such as "_ptr" or	239	like. All members starting with an underscore (such as "_ptr" or
86	"_hook") are reserved for internal uses and MUST NOT be accessed or	240	"_hook") are reserved for internal uses and MUST NOT be accessed or
…		…
94	Argument names also often indicate the type of a parameter. Here are	248	Argument names also often indicate the type of a parameter. Here are
95	some hints on what they mean:	249	some hints on what they mean:
96		250
97	$text	251	$text
98	Rxvt-unicodes special way of encoding text, where one "unicode"	252	Rxvt-unicodes special way of encoding text, where one "unicode"
99	character always represents one screen cell. See row_t for a	253	character always represents one screen cell. See ROW_t for a
100	discussion of this format.	254	discussion of this format.
101		255
102	$string	256	$string
103	A perl text string, with an emphasis on text. It can store all	257	A perl text string, with an emphasis on text. It can store all
104	unicode characters and is to be distinguished with text encoded in a	258	unicode characters and is to be distinguished with text encoded in a
…		…
138	be called whenever the relevant event happens.	292	be called whenever the relevant event happens.
139		293
140	The first argument passed to them is an extension oject as described in	294	The first argument passed to them is an extension oject as described in
141	the in the "Extension Objects" section.	295	the in the "Extension Objects" section.
142		296
143	All of these hooks must return a boolean value. If it is true, then the	297	All of these hooks must return a boolean value. If any of the called
144	event counts as being consumed, and the invocation of other hooks is	298	hooks returns true, then the event counts as being consumed, and the
145	skipped, and the relevant action might not be carried out by the C++	299	relevant action might not be carried out by the C++ code.
146	code.
147		300
148	When in doubt, return a false value (preferably "()").	301	When in doubt, return a false value (preferably "()").
149		302
150	on_init $term	303	on_init $term
151	Called after a new terminal object has been initialized, but before	304	Called after a new terminal object has been initialized, but before
152	windows are created or the command gets run. Most methods are unsafe	305	windows are created or the command gets run. Most methods are unsafe
153	to call or deliver senseless data, as terminal size and other	306	to call or deliver senseless data, as terminal size and other
154	characteristics have not yet been determined. You can safely query	307	characteristics have not yet been determined. You can safely query
155	and change resources, though.	308	and change resources and options, though. For many purposes the
		309	"on_start" hook is a better place.
		310
		311	on_start $term
		312	Called at the very end of initialisation of a new terminal, just
		313	before trying to map (display) the toplevel and returning to the
		314	mainloop.
		315
		316	on_destroy $term
		317	Called whenever something tries to destroy terminal, before doing
		318	anything yet. If this hook returns true, then destruction is
		319	skipped, but this is rarely a good idea.
156		320
157	on_reset $term	321	on_reset $term
158	Called after the screen is "reset" for any reason, such as resizing	322	Called after the screen is "reset" for any reason, such as resizing
159	or control sequences. Here is where you can react on changes to	323	or control sequences. Here is where you can react on changes to
160	size-related variables.	324	size-related variables.
161		325
162	on_start $term	326	on_child_start $term, $pid
163	Called at the very end of initialisation of a new terminal, just	327	Called just after the child process has been "fork"ed.
164	before returning to the mainloop.	328
		329	on_child_exit $term, $status
		330	Called just after the child process has exited. $status is the
		331	status from "waitpid".
165		332
166	on_sel_make $term, $eventtime	333	on_sel_make $term, $eventtime
167	Called whenever a selection has been made by the user, but before	334	Called whenever a selection has been made by the user, but before
168	the selection text is copied, so changes to the beginning, end or	335	the selection text is copied, so changes to the beginning, end or
169	type of the selection will be honored.	336	type of the selection will be honored.
…		…
182		349
183	on_sel_extend $term	350	on_sel_extend $term
184	Called whenever the user tries to extend the selection (e.g. with a	351	Called whenever the user tries to extend the selection (e.g. with a
185	double click) and is either supposed to return false (normal	352	double click) and is either supposed to return false (normal
186	operation), or should extend the selection itelf and return true to	353	operation), or should extend the selection itelf and return true to
187	suppress the built-in processing.	354	suppress the built-in processing. This can happen multiple times, as
		355	long as the callback returns true, it will be called on every
		356	further click by the user and is supposed to enlarge the selection
		357	more and more, if possible.
188		358
189	See the selection example extension.	359	See the selection example extension.
190		360
191	on_view_change $term, $offset	361	on_view_change $term, $offset
192	Called whenever the view offset changes, i..e the user or program	362	Called whenever the view offset changes, i..e the user or program
…		…
251	on_keyboard_command $term, $string	421	on_keyboard_command $term, $string
252	Called whenever the user presses a key combination that has a	422	Called whenever the user presses a key combination that has a
253	"perl:string" action bound to it (see description of the keysym	423	"perl:string" action bound to it (see description of the keysym
254	resource in the rxvt(1) manpage).	424	resource in the rxvt(1) manpage).
255		425
		426	on_x_event $term, $event
		427	Called on every X event received on the vt window (and possibly
		428	other windows). Should only be used as a last resort. Most event
		429	structure members are not passed.
		430
256	on_focus_in $term	431	on_focus_in $term
257	Called whenever the window gets the keyboard focus, before	432	Called whenever the window gets the keyboard focus, before
258	rxvt-unicode does focus in processing.	433	rxvt-unicode does focus in processing.
259		434
260	on_focus_out $term	435	on_focus_out $term
261	Called wheneever the window loses keyboard focus, before	436	Called wheneever the window loses keyboard focus, before
262	rxvt-unicode does focus out processing.	437	rxvt-unicode does focus out processing.
263		438
		439	on_configure_notify $term, $event
		440	on_property_notify $term, $event
264	on_key_press $term, $event, $keysym, $octets	441	on_key_press $term, $event, $keysym, $octets
265	on_key_release $term, $event, $keysym	442	on_key_release $term, $event, $keysym
266	on_button_press $term, $event	443	on_button_press $term, $event
267	on_button_release $term, $event	444	on_button_release $term, $event
268	on_motion_notify $term, $event	445	on_motion_notify $term, $event
…		…
272	terminal If the hook returns true, then the even will be ignored by	449	terminal If the hook returns true, then the even will be ignored by
273	rxvt-unicode.	450	rxvt-unicode.
274		451
275	The event is a hash with most values as named by Xlib (see the	452	The event is a hash with most values as named by Xlib (see the
276	XEvent manpage), with the additional members "row" and "col", which	453	XEvent manpage), with the additional members "row" and "col", which
277	are the row and column under the mouse cursor.	454	are the (real, not screen-based) row and column under the mouse
		455	cursor.
278		456
279	"on_key_press" additionally receives the string rxvt-unicode would	457	"on_key_press" additionally receives the string rxvt-unicode would
280	output, if any, in locale-specific encoding.	458	output, if any, in locale-specific encoding.
281		459
282	subwindow.	460	subwindow.
283		461
		462	on_client_message $term, $event
		463	on_wm_protocols $term, $event
		464	on_wm_delete_window $term, $event
		465	Called when various types of ClientMessage events are received (all
		466	with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		467
284	Variables in the "urxvt" Package	468	Variables in the "urxvt" Package
		469	$urxvt::LIBDIR
		470	The rxvt-unicode library directory, where, among other things, the
		471	perl modules and scripts are stored.
		472
		473	$urxvt::RESCLASS, $urxvt::RESCLASS
		474	The resource class and name rxvt-unicode uses to look up X
		475	resources.
		476
		477	$urxvt::RXVTNAME
		478	The basename of the installed binaries, usually "urxvt".
		479
285	$urxvt::TERM	480	$urxvt::TERM
286	The current terminal. This variable stores the current "urxvt::term"	481	The current terminal. This variable stores the current "urxvt::term"
287	object, whenever a callback/hook is executing.	482	object, whenever a callback/hook is executing.
288		483
		484	@urxvt::TERM_INIT
		485	All coderefs in this array will be called as methods of the next
		486	newly created "urxvt::term" object (during the "on_init" phase). The
		487	array gets cleared before the codereferences that were in it are
		488	being executed, so coderefs can push themselves onto it again if
		489	they so desire.
		490
		491	This complements to the perl-eval commandline option, but gets
		492	executed first.
		493
		494	@urxvt::TERM_EXT
		495	Works similar to @TERM_INIT, but contains perl package/class names,
		496	which get registered as normal extensions after calling the hooks in
		497	@TERM_INIT but before other extensions. Gets cleared just like
		498	@TERM_INIT.
		499
289	Functions in the "urxvt" Package	500	Functions in the "urxvt" Package
290	$term = new urxvt [arg...]
291	Creates a new terminal, very similar as if you had started it with
292	"system $binfile, arg...". Croaks (and probably outputs an error
293	message) if the new instance couldn't be created. Returns "undef" if
294	the new instance didn't initialise perl, and the terminal object
295	otherwise. The "init" and "start" hooks will be called during the
296	call.
297
298	urxvt::fatal $errormessage	501	urxvt::fatal $errormessage
299	Fatally aborts execution with the given error message. Avoid at all	502	Fatally aborts execution with the given error message. Avoid at all
300	costs! The only time this is acceptable is when the terminal process	503	costs! The only time this is acceptable is when the terminal process
301	starts up.	504	starts up.
302		505
…		…
306	function that calls this function.	509	function that calls this function.
307		510
308	Using this function has the advantage that its output ends up in the	511	Using this function has the advantage that its output ends up in the
309	correct place, e.g. on stderr of the connecting urxvtc client.	512	correct place, e.g. on stderr of the connecting urxvtc client.
310		513
311	$is_safe = urxvt::safe	514	Messages have a size limit of 1023 bytes currently.
312	Returns true when it is safe to do potentially unsafe things, such
313	as evaluating perl code specified by the user. This is true when
314	urxvt was started setuid or setgid.
315		515
316	$time = urxvt::NOW	516	$time = urxvt::NOW
317	Returns the "current time" (as per the event loop).	517	Returns the "current time" (as per the event loop).
318		518
319	urxvt::CurrentTime	519	urxvt::CurrentTime
320	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,	520	urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
321	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,	521	Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
322	Button5Mask, AnyModifier	522	Button5Mask, AnyModifier
		523	urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
		524	ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
		525	PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		526	Button3MotionMask, Button4MotionMask, Button5MotionMask,
		527	ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
		528	StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
		529	SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
		530	ColormapChangeMask, OwnerGrabButtonMask
		531	urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		532	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		533	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		534	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		535	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		536	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		537	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
323	Various constants for use in X calls and event processing.	538	Various constants for use in X calls and event processing.
324		539
325	RENDITION	540	RENDITION
326	Rendition bitsets contain information about colour, font, font styles	541	Rendition bitsets contain information about colour, font, font styles
327	and similar information for each screen cell.	542	and similar information for each screen cell.
…		…
346		561
347	$foreground = urxvt::GET_BASEFG $rend	562	$foreground = urxvt::GET_BASEFG $rend
348	$background = urxvt::GET_BASEBG $rend	563	$background = urxvt::GET_BASEBG $rend
349	Return the foreground/background colour index, respectively.	564	Return the foreground/background colour index, respectively.
350		565
351	$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	566	$rend = urxvt::SET_FGCOLOR $rend, $new_colour
352	$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	567	$rend = urxvt::SET_BGCOLOR $rend, $new_colour
353	Replace the foreground/background colour in the rendition mask with	568	Replace the foreground/background colour in the rendition mask with
354	the specified one.	569	the specified one.
355		570
356	$value = urxvt::GET_CUSTOM ($rend)	571	$value = urxvt::GET_CUSTOM $rend
357	Return the "custom" value: Every rendition has 5 bits for use by	572	Return the "custom" value: Every rendition has 5 bits for use by
358	extensions. They can be set and changed as you like and are	573	extensions. They can be set and changed as you like and are
359	initially zero.	574	initially zero.
360		575
361	$rend = urxvt::SET_CUSTOM ($rend, $new_value)	576	$rend = urxvt::SET_CUSTOM $rend, $new_value
362	Change the custom value.	577	Change the custom value.
363		578
364	The "urxvt::anyevent" Class	579	The "urxvt::anyevent" Class
365	The sole purpose of this class is to deliver an interface to the	580	The sole purpose of this class is to deliver an interface to the
366	"AnyEvent" module - any module using it will work inside urxvt without	581	"AnyEvent" module - any module using it will work inside urxvt without
367	further work. The only exception is that you cannot wait on condition	582	further programming. The only exception is that you cannot wait on
368	variables, but non-blocking condvar use is ok. What this means is that	583	condition variables, but non-blocking condvar use is ok. What this means
369	you cannot use blocking APIs, but the non-blocking variant should work.	584	is that you cannot use blocking APIs, but the non-blocking variant
		585	should work.
370		586
371	The "urxvt::term" Class	587	The "urxvt::term" Class
		588	$term = new urxvt::term $envhashref, $rxvtname, [arg...]
		589	Creates a new terminal, very similar as if you had started it with
		590	system "$rxvtname, arg...". $envhashref must be a reference to a
		591	%ENV-like hash which defines the environment of the new terminal.
		592
		593	Croaks (and probably outputs an error message) if the new instance
		594	couldn't be created. Returns "undef" if the new instance didn't
		595	initialise perl, and the terminal object otherwise. The "init" and
		596	"start" hooks will be called during this call.
		597
372	$term->destroy	598	$term->destroy
373	Destroy the terminal object (close the window, free resources etc.).	599	Destroy the terminal object (close the window, free resources etc.).
		600	Please note that rxvt will not exit as long as any event watchers
		601	(timers, io watchers) are still active.
		602
		603	$term->exec_async ($cmd[, @args])
		604	Works like the combination of the "fork"/"exec" builtins, which
		605	executes ("starts") programs in the background. This function takes
		606	care of setting the user environment before exec'ing the command
		607	(e.g. "PATH") and should be preferred over explicit calls to "exec"
		608	or "system".
		609
		610	Returns the pid of the subprocess or "undef" on error.
374		611
375	$isset = $term->option ($optval[, $set])	612	$isset = $term->option ($optval[, $set])
376	Returns true if the option specified by $optval is enabled, and	613	Returns true if the option specified by $optval is enabled, and
377	optionally change it. All option values are stored by name in the	614	optionally change it. All option values are stored by name in the
378	hash %urxvt::OPTION. Options not enabled in this binary are not in	615	hash %urxvt::OPTION. Options not enabled in this binary are not in
…		…
381	Here is a a likely non-exhaustive list of option names, please see	618	Here is a a likely non-exhaustive list of option names, please see
382	the source file /src/optinc.h to see the actual list:	619	the source file /src/optinc.h to see the actual list:
383		620
384	borderLess console cursorBlink cursorUnderline hold iconic insecure	621	borderLess console cursorBlink cursorUnderline hold iconic insecure
385	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	622	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
386	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	623	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
387	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	624	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
388	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	625	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
389	tripleclickwords utmpInhibit visualBell	626	transparent tripleclickwords utmpInhibit visualBell
390		627
391	$value = $term->resource ($name[, $newval])	628	$value = $term->resource ($name[, $newval])
392	Returns the current resource value associated with a given name and	629	Returns the current resource value associated with a given name and
393	optionally sets a new value. Setting values is most useful in the	630	optionally sets a new value. Setting values is most useful in the
394	"init" hook. Unset resources are returned and accepted as "undef".	631	"init" hook. Unset resources are returned and accepted as "undef".
…		…
411		648
412	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	649	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
413	borderLess color cursorBlink cursorUnderline cutchars delete_key	650	borderLess color cursorBlink cursorUnderline cutchars delete_key
414	display_name embed ext_bwidth fade font geometry hold iconName	651	display_name embed ext_bwidth fade font geometry hold iconName
415	imFont imLocale inputMethod insecure int_bwidth intensityStyles	652	imFont imLocale inputMethod insecure int_bwidth intensityStyles
416	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	653	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
417	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	654	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
418	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	655	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
419	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	656	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
420	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	657	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
421	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	658	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		659	secondaryScreen secondaryScroll selectstyle shade term_name title
422	shade term_name title transparent transparent_all tripleclickwords	660	transient_for transparent transparent_all tripleclickwords utmpInhibit
423	utmpInhibit visualBell	661	visualBell
		662
		663	$value = $term->x_resource ($pattern)
		664	Returns the X-Resource for the given pattern, excluding the program
		665	or class name, i.e. "$term->x_resource ("boldFont")" should return
		666	the same value as used by this instance of rxvt-unicode. Returns
		667	"undef" if no resource with that pattern exists.
		668
		669	This method should only be called during the "on_start" hook, as
		670	there is only one resource database per display, and later
		671	invocations might return the wrong resources.
424		672
425	$success = $term->parse_keysym ($keysym_spec, $command_string)	673	$success = $term->parse_keysym ($keysym_spec, $command_string)
426	Adds a keymap translation exactly as specified via a resource. See	674	Adds a keymap translation exactly as specified via a resource. See
427	the "keysym" resource in the rxvt(1) manpage.	675	the "keysym" resource in the rxvt(1) manpage.
428		676
…		…
439	($row, $col) = $term->selection_beg ([$row, $col])	687	($row, $col) = $term->selection_beg ([$row, $col])
440	($row, $col) = $term->selection_end ([$row, $col])	688	($row, $col) = $term->selection_end ([$row, $col])
441	Return the current values of the selection mark, begin or end	689	Return the current values of the selection mark, begin or end
442	positions, and optionally set them to new values.	690	positions, and optionally set them to new values.
443		691
		692	$term->selection_make ($eventtime[, $rectangular])
		693	Tries to make a selection as set by "selection_beg" and
		694	"selection_end". If $rectangular is true (default: false), a
		695	rectangular selection will be made. This is the prefered function to
		696	make a selection.
		697
444	$success = $term->selection_grab ($eventtime)	698	$success = $term->selection_grab ($eventtime)
445	Try to request the primary selection from the server (for example,	699	Try to request the primary selection text from the server (for
446	as set by the next method).	700	example, as set by the next method). No visual feedback will be
		701	given. This function is mostly useful from within "on_sel_grab"
		702	hooks.
447		703
448	$oldtext = $term->selection ([$newtext])	704	$oldtext = $term->selection ([$newtext])
449	Return the current selection text and optionally replace it by	705	Return the current selection text and optionally replace it by
450	$newtext.	706	$newtext.
451		707
…		…
496	$string = $term->locale_decode ($octets)	752	$string = $term->locale_decode ($octets)
497	Convert the given locale-encoded octets into a perl string.	753	Convert the given locale-encoded octets into a perl string.
498		754
499	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	755	$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
500	XORs the rendition values in the given span with the provided value	756	XORs the rendition values in the given span with the provided value
501	(default: "RS_RVid"). Useful in refresh hooks to provide effects	757	(default: "RS_RVid"), which MUST NOT contain font styles. Useful
502	similar to the selection.	758	in refresh hooks to provide effects similar to the selection.
503		759
504	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,	760	$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
505	$rstyle2]])	761	$rstyle2]])
506	Similar to "scr_xor_span", but xors a rectangle instead. Trailing	762	Similar to "scr_xor_span", but xors a rectangle instead. Trailing
507	whitespace will additionally be xored with the $rstyle2, which	763	whitespace will additionally be xored with the $rstyle2, which
508	defaults to "RS_RVid \| RS_Uline", which removes reverse video again	764	defaults to "RS_RVid \| RS_Uline", which removes reverse video again
509	and underlines it instead.	765	and underlines it instead. Both styles MUST NOT contain font
		766	styles.
510		767
511	$term->scr_bell	768	$term->scr_bell
512	Ring the bell!	769	Ring the bell!
513		770
514	$term->scr_add_lines ($string)	771	$term->scr_add_lines ($string)
…		…
520		777
521	Normally its not a good idea to use this function, as programs might	778	Normally its not a good idea to use this function, as programs might
522	be confused by changes in cursor position or scrolling. Its useful	779	be confused by changes in cursor position or scrolling. Its useful
523	inside a "on_add_lines" hook, though.	780	inside a "on_add_lines" hook, though.
524		781
		782	$term->scr_change_screen ($screen)
		783	Switch to given screen - 0 primary, 1 secondary.
		784
525	$term->cmd_parse ($octets)	785	$term->cmd_parse ($octets)
526	Similar to "scr_add_lines", but the argument must be in the	786	Similar to "scr_add_lines", but the argument must be in the
527	locale-specific encoding of the terminal and can contain command	787	locale-specific encoding of the terminal and can contain command
528	sequences (escape codes) that will be interpreted.	788	sequences (escape codes) that will be interpreted.
529		789
…		…
542	$windowid = $term->parent	802	$windowid = $term->parent
543	Return the window id of the toplevel window.	803	Return the window id of the toplevel window.
544		804
545	$windowid = $term->vt	805	$windowid = $term->vt
546	Return the window id of the terminal window.	806	Return the window id of the terminal window.
		807
		808	$term->vt_emask_add ($x_event_mask)
		809	Adds the specified events to the vt event mask. Useful e.g. when you
		810	want to receive pointer events all the times:
		811
		812	$term->vt_emask_add (urxvt::PointerMotionMask);
547		813
548	$window_width = $term->width	814	$window_width = $term->width
549	$window_height = $term->height	815	$window_height = $term->height
550	$font_width = $term->fwidth	816	$font_width = $term->fwidth
551	$font_height = $term->fheight	817	$font_height = $term->fheight
…		…
554	$terminal_columns = $term->ncol	820	$terminal_columns = $term->ncol
555	$has_focus = $term->focus	821	$has_focus = $term->focus
556	$is_mapped = $term->mapped	822	$is_mapped = $term->mapped
557	$max_scrollback = $term->saveLines	823	$max_scrollback = $term->saveLines
558	$nrow_plus_saveLines = $term->total_rows	824	$nrow_plus_saveLines = $term->total_rows
559	$lines_in_scrollback = $term->nsaved	825	$topmost_scrollback_row = $term->top_row
560	Return various integers describing terminal characteristics.	826	Return various integers describing terminal characteristics.
		827
		828	$x_display = $term->display_id
		829	Return the DISPLAY used by rxvt-unicode.
561		830
562	$lc_ctype = $term->locale	831	$lc_ctype = $term->locale
563	Returns the LC_CTYPE category string used by this rxvt-unicode.	832	Returns the LC_CTYPE category string used by this rxvt-unicode.
564		833
565	$x_display = $term->display_id	834	$env = $term->env
566	Return the DISPLAY used by rxvt-unicode.	835	Returns a copy of the environment in effect for the terminal as a
		836	hashref similar to "\%ENV".
567		837
568	$modifiermask = $term->ModLevel3Mask	838	$modifiermask = $term->ModLevel3Mask
569	$modifiermask = $term->ModMetaMask	839	$modifiermask = $term->ModMetaMask
570	$modifiermask = $term->ModNumLockMask	840	$modifiermask = $term->ModNumLockMask
571	Return the modifier masks corresponding to the "ISO Level 3 Shift"	841	Return the modifier masks corresponding to the "ISO Level 3 Shift"
572	(often AltGr), the meta key (often Alt) and the num lock key, if	842	(often AltGr), the meta key (often Alt) and the num lock key, if
573	applicable.	843	applicable.
574		844
		845	$screen = $term->current_screen
		846	Returns the currently displayed screen (0 primary, 1 secondary).
		847
		848	$cursor_is_hidden = $term->hidden_cursor
		849	Returns wether the cursor is currently hidden or not.
		850
575	$view_start = $term->view_start ([$newvalue])	851	$view_start = $term->view_start ([$newvalue])
576	Returns the negative row number of the topmost line. Minimum value	852	Returns the row number of the topmost displayed line. Maximum value
577	is 0, which displays the normal terminal contents. Larger values	853	is 0, which displays the normal terminal contents. Lower values
578	scroll this many lines into the scrollback buffer.	854	scroll this many lines into the scrollback buffer.
579		855
580	$term->want_refresh	856	$term->want_refresh
581	Requests a screen refresh. At the next opportunity, rxvt-unicode	857	Requests a screen refresh. At the next opportunity, rxvt-unicode
582	will compare the on-screen display with its stored representation.	858	will compare the on-screen display with its stored representation.
…		…
595	line, starting at column $start_col (default 0), which is useful to	871	line, starting at column $start_col (default 0), which is useful to
596	replace only parts of a line. The font index in the rendition will	872	replace only parts of a line. The font index in the rendition will
597	automatically be updated.	873	automatically be updated.
598		874
599	$text is in a special encoding: tabs and wide characters that use	875	$text is in a special encoding: tabs and wide characters that use
600	more than one cell when displayed are padded with urxvt::NOCHAR	876	more than one cell when displayed are padded with $urxvt::NOCHAR
601	characters ("chr 65535"). Characters with combining characters and	877	characters. Characters with combining characters and other
602	other characters that do not fit into the normal tetx encoding will	878	characters that do not fit into the normal tetx encoding will be
603	be replaced with characters in the private use area.	879	replaced with characters in the private use area.
604		880
605	You have to obey this encoding when changing text. The advantage is	881	You have to obey this encoding when changing text. The advantage is
606	that "substr" and similar functions work on screen cells and not on	882	that "substr" and similar functions work on screen cells and not on
607	characters.	883	characters.
608		884
…		…
650	Return the row number of the first/last row of the line,	926	Return the row number of the first/last row of the line,
651	respectively.	927	respectively.
652		928
653	$offset = $line->offset_of ($row, $col)	929	$offset = $line->offset_of ($row, $col)
654	Returns the character offset of the given row\|col pair within	930	Returns the character offset of the given row\|col pair within
655	the logical line.	931	the logical line. Works for rows outside the line, too, and
		932	returns corresponding offsets outside the string.
656		933
657	($row, $col) = $line->coord_of ($offset)	934	($row, $col) = $line->coord_of ($offset)
658	Translates a string offset into terminal coordinates again.	935	Translates a string offset into terminal coordinates again.
659		936
660	$text = $term->special_encode $string	937	$text = $term->special_encode $string
…		…
686	$term->ungrab	963	$term->ungrab
687	Calls XUngrab for the most recent grab. Is called automatically on	964	Calls XUngrab for the most recent grab. Is called automatically on
688	evaluation errors, as it is better to lose the grab in the error	965	evaluation errors, as it is better to lose the grab in the error
689	case as the session.	966	case as the session.
690		967
		968	$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		969	$atom_name = $term->XGetAtomName ($atom)
		970	@atoms = $term->XListProperties ($window)
		971	($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		972	$term->XChangeWindowProperty ($window, $property, $type, $format,
		973	$octets)
		974	$term->XDeleteProperty ($window, $property)
		975	$window = $term->DefaultRootWindow
		976	$term->XReparentWindow ($window, $parent, [$x, $y])
		977	$term->XMapWindow ($window)
		978	$term->XUnmapWindow ($window)
		979	$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		980	($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
		981	$y)
		982	$term->XChangeInput ($window, $add_events[, $del_events])
		983	Various X or X-related functions. The $term object only serves as
		984	the source of the display, otherwise those functions map
		985	more-or-less directory onto the X functions of the same name.
		986
691	The "urxvt::popup" Class	987	The "urxvt::popup" Class
		988	$popup->add_title ($title)
		989	Adds a non-clickable title to the popup.
		990
		991	$popup->add_separator ([$sepchr])
		992	Creates a separator, optionally using the character given as
		993	$sepchr.
		994
		995	$popup->add_button ($text, $cb)
		996	Adds a clickable button to the popup. $cb is called whenever it is
		997	selected.
		998
		999	$popup->add_toggle ($text, $cb, $initial_value)
		1000	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1001	whenever it gets toggled, with a boolean indicating its value as its
		1002	first argument.
		1003
		1004	$popup->show
		1005	Displays the popup (which is initially hidden).
		1006
692	The "urxvt::timer" Class	1007	The "urxvt::timer" Class
693	This class implements timer watchers/events. Time is represented as	1008	This class implements timer watchers/events. Time is represented as a
694	a fractional number of seconds since the epoch. Example:	1009	fractional number of seconds since the epoch. Example:
695		1010
696	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);	1011	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
697	$term->{timer} = urxvt::timer	1012	$term->{timer} = urxvt::timer
698	->new	1013	->new
699	->interval (1)	1014	->interval (1)
700	->cb (sub {	1015	->cb (sub {
701	$term->{overlay}->set (0, 0,	1016	$term->{overlay}->set (0, 0,
702	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1017	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
703	});	1018	});
704		1019
705	$timer = new urxvt::timer	1020	$timer = new urxvt::timer
706	Create a new timer object in started state. It is scheduled to	1021	Create a new timer object in started state. It is scheduled to fire
707	fire immediately.	1022	immediately.
708		1023
709	$timer = $timer->cb (sub { my ($timer) = @_; ... })	1024	$timer = $timer->cb (sub { my ($timer) = @_; ... })
710	Set the callback to be called when the timer triggers.	1025	Set the callback to be called when the timer triggers.
711		1026
712	$tstamp = $timer->at	1027	$tstamp = $timer->at
713	Return the time this watcher will fire next.	1028	Return the time this watcher will fire next.
714		1029
715	$timer = $timer->set ($tstamp)	1030	$timer = $timer->set ($tstamp)
716	Set the time the event is generated to $tstamp.	1031	Set the time the event is generated to $tstamp.
717		1032
718	$timer = $timer->interval ($interval)	1033	$timer = $timer->interval ($interval)
719	Normally (and when $interval is 0), the timer will automatically	1034	Normally (and when $interval is 0), the timer will automatically
720	stop after it has fired once. If $interval is non-zero, then the	1035	stop after it has fired once. If $interval is non-zero, then the
721	timer is automatically rescheduled at the given intervals.	1036	timer is automatically rescheduled at the given intervals.
722		1037
723	$timer = $timer->start	1038	$timer = $timer->start
724	Start the timer.	1039	Start the timer.
725		1040
726	$timer = $timer->start ($tstamp)	1041	$timer = $timer->start ($tstamp)
727	Set the event trigger time to $tstamp and start the timer.	1042	Set the event trigger time to $tstamp and start the timer.
728		1043
		1044	$timer = $timer->after ($delay)
		1045	Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
		1046
729	$timer = $timer->stop	1047	$timer = $timer->stop
730	Stop the timer.	1048	Stop the timer.
731		1049
732	The "urxvt::iow" Class	1050	The "urxvt::iow" Class
733	This class implements io watchers/events. Example:	1051	This class implements io watchers/events. Example:
734		1052
735	$term->{socket} = ...	1053	$term->{socket} = ...
736	$term->{iow} = urxvt::iow	1054	$term->{iow} = urxvt::iow
		1055	->new
		1056	->fd (fileno $term->{socket})
		1057	->events (urxvt::EVENT_READ)
		1058	->start
		1059	->cb (sub {
		1060	my ($iow, $revents) = @_;
		1061	# $revents must be 1 here, no need to check
		1062	sysread $term->{socket}, my $buf, 8192
		1063	or end-of-file;
		1064	});
		1065
		1066	$iow = new urxvt::iow
		1067	Create a new io watcher object in stopped state.
		1068
		1069	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
		1070	Set the callback to be called when io events are triggered.
		1071	$reventmask is a bitset as described in the "events" method.
		1072
		1073	$iow = $iow->fd ($fd)
		1074	Set the filedescriptor (not handle) to watch.
		1075
		1076	$iow = $iow->events ($eventmask)
		1077	Set the event mask to watch. The only allowed values are
		1078	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
		1079	together, or "urxvt::EVENT_NONE".
		1080
		1081	$iow = $iow->start
		1082	Start watching for requested events on the given handle.
		1083
		1084	$iow = $iow->stop
		1085	Stop watching for events on the given filehandle.
		1086
		1087	The "urxvt::iw" Class
		1088	This class implements idle watchers, that get called automatically when
		1089	the process is idle. They should return as fast as possible, after doing
		1090	some useful work.
		1091
		1092	$iw = new urxvt::iw
		1093	Create a new idle watcher object in stopped state.
		1094
		1095	$iw = $iw->cb (sub { my ($iw) = @_; ... })
		1096	Set the callback to be called when the watcher triggers.
		1097
		1098	$timer = $timer->start
		1099	Start the watcher.
		1100
		1101	$timer = $timer->stop
		1102	Stop the watcher.
		1103
		1104	The "urxvt::pw" Class
		1105	This class implements process watchers. They create an event whenever a
		1106	process exits, after which they stop automatically.
		1107
		1108	my $pid = fork;
		1109	...
		1110	$term->{pw} = urxvt::pw
737	->new	1111	->new
738	->fd (fileno $term->{socket})
739	->events (urxvt::EVENT_READ)
740	->start	1112	->start ($pid)
741	->cb (sub {	1113	->cb (sub {
742	my ($iow, $revents) = @_;	1114	my ($pw, $exit_status) = @_;
743	# $revents must be 1 here, no need to check
744	sysread $term->{socket}, my $buf, 8192
745	or end-of-file;
746	});	1115	...
		1116	});
747		1117
748	$iow = new urxvt::iow	1118	$pw = new urxvt::pw
749	Create a new io watcher object in stopped state.	1119	Create a new process watcher in stopped state.
750		1120
751	$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })	1121	$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
752	Set the callback to be called when io events are triggered.	1122	Set the callback to be called when the timer triggers.
753	$reventmask is a bitset as described in the "events" method.
754		1123
755	$iow = $iow->fd ($fd)	1124	$pw = $timer->start ($pid)
756	Set the filedescriptor (not handle) to watch.	1125	Tells the wqtcher to start watching for process $pid.
757		1126
758	$iow = $iow->events ($eventmask)
759	Set the event mask to watch. The only allowed values are
760	"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be
761	ORed together, or "urxvt::EVENT_NONE".
762
763	$iow = $iow->start
764	Start watching for requested events on the given handle.
765
766	$iow = $iow->stop	1127	$pw = $pw->stop
767	Stop watching for events on the given filehandle.	1128	Stop the watcher.
768		1129
769	ENVIRONMENT	1130	ENVIRONMENT
770	URXVT_PERL_VERBOSITY	1131	URXVT_PERL_VERBOSITY
771	This variable controls the verbosity level of the perl extension.	1132	This variable controls the verbosity level of the perl extension. Higher
772	Higher numbers indicate more verbose output.	1133	numbers indicate more verbose output.
773		1134
774	== 0 - fatal messages	1135	== 0 - fatal messages
775	>= 3 - script loading and management	1136	>= 3 - script loading and management
776	>=10 - all events received	1137	>=10 - all called hooks
		1138	>=11 - hook reutrn values
777		1139
778	AUTHOR	1140	AUTHOR
779	Marc Lehmann <pcg@goof.com>	1141	Marc Lehmann <pcg@goof.com>
780	http://software.schmorp.de/pkg/rxvt-unicode	1142	http://software.schmorp.de/pkg/rxvt-unicode
781		1143

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.17 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.17 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC