[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	rxvtperl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10	thus must be encoded as UTF-8.
11		10
12	sub on_sel_grab {	11	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
14	()	13	()
15	}	14	}
16		15
17	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		19
19	=head1 DESCRIPTION	20	=head1 DESCRIPTION
20		21
21	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, scripts specified via the
22	C<perl> resource are associated with it.	23	C<perl> resource are loaded and associated with it.
		24
		25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
23		27
24	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
25	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		44	Miscellaneous selection modifications.
		45
		46	=over 4
		47
		48	=item rot13
		49
		50	Rot-13 the selection when activated. Used via keyboard trigger:
		51
		52	URxvt.keysym.C-M-r: perl:selection:rot13
		53
		54	=back
		55
		56	=item digital-clock
		57
		58	Displays a very simple digital clock in the upper right corner of the
		59	window. Illustrates overwriting the refresh callbacks to create your own
		60	overlays or changes.
		61
		62	=item simple-overlay-clock
		63
		64	Displays a digital clock using the built-in overlay (colourful, useless).
		65
		66	=back
26		67
27	=head2 General API Considerations	68	=head2 General API Considerations
28		69
29	All objects (such as terminals, time watchers etc.) are typical	70	All objects (such as terminals, time watchers etc.) are typical
30	reference-to-hash objects. The hash can be used to store anything you	71	reference-to-hash objects. The hash can be used to store anything you
122		163
123	=item on_refresh_end $term	164	=item on_refresh_end $term
124		165
125	Called just after the screen gets redrawn. See C<on_refresh_begin>.	166	Called just after the screen gets redrawn. See C<on_refresh_begin>.
126		167
		168	=item on_keyboard_command $term, $string
		169
		170	Called whenever the user presses a key combination that has a
		171	C<perl:string> action bound to it (see description of the B<keysym>
		172	resource in the @@RXVT_NAME@@(1) manpage).
		173
127	=back	174	=back
128		175
129	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
130		177
131	=over 4	178	=over 4
…		…
146	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
147		194
148	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
149		196
150	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=head2 RENDITION
		200
		201	Rendition bitsets contain information about colour, font, font styles and
		202	similar information for each screen cell.
		203
		204	The following "macros" deal with changes in rendition sets. You should
		205	never just create a bitset, you should always modify an existing one,
		206	as they contain important information required for correct operation of
		207	rxvt-unicode.
		208
		209	=over 4
		210
		211	=item $rend = urxvt::DEFAULT_RSTYLE
		212
		213	Returns the default rendition, as used when the terminal is starting up or
		214	being reset. Useful as a base to start when creating renditions.
		215
		216	=item $rend = urxvt::OVERLAY_RSTYLE
		217
		218	Return the rendition mask used for overlays by default.
		219
		220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		221
		222	Return the bit that enabled bold, italic, blink, reverse-video and
		223	underline, respectively. To enable such a style, just logically OR it into
		224	the bitset.
		225
		226	=item $foreground = urxvt::GET_BASEFG $rend
		227
		228	=item $background = urxvt::GET_BASEBG $rend
		229
		230	Return the foreground/background colour index, respectively.
		231
		232	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		233
		234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		235
		236	Replace the foreground/background colour in the rendition mask with the
		237	specified one.
		238
		239	=item $value = urxvt::GET_CUSTOM ($rend)
		240
		241	Return the "custom" value: Every rendition has 5 bits for use by
		242	extensions. They can be set and changed as you like and are initially
		243	zero.
		244
		245	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		246
		247	Change the custom value.
		248
		249	=back
151		250
152	=cut	251	=cut
153		252
154	package urxvt;	253	package urxvt;
155		254
…		…
382	Convert the given locale-encoded octets into a perl string.	481	Convert the given locale-encoded octets into a perl string.
383		482
384	=item $term->tt_write ($octets)	483	=item $term->tt_write ($octets)
385		484
386	Write the octets given in C<$data> to the tty (i.e. as program input). To	485	Write the octets given in C<$data> to the tty (i.e. as program input). To
387	pass characters instead of octets, you should convetr you strings first to	486	pass characters instead of octets, you should convert your strings first
388	the locale-specific encoding using C<< $term->locale_encode >>.	487	to the locale-specific encoding using C<< $term->locale_encode >>.
		488
		489	=item $nrow = $term->nrow
		490
		491	=item $ncol = $term->ncol
		492
		493	Return the number of rows/columns of the terminal window (i.e. as
		494	specified by C<-geometry>, excluding any scrollback).
		495
		496	=item $nsaved = $term->nsaved
		497
		498	Returns the number of lines in the scrollback buffer.
		499
		500	=item $view_start = $term->view_start ([$newvalue])
		501
		502	Returns the negative row number of the topmost line. Minimum value is
		503	C<0>, which displays the normal terminal contents. Larger values scroll
		504	this many lines into the scrollback buffer.
		505
		506	=item $term->want_refresh
		507
		508	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		509	compare the on-screen display with its stored representation. If they
		510	differ, it redraws the differences.
		511
		512	Used after changing terminal contents to display them.
		513
		514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		515
		516	Returns the text of the entire row with number C<$row_number>. Row C<0>
		517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		518	terminal line. The scrollback buffer starts at line C<-1> and extends to
		519	line C<< -$term->nsaved >>.
		520
		521	If C<$new_text> is specified, it will replace characters in the current
		522	line, starting at column C<$start_col> (default C<0>), which is useful
		523	to replace only parts of a line. The font index in the rendition will
		524	automatically be updated.
		525
		526	C<$text> is in a special encoding: tabs and wide characters that use more
		527	than one cell when displayed are padded with urxvt::NOCHAR characters
		528	(C<chr 65535>). Characters with combining characters and other characters
		529	that do not fit into the normal tetx encoding will be replaced with
		530	characters in the private use area.
		531
		532	You have to obey this encoding when changing text. The advantage is
		533	that C<substr> and similar functions work on screen cells and not on
		534	characters.
		535
		536	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		537	can be used to convert normal strings into this encoding and vice versa.
		538
		539	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		540
		541	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		542	bitsets. Rendition bitsets contain information about colour, font, font
		543	styles and similar information. See also C<< $term->ROW_t >>.
		544
		545	When setting rendition, the font mask will be ignored.
		546
		547	See the section on RENDITION, above.
		548
		549	=item $length = $term->ROW_l ($row_number[, $new_length])
		550
		551	Returns the number of screen cells that are in use ("the line length"). If
		552	it is C<-1>, then the line is part of a multiple-row logical "line", which
		553	means all characters are in use and it is continued on the next row.
		554
		555	=item $text = $term->special_encode $string
		556
		557	Converts a perl string into the special encoding used by rxvt-unicode,
		558	where one character corresponds to one screen cell. See
		559	C<< $term->ROW_t >> for details.
		560
		561	=item $string = $term->special_decode $text
		562
		563	Converts rxvt-unicodes text reprsentation into a perl string. See
		564	C<< $term->ROW_t >> for details.
389		565
390	=back	566	=back
391		567
392	=head2 The C<urxvt::timer> Class	568	=head2 The C<urxvt::timer> Class
393		569

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs. Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC