ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.61 by root, Mon Dec 24 08:00:18 2007 UTC vs.
Revision 1.62 by root, Fri Jan 25 18:42:23 2008 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
23.ft R 23.ft R
24.fi 24.fi
25.. 25..
26.\" Set up some character translations and predefined strings. \*(-- will 26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 31.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 32.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 34.ie n \{\
35. ds -- \(*W- 35. ds -- \(*W-
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
… …
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
48. ds R" '' 48. ds R" ''
49'br\} 49'br\}
50.\" 50.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 55.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 57.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 58.\" output yourself in some meaningful fashion.
55.if \nF \{\ 59.ie \nF \{\
56. de IX 60. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 61. tm Index:\\$1\t\\n%\t"\\$2"
58.. 62..
59. nr % 0 63. nr % 0
60. rr F 64. rr F
61.\} 65.\}
62.\" 66.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 67. de IX
64.\" way too many mistakes in technical documents. 68..
65.hy 0 69.\}
66.if n .na
67.\" 70.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 72.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 73. \" fudge factors for nroff and troff
71.if n \{\ 74.if n \{\
… …
127.\} 130.\}
128.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
129.\" ======================================================================== 132.\" ========================================================================
130.\" 133.\"
131.IX Title "@@RXVT_NAME@@ 3" 134.IX Title "@@RXVT_NAME@@ 3"
132.TH @@RXVT_NAME@@ 3 "2007-12-24" "8.9" "RXVT-UNICODE" 135.TH @@RXVT_NAME@@ 3 "2008-01-25" "8.9" "RXVT-UNICODE"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
133.SH "NAME" 140.SH "NAME"
134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter 141@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
135.SH "SYNOPSIS" 142.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
137.Vb 1 144.Vb 1
138\& # create a file grab_test in $HOME: 145\& # create a file grab_test in $HOME:
139.Ve 146\&
140.PP
141.Vb 4
142\& sub on_sel_grab { 147\& sub on_sel_grab {
143\& warn "you selected ", $_[0]->selection; 148\& warn "you selected ", $_[0]\->selection;
144\& () 149\& ()
145\& } 150\& }
146.Ve 151\&
147.PP
148.Vb 1
149\& # start a @@RXVT_NAME@@ using it: 152\& # start a @@RXVT_NAME@@ using it:
150.Ve 153\&
151.PP
152.Vb 1
153\& @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 154\& @@RXVT_NAME@@ \-\-perl\-lib $HOME \-pe grab_test
154.Ve 155.Ve
155.SH "DESCRIPTION" 156.SH "DESCRIPTION"
156.IX Header "DESCRIPTION" 157.IX Header "DESCRIPTION"
157Every time a terminal object gets created, extension scripts specified via 158Every time a terminal object gets created, extension scripts specified via
158the \f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it. 159the \f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it.
… …
161thus must be encoded as \s-1UTF\-8\s0. 162thus must be encoded as \s-1UTF\-8\s0.
162.PP 163.PP
163Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 164Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
164scripts will be shared (but not enabled) for all terminals. 165scripts will be shared (but not enabled) for all terminals.
165.PP 166.PP
166You can disable the embedded perl interpreter by setting both \*(L"perl\-ext\*(R" 167You can disable the embedded perl interpreter by setting both \*(L"perl-ext\*(R"
167and \*(L"perl\-ext\-common\*(R" resources to the empty string. 168and \*(L"perl-ext-common\*(R" resources to the empty string.
168.SH "PREPACKAGED EXTENSIONS" 169.SH "PREPACKAGED EXTENSIONS"
169.IX Header "PREPACKAGED EXTENSIONS" 170.IX Header "PREPACKAGED EXTENSIONS"
170This section describes the extensions delivered with this release. You can 171This section describes the extensions delivered with this release. You can
171find them in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. 172find them in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR.
172.PP 173.PP
173You can activate them like this: 174You can activate them like this:
174.PP 175.PP
175.Vb 1 176.Vb 1
176\& @@RXVT_NAME@@ -pe <extensionname> 177\& @@RXVT_NAME@@ \-pe <extensionname>
177.Ve 178.Ve
178.PP 179.PP
179Or by adding them to the resource for extensions loaded by default: 180Or by adding them to the resource for extensions loaded by default:
180.PP 181.PP
181.Vb 1 182.Vb 1
182\& URxvt.perl-ext-common: default,selection-autotransform 183\& URxvt.perl\-ext\-common: default,selection\-autotransform
183.Ve 184.Ve
184.IP "selection (enabled by default)" 4 185.IP "selection (enabled by default)" 4
185.IX Item "selection (enabled by default)" 186.IX Item "selection (enabled by default)"
186(More) intelligent selection. This extension tries to be more intelligent 187(More) intelligent selection. This extension tries to be more intelligent
187when the user extends selections (double\-click and further clicks). Right 188when the user extends selections (double-click and further clicks). Right
188now, it tries to select words, urls and complete shell-quoted 189now, it tries to select words, urls and complete shell-quoted
189arguments, which is very convenient, too, if your \fIls\fR supports 190arguments, which is very convenient, too, if your \fIls\fR supports
190\&\f(CW\*(C`\-\-quoting\-style=shell\*(C'\fR. 191\&\f(CW\*(C`\-\-quoting\-style=shell\*(C'\fR.
191.Sp 192.Sp
192A double-click usually selects the word under the cursor, further clicks 193A double-click usually selects the word under the cursor, further clicks
… …
195The selection works by trying to match a number of regexes and displaying 196The selection works by trying to match a number of regexes and displaying
196them in increasing order of length. You can add your own regexes by 197them in increasing order of length. You can add your own regexes by
197specifying resources of the form: 198specifying resources of the form:
198.Sp 199.Sp
199.Vb 3 200.Vb 3
200\& URxvt.selection.pattern-0: perl-regex 201\& URxvt.selection.pattern\-0: perl\-regex
201\& URxvt.selection.pattern-1: perl-regex 202\& URxvt.selection.pattern\-1: perl\-regex
202\& ... 203\& ...
203.Ve 204.Ve
204.Sp 205.Sp
205The index number (0, 1...) must not have any holes, and each regex must 206The index number (0, 1...) must not have any holes, and each regex must
206contain at least one pair of capturing parentheses, which will be used for 207contain at least one pair of capturing parentheses, which will be used for
207the match. For example, the following adds a regex that matches everything 208the match. For example, the following adds a regex that matches everything
208between two vertical bars: 209between two vertical bars:
209.Sp 210.Sp
210.Vb 1 211.Vb 1
211\& URxvt.selection.pattern-0: \e\e|([^|]+)\e\e| 212\& URxvt.selection.pattern\-0: \e\e|([^|]+)\e\e|
212.Ve 213.Ve
213.Sp 214.Sp
214Another example: Programs I use often output \*(L"absolute path: \*(R" at the 215Another example: Programs I use often output \*(L"absolute path: \*(R" at the
215beginning of a line when they process multiple files. The following 216beginning of a line when they process multiple files. The following
216pattern matches the filename (note, there is a single space at the very 217pattern matches the filename (note, there is a single space at the very
217end): 218end):
218.Sp 219.Sp
219.Vb 1 220.Vb 1
220\& URxvt.selection.pattern-0: ^(/[^:]+):\e 221\& URxvt.selection.pattern\-0: ^(/[^:]+):\e
221.Ve 222.Ve
222.Sp 223.Sp
223You can look at the source of the selection extension to see more 224You can look at the source of the selection extension to see more
224interesting uses, such as parsing a line from beginning to end. 225interesting uses, such as parsing a line from beginning to end.
225.Sp 226.Sp
… …
228.IP "rot13" 4 229.IP "rot13" 4
229.IX Item "rot13" 230.IX Item "rot13"
230Rot\-13 the selection when activated. Used via keyboard trigger: 231Rot\-13 the selection when activated. Used via keyboard trigger:
231.Sp 232.Sp
232.Vb 1 233.Vb 1
233\& URxvt.keysym.C-M-r: perl:selection:rot13 234\& URxvt.keysym.C\-M\-r: perl:selection:rot13
234.Ve 235.Ve
235.RE 236.RE
236.RS 4 237.RS 4
237.RE 238.RE
238.IP "option-popup (enabled by default)" 4 239.IP "option-popup (enabled by default)" 4
… …
252.Sp 253.Sp
253The following will add an entry \f(CW\*(C`myoption\*(C'\fR that changes 254The following will add an entry \f(CW\*(C`myoption\*(C'\fR that changes
254\&\f(CW\*(C`$self\-\*(C'\fR{myoption}>: 255\&\f(CW\*(C`$self\-\*(C'\fR{myoption}>:
255.Sp 256.Sp
256.Vb 3 257.Vb 3
257\& push @{ $self->{term}{option_popup_hook} }, sub { 258\& push @{ $self\->{term}{option_popup_hook} }, sub {
258\& ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 259\& ("my option" => $myoption, sub { $self\->{myoption} = $_[0] })
259\& }; 260\& };
260.Ve 261.Ve
261.IP "selection-popup (enabled by default)" 4 262.IP "selection-popup (enabled by default)" 4
262.IX Item "selection-popup (enabled by default)" 263.IX Item "selection-popup (enabled by default)"
263Binds a popup menu to Ctrl\-Button3 that lets you convert the selection 264Binds a popup menu to Ctrl\-Button3 that lets you convert the selection
… …
277The following will add an entry \f(CW\*(C`a to b\*(C'\fR that transforms all \f(CW\*(C`a\*(C'\fRs in 278The following will add an entry \f(CW\*(C`a to b\*(C'\fR that transforms all \f(CW\*(C`a\*(C'\fRs in
278the selection to \f(CW\*(C`b\*(C'\fRs, but only if the selection currently contains any 279the selection to \f(CW\*(C`b\*(C'\fRs, but only if the selection currently contains any
279\&\f(CW\*(C`a\*(C'\fRs: 280\&\f(CW\*(C`a\*(C'\fRs:
280.Sp 281.Sp
281.Vb 4 282.Vb 4
282\& push @{ $self->{term}{selection_popup_hook} }, sub { 283\& push @{ $self\->{term}{selection_popup_hook} }, sub {
283\& /a/ ? ("a to b" => sub { s/a/b/g } 284\& /a/ ? ("a to b" => sub { s/a/b/g }
284\& : () 285\& : ()
285\& }; 286\& };
286.Ve 287.Ve
287.IP "searchable\-scrollback<hotkey> (enabled by default)" 4 288.IP "searchable\-scrollback<hotkey> (enabled by default)" 4
… …
337.Sp 338.Sp
338It works by specifying perl snippets (most useful is a single \f(CW\*(C`s///\*(C'\fR 339It works by specifying perl snippets (most useful is a single \f(CW\*(C`s///\*(C'\fR
339operator) that modify \f(CW$_\fR as resources: 340operator) that modify \f(CW$_\fR as resources:
340.Sp 341.Sp
341.Vb 3 342.Vb 3
342\& URxvt.selection-autotransform.0: transform 343\& URxvt.selection\-autotransform.0: transform
343\& URxvt.selection-autotransform.1: transform 344\& URxvt.selection\-autotransform.1: transform
344\& ... 345\& ...
345.Ve 346.Ve
346.Sp 347.Sp
347For example, the following will transform selections of the form 348For example, the following will transform selections of the form
348\&\f(CW\*(C`filename:number\*(C'\fR, often seen in compiler messages, into \f(CW\*(C`vi +$filename 349\&\f(CW\*(C`filename:number\*(C'\fR, often seen in compiler messages, into \f(CW\*(C`vi +$filename
349$word\*(C'\fR: 350$word\*(C'\fR:
350.Sp 351.Sp
351.Vb 1 352.Vb 1
352\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/ 353\& URxvt.selection\-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/
353.Ve 354.Ve
354.Sp 355.Sp
355And this example matches the same,but replaces it with vi-commands you can 356And this example matches the same,but replaces it with vi-commands you can
356paste directly into your (vi :) editor: 357paste directly into your (vi :) editor:
357.Sp 358.Sp
358.Vb 1 359.Vb 1
359\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ 360\& URxvt.selection\-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/
360.Ve 361.Ve
361.Sp 362.Sp
362Of course, this can be modified to suit your needs and your editor :) 363Of course, this can be modified to suit your needs and your editor :)
363.Sp 364.Sp
364To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at 365To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at
365\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution: 366\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution:
366.Sp 367.Sp
367.Vb 2 368.Vb 2
368\& URxvt.selection.pattern-0: ( at .*? line \e\ed+[,.]) 369\& URxvt.selection.pattern\-0: ( at .*? line \e\ed+[,.])
369\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/ 370\& URxvt.selection\-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/
370.Ve 371.Ve
371.Sp 372.Sp
372The first line tells the selection code to treat the unchanging part of 373The first line tells the selection code to treat the unchanging part of
373every error message as a selection pattern, and the second line transforms 374every error message as a selection pattern, and the second line transforms
374the message into vi commands to load the file. 375the message into vi commands to load the file.
… …
386The tabbar itself can be configured similarly to a normal terminal, but 387The tabbar itself can be configured similarly to a normal terminal, but
387with a resource class of \f(CW\*(C`URxvt.tabbed\*(C'\fR. In addition, it supports the 388with a resource class of \f(CW\*(C`URxvt.tabbed\*(C'\fR. In addition, it supports the
388following four resources (shown with defaults): 389following four resources (shown with defaults):
389.Sp 390.Sp
390.Vb 4 391.Vb 4
391\& URxvt.tabbed.tabbar-fg: <colour-index, default 3> 392\& URxvt.tabbed.tabbar\-fg: <colour\-index, default 3>
392\& URxvt.tabbed.tabbar-bg: <colour-index, default 0> 393\& URxvt.tabbed.tabbar\-bg: <colour\-index, default 0>
393\& URxvt.tabbed.tab-fg: <colour-index, default 0> 394\& URxvt.tabbed.tab\-fg: <colour\-index, default 0>
394\& URxvt.tabbed.tab-bg: <colour-index, default 1> 395\& URxvt.tabbed.tab\-bg: <colour\-index, default 1>
395.Ve 396.Ve
396.Sp 397.Sp
397See \fI\s-1COLOR\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR in the @@RXVT_NAME@@(1) manpage for valid 398See \fI\s-1COLOR\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR in the @@RXVT_NAME@@(1) manpage for valid
398indices. 399indices.
399.IP "matcher" 4 400.IP "matcher" 4
… …
403mouse button specified in the \f(CW\*(C`matcher.button\*(C'\fR resource (default 2, or 404mouse button specified in the \f(CW\*(C`matcher.button\*(C'\fR resource (default 2, or
404middle), the program specified in the \f(CW\*(C`matcher.launcher\*(C'\fR resource 405middle), the program specified in the \f(CW\*(C`matcher.launcher\*(C'\fR resource
405(default, the \f(CW\*(C`urlLauncher\*(C'\fR resource, \f(CW\*(C`sensible\-browser\*(C'\fR) will be started 406(default, the \f(CW\*(C`urlLauncher\*(C'\fR resource, \f(CW\*(C`sensible\-browser\*(C'\fR) will be started
406with the matched text as first argument. The default configuration is 407with the matched text as first argument. The default configuration is
407suitable for matching URLs and launching a web browser, like the 408suitable for matching URLs and launching a web browser, like the
408former \*(L"mark\-urls\*(R" extension. 409former \*(L"mark-urls\*(R" extension.
409.Sp 410.Sp
410The default pattern to match URLs can be overridden with the 411The default pattern to match URLs can be overridden with the
411\&\f(CW\*(C`matcher.pattern.0\*(C'\fR resource, and additional patterns can be specified 412\&\f(CW\*(C`matcher.pattern.0\*(C'\fR resource, and additional patterns can be specified
412with numbered patterns, in a manner similar to the \*(L"selection\*(R" extension. 413with numbered patterns, in a manner similar to the \*(L"selection\*(R" extension.
413The launcher can also be overridden on a per-pattern basis. 414The launcher can also be overridden on a per-pattern basis.
… …
416Simply bind a keysym to \*(L"perl:matcher\*(R" as seen in the example below. 417Simply bind a keysym to \*(L"perl:matcher\*(R" as seen in the example below.
417.Sp 418.Sp
418Example configuration: 419Example configuration:
419.Sp 420.Sp
420.Vb 7 421.Vb 7
421\& URxvt.perl-ext: default,matcher 422\& URxvt.perl\-ext: default,matcher
422\& URxvt.urlLauncher: sensible-browser 423\& URxvt.urlLauncher: sensible\-browser
423\& URxvt.keysym.C-Delete: perl:matcher 424\& URxvt.keysym.C\-Delete: perl:matcher
424\& URxvt.matcher.button: 1 425\& URxvt.matcher.button: 1
425\& URxvt.matcher.pattern.1: \e\ebwww\e\e.[\e\ew-]+\e\e.[\e\ew./?&@#-]*[\e\ew/-] 426\& URxvt.matcher.pattern.1: \e\ebwww\e\e.[\e\ew\-]+\e\e.[\e\ew./?&@#\-]*[\e\ew/\-]
426\& URxvt.matcher.pattern.2: \e\eB(/\e\eS+?):(\e\ed+)(?=:|$) 427\& URxvt.matcher.pattern.2: \e\eB(/\e\eS+?):(\e\ed+)(?=:|$)
427\& URxvt.matcher.launcher.2: gvim +$2 $1 428\& URxvt.matcher.launcher.2: gvim +$2 $1
428.Ve 429.Ve
429.IP "xim-onthespot" 4 430.IP "xim-onthespot" 4
430.IX Item "xim-onthespot" 431.IX Item "xim-onthespot"
… …
435.Sp 436.Sp
436You enable it by specifying this extension and a preedit style of 437You enable it by specifying this extension and a preedit style of
437\&\f(CW\*(C`OnTheSpot\*(C'\fR, i.e.: 438\&\f(CW\*(C`OnTheSpot\*(C'\fR, i.e.:
438.Sp 439.Sp
439.Vb 1 440.Vb 1
440\& @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 441\& @@RXVT_NAME@@ \-pt OnTheSpot \-pe xim\-onthespot
441.Ve 442.Ve
442.IP "kuake<hotkey>" 4 443.IP "kuake<hotkey>" 4
443.IX Item "kuake<hotkey>" 444.IX Item "kuake<hotkey>"
444A very primitive quake-console-like extension. It was inspired by a 445A very primitive quake-console-like extension. It was inspired by a
445description of how the programs \f(CW\*(C`kuake\*(C'\fR and \f(CW\*(C`yakuake\*(C'\fR work: Whenever the 446description of how the programs \f(CW\*(C`kuake\*(C'\fR and \f(CW\*(C`yakuake\*(C'\fR work: Whenever the
… …
481the selection data on \s-1STDOUT\s0 (also in \s-1UTF\-8\s0). 482the selection data on \s-1STDOUT\s0 (also in \s-1UTF\-8\s0).
482.Sp 483.Sp
483The defaults (which are likely useless to you) use rsh and cat: 484The defaults (which are likely useless to you) use rsh and cat:
484.Sp 485.Sp
485.Vb 2 486.Vb 2
486\& URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 487\& URxvt.remote\-selection.store: rsh ruth \*(Aqcat >/tmp/distributed\-selection\*(Aq
487\& URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 488\& URxvt.remote\-selection.fetch: rsh ruth \*(Aqcat /tmp/distributed\-selection\*(Aq
488.Ve 489.Ve
489.IP "selection-pastebin" 4 490.IP "selection-pastebin" 4
490.IX Item "selection-pastebin" 491.IX Item "selection-pastebin"
491This is a little rarely useful extension that Uploads the selection as 492This is a little rarely useful extension that Uploads the selection as
492textfile to a remote site (or does other things). (The implementation is 493textfile to a remote site (or does other things). (The implementation is
… …
495.Sp 496.Sp
496It listens to the \f(CW\*(C`selection\-pastebin:remote\-pastebin\*(C'\fR keyboard command, 497It listens to the \f(CW\*(C`selection\-pastebin:remote\-pastebin\*(C'\fR keyboard command,
497i.e. 498i.e.
498.Sp 499.Sp
499.Vb 1 500.Vb 1
500\& URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 501\& URxvt.keysym.C\-M\-e: perl:selection\-pastebin:remote\-pastebin
501.Ve 502.Ve
502.Sp 503.Sp
503Pressing this combination runs a command with \f(CW\*(C`%\*(C'\fR replaced by the name of 504Pressing this combination runs a command with \f(CW\*(C`%\*(C'\fR replaced by the name of
504the textfile. This command can be set via a resource: 505the textfile. This command can be set via a resource:
505.Sp 506.Sp
506.Vb 1 507.Vb 1
507\& URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. 508\& URxvt.selection\-pastebin.cmd: rsync \-apP % ruth:/var/www/www.ta\-sa.org/files/txt/.
508.Ve 509.Ve
509.Sp 510.Sp
510And the default is likely not useful to anybody but the few people around 511And the default is likely not useful to anybody but the few people around
511here :) 512here :)
512.Sp 513.Sp
… …
516After a successful upload the selection will be replaced by the text given 517After a successful upload the selection will be replaced by the text given
517in the \f(CW\*(C`selection\-pastebin\-url\*(C'\fR resource (again, the % is the placeholder 518in the \f(CW\*(C`selection\-pastebin\-url\*(C'\fR resource (again, the % is the placeholder
518for the filename): 519for the filename):
519.Sp 520.Sp
520.Vb 1 521.Vb 1
521\& URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 522\& URxvt.selection\-pastebin.url: http://www.ta\-sa.org/files/txt/%
522.Ve 523.Ve
523.Sp 524.Sp
524\&\fINote to xrdb users:\fR xrdb uses the C preprocessor, which might interpret 525\&\fINote to xrdb users:\fR xrdb uses the C preprocessor, which might interpret
525the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead, 526the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead,
526which works regardless of wether xrdb is used to parse the resource file 527which works regardless of wether xrdb is used to parse the resource file
… …
545the like inside the terminal object so they get destroyed as soon as the 546the like inside the terminal object so they get destroyed as soon as the
546terminal is destroyed. 547terminal is destroyed.
547.PP 548.PP
548Argument names also often indicate the type of a parameter. Here are some 549Argument names also often indicate the type of a parameter. Here are some
549hints on what they mean: 550hints on what they mean:
550.IP "$text" 4 551.ie n .IP "$text" 4
552.el .IP "\f(CW$text\fR" 4
551.IX Item "$text" 553.IX Item "$text"
552Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character 554Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character
553always represents one screen cell. See ROW_t for a discussion of this format. 555always represents one screen cell. See ROW_t for a discussion of this format.
554.IP "$string" 4 556.ie n .IP "$string" 4
557.el .IP "\f(CW$string\fR" 4
555.IX Item "$string" 558.IX Item "$string"
556A perl text string, with an emphasis on \fItext\fR. It can store all unicode 559A perl text string, with an emphasis on \fItext\fR. It can store all unicode
557characters and is to be distinguished with text encoded in a specific 560characters and is to be distinguished with text encoded in a specific
558encoding (often locale\-specific) and binary data. 561encoding (often locale-specific) and binary data.
559.IP "$octets" 4 562.ie n .IP "$octets" 4
563.el .IP "\f(CW$octets\fR" 4
560.IX Item "$octets" 564.IX Item "$octets"
561Either binary data or \- more common \- a text string encoded in a 565Either binary data or \- more common \- a text string encoded in a
562locale-specific way. 566locale-specific way.
563.Sh "Extension Objects" 567.Sh "Extension Objects"
564.IX Subsection "Extension Objects" 568.IX Subsection "Extension Objects"
… …
572.PP 576.PP
573Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the 577Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the
574\&\f(CW\*(C`urxvt::term\*(C'\fR class on this object. 578\&\f(CW\*(C`urxvt::term\*(C'\fR class on this object.
575.PP 579.PP
576It has the following methods and data members: 580It has the following methods and data members:
577.ie n .IP "$urxvt_term = $self\->{term}" 4 581.ie n .IP "$urxvt_term\fR = \f(CW$self\->{term}" 4
578.el .IP "$urxvt_term = \f(CW$self\fR\->{term}" 4 582.el .IP "\f(CW$urxvt_term\fR = \f(CW$self\fR\->{term}" 4
579.IX Item "$urxvt_term = $self->{term}" 583.IX Item "$urxvt_term = $self->{term}"
580Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the 584Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the
581extension. This member \fImust not\fR be changed in any way. 585extension. This member \fImust not\fR be changed in any way.
582.ie n .IP "$self\->enable ($hook_name => $cb\fR, [$hook_name => \f(CW$cb..])" 4 586.ie n .IP "$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb..])" 4
583.el .IP "$self\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4 587.el .IP "\f(CW$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4
584.IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])" 588.IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])"
585Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for 589Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for
586this extension, replacing any previous hook. This is useful when you want 590this extension, replacing any previous hook. This is useful when you want
587to overwrite time-critical hooks only temporarily. 591to overwrite time-critical hooks only temporarily.
588.ie n .IP "$self\->disable ($hook_name[, $hook_name..])" 4 592.ie n .IP "$self\fR\->disable ($hook_name[, \f(CW$hook_name..])" 4
589.el .IP "$self\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4 593.el .IP "\f(CW$self\fR\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4
590.IX Item "$self->disable ($hook_name[, $hook_name..])" 594.IX Item "$self->disable ($hook_name[, $hook_name..])"
591Dynamically disable the given hooks. 595Dynamically disable the given hooks.
592.Sh "Hooks" 596.Sh "Hooks"
593.IX Subsection "Hooks" 597.IX Subsection "Hooks"
594The following subroutines can be declared in extension files, and will be 598The following subroutines can be declared in extension files, and will be
… …
804.ie n .IP "on_unmap_notify $term\fR, \f(CW$event" 4 808.ie n .IP "on_unmap_notify $term\fR, \f(CW$event" 4
805.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4 809.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4
806.IX Item "on_unmap_notify $term, $event" 810.IX Item "on_unmap_notify $term, $event"
807.PD 811.PD
808Called whenever the corresponding X event is received for the terminal If 812Called whenever the corresponding X event is received for the terminal If
809the hook returns true, then the even will be ignored by rxvt\-unicode. 813the hook returns true, then the even will be ignored by rxvt-unicode.
810.Sp 814.Sp
811The event is a hash with most values as named by Xlib (see the XEvent 815The event is a hash with most values as named by Xlib (see the XEvent
812manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the 816manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the
813(real, not screen\-based) row and column under the mouse cursor. 817(real, not screen-based) row and column under the mouse cursor.
814.Sp 818.Sp
815\&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would 819\&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would
816output, if any, in locale-specific encoding. 820output, if any, in locale-specific encoding.
817.Sp 821.Sp
818subwindow. 822subwindow.
… …
830Called when various types of ClientMessage events are received (all with 834Called when various types of ClientMessage events are received (all with
831format=32, \s-1WM_PROTOCOLS\s0 or \s-1WM_PROTOCOLS:WM_DELETE_WINDOW\s0). 835format=32, \s-1WM_PROTOCOLS\s0 or \s-1WM_PROTOCOLS:WM_DELETE_WINDOW\s0).
832.ie n .Sh "Variables in the ""urxvt"" Package" 836.ie n .Sh "Variables in the ""urxvt"" Package"
833.el .Sh "Variables in the \f(CWurxvt\fP Package" 837.el .Sh "Variables in the \f(CWurxvt\fP Package"
834.IX Subsection "Variables in the urxvt Package" 838.IX Subsection "Variables in the urxvt Package"
835.IP "$urxvt::LIBDIR" 4 839.ie n .IP "$urxvt::LIBDIR" 4
840.el .IP "\f(CW$urxvt::LIBDIR\fR" 4
836.IX Item "$urxvt::LIBDIR" 841.IX Item "$urxvt::LIBDIR"
837The rxvt-unicode library directory, where, among other things, the perl 842The rxvt-unicode library directory, where, among other things, the perl
838modules and scripts are stored. 843modules and scripts are stored.
839.ie n .IP "$urxvt::RESCLASS, $urxvt::RESCLASS" 4 844.ie n .IP "$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS" 4
840.el .IP "$urxvt::RESCLASS, \f(CW$urxvt::RESCLASS\fR" 4 845.el .IP "\f(CW$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS\fR" 4
841.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS" 846.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS"
842The resource class and name rxvt-unicode uses to look up X resources. 847The resource class and name rxvt-unicode uses to look up X resources.
843.IP "$urxvt::RXVTNAME" 4 848.ie n .IP "$urxvt::RXVTNAME" 4
849.el .IP "\f(CW$urxvt::RXVTNAME\fR" 4
844.IX Item "$urxvt::RXVTNAME" 850.IX Item "$urxvt::RXVTNAME"
845The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR. 851The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR.
846.IP "$urxvt::TERM" 4 852.ie n .IP "$urxvt::TERM" 4
853.el .IP "\f(CW$urxvt::TERM\fR" 4
847.IX Item "$urxvt::TERM" 854.IX Item "$urxvt::TERM"
848The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR 855The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR
849object, whenever a callback/hook is executing. 856object, whenever a callback/hook is executing.
850.IP "@urxvt::TERM_INIT" 4 857.ie n .IP "@urxvt::TERM_INIT" 4
858.el .IP "\f(CW@urxvt::TERM_INIT\fR" 4
851.IX Item "@urxvt::TERM_INIT" 859.IX Item "@urxvt::TERM_INIT"
852All code references in this array will be called as methods of the next newly 860All code references in this array will be called as methods of the next newly
853created \f(CW\*(C`urxvt::term\*(C'\fR object (during the \f(CW\*(C`on_init\*(C'\fR phase). The array 861created \f(CW\*(C`urxvt::term\*(C'\fR object (during the \f(CW\*(C`on_init\*(C'\fR phase). The array
854gets cleared before the code references that were in it are being executed, 862gets cleared before the code references that were in it are being executed,
855so references can push themselves onto it again if they so desire. 863so references can push themselves onto it again if they so desire.
856.Sp 864.Sp
857This complements to the perl-eval command line option, but gets executed 865This complements to the perl-eval command line option, but gets executed
858first. 866first.
859.IP "@urxvt::TERM_EXT" 4 867.ie n .IP "@urxvt::TERM_EXT" 4
868.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4
860.IX Item "@urxvt::TERM_EXT" 869.IX Item "@urxvt::TERM_EXT"
861Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which 870Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which
862get registered as normal extensions after calling the hooks in \f(CW@TERM_INIT\fR 871get registered as normal extensions after calling the hooks in \f(CW@TERM_INIT\fR
863but before other extensions. Gets cleared just like \f(CW@TERM_INIT\fR. 872but before other extensions. Gets cleared just like \f(CW@TERM_INIT\fR.
864.ie n .Sh "Functions in the ""urxvt"" Package" 873.ie n .Sh "Functions in the ""urxvt"" Package"
… …
879.Sp 888.Sp
880Using this function has the advantage that its output ends up in the 889Using this function has the advantage that its output ends up in the
881correct place, e.g. on stderr of the connecting urxvtc client. 890correct place, e.g. on stderr of the connecting urxvtc client.
882.Sp 891.Sp
883Messages have a size limit of 1023 bytes currently. 892Messages have a size limit of 1023 bytes currently.
884.IP "@terms = urxvt::termlist" 4 893.ie n .IP "@terms = urxvt::termlist" 4
894.el .IP "\f(CW@terms\fR = urxvt::termlist" 4
885.IX Item "@terms = urxvt::termlist" 895.IX Item "@terms = urxvt::termlist"
886Returns all urxvt::term objects that exist in this process, regardless of 896Returns all urxvt::term objects that exist in this process, regardless of
887whether they are started, being destroyed etc., so be careful. Only term 897whether they are started, being destroyed etc., so be careful. Only term
888objects that have perl extensions attached will be returned (because there 898objects that have perl extensions attached will be returned (because there
889is no urxvt::term objet associated with others). 899is no urxvt::term objet associated with others).
890.IP "$time = urxvt::NOW" 4 900.ie n .IP "$time = urxvt::NOW" 4
901.el .IP "\f(CW$time\fR = urxvt::NOW" 4
891.IX Item "$time = urxvt::NOW" 902.IX Item "$time = urxvt::NOW"
892Returns the \*(L"current time\*(R" (as per the event loop). 903Returns the \*(L"current time\*(R" (as per the event loop).
893.IP "urxvt::CurrentTime" 4 904.IP "urxvt::CurrentTime" 4
894.IX Item "urxvt::CurrentTime" 905.IX Item "urxvt::CurrentTime"
895.PD 0 906.PD 0
… …
907similar information for each screen cell. 918similar information for each screen cell.
908.PP 919.PP
909The following \*(L"macros\*(R" deal with changes in rendition sets. You should 920The following \*(L"macros\*(R" deal with changes in rendition sets. You should
910never just create a bitset, you should always modify an existing one, 921never just create a bitset, you should always modify an existing one,
911as they contain important information required for correct operation of 922as they contain important information required for correct operation of
912rxvt\-unicode. 923rxvt-unicode.
913.IP "$rend = urxvt::DEFAULT_RSTYLE" 4 924.ie n .IP "$rend = urxvt::DEFAULT_RSTYLE" 4
925.el .IP "\f(CW$rend\fR = urxvt::DEFAULT_RSTYLE" 4
914.IX Item "$rend = urxvt::DEFAULT_RSTYLE" 926.IX Item "$rend = urxvt::DEFAULT_RSTYLE"
915Returns the default rendition, as used when the terminal is starting up or 927Returns the default rendition, as used when the terminal is starting up or
916being reset. Useful as a base to start when creating renditions. 928being reset. Useful as a base to start when creating renditions.
917.IP "$rend = urxvt::OVERLAY_RSTYLE" 4 929.ie n .IP "$rend = urxvt::OVERLAY_RSTYLE" 4
930.el .IP "\f(CW$rend\fR = urxvt::OVERLAY_RSTYLE" 4
918.IX Item "$rend = urxvt::OVERLAY_RSTYLE" 931.IX Item "$rend = urxvt::OVERLAY_RSTYLE"
919Return the rendition mask used for overlays by default. 932Return the rendition mask used for overlays by default.
920.IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 933.ie n .IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4
934.el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4
921.IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 935.IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline"
922Return the bit that enabled bold, italic, blink, reverse-video and 936Return the bit that enabled bold, italic, blink, reverse-video and
923underline, respectively. To enable such a style, just logically \s-1OR\s0 it into 937underline, respectively. To enable such a style, just logically \s-1OR\s0 it into
924the bitset. 938the bitset.
925.ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4 939.ie n .IP "$foreground\fR = urxvt::GET_BASEFG \f(CW$rend" 4
926.el .IP "$foreground = urxvt::GET_BASEFG \f(CW$rend\fR" 4 940.el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4
927.IX Item "$foreground = urxvt::GET_BASEFG $rend" 941.IX Item "$foreground = urxvt::GET_BASEFG $rend"
928.PD 0 942.PD 0
929.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4 943.ie n .IP "$background\fR = urxvt::GET_BASEBG \f(CW$rend" 4
930.el .IP "$background = urxvt::GET_BASEBG \f(CW$rend\fR" 4 944.el .IP "\f(CW$background\fR = urxvt::GET_BASEBG \f(CW$rend\fR" 4
931.IX Item "$background = urxvt::GET_BASEBG $rend" 945.IX Item "$background = urxvt::GET_BASEBG $rend"
932.PD 946.PD
933Return the foreground/background colour index, respectively. 947Return the foreground/background colour index, respectively.
934.ie n .IP "$rend = urxvt::SET_FGCOLOR $rend\fR, \f(CW$new_colour" 4 948.ie n .IP "$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4
935.el .IP "$rend = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 949.el .IP "\f(CW$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
936.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour" 950.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour"
937.PD 0 951.PD 0
938.ie n .IP "$rend = urxvt::SET_BGCOLOR $rend\fR, \f(CW$new_colour" 4 952.ie n .IP "$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4
939.el .IP "$rend = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 953.el .IP "\f(CW$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
940.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour" 954.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour"
941.ie n .IP "$rend = urxvt::SET_COLOR $rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg" 4 955.ie n .IP "$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg" 4
942.el .IP "$rend = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4 956.el .IP "\f(CW$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4
943.IX Item "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg" 957.IX Item "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg"
944.PD 958.PD
945Replace the foreground/background colour in the rendition mask with the 959Replace the foreground/background colour in the rendition mask with the
946specified one. 960specified one.
947.ie n .IP "$value = urxvt::GET_CUSTOM $rend" 4 961.ie n .IP "$value\fR = urxvt::GET_CUSTOM \f(CW$rend" 4
948.el .IP "$value = urxvt::GET_CUSTOM \f(CW$rend\fR" 4 962.el .IP "\f(CW$value\fR = urxvt::GET_CUSTOM \f(CW$rend\fR" 4
949.IX Item "$value = urxvt::GET_CUSTOM $rend" 963.IX Item "$value = urxvt::GET_CUSTOM $rend"
950Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by 964Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by
951extensions. They can be set and changed as you like and are initially 965extensions. They can be set and changed as you like and are initially
952zero. 966zero.
953.ie n .IP "$rend = urxvt::SET_CUSTOM $rend\fR, \f(CW$new_value" 4 967.ie n .IP "$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value" 4
954.el .IP "$rend = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4 968.el .IP "\f(CW$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4
955.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value" 969.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value"
956Change the custom value. 970Change the custom value.
957.ie n .Sh "The ""urxvt::anyevent"" Class" 971.ie n .Sh "The ""urxvt::anyevent"" Class"
958.el .Sh "The \f(CWurxvt::anyevent\fP Class" 972.el .Sh "The \f(CWurxvt::anyevent\fP Class"
959.IX Subsection "The urxvt::anyevent Class" 973.IX Subsection "The urxvt::anyevent Class"
… …
964is that you cannot use blocking APIs, but the non-blocking variant should 978is that you cannot use blocking APIs, but the non-blocking variant should
965work. 979work.
966.ie n .Sh "The ""urxvt::term"" Class" 980.ie n .Sh "The ""urxvt::term"" Class"
967.el .Sh "The \f(CWurxvt::term\fP Class" 981.el .Sh "The \f(CWurxvt::term\fP Class"
968.IX Subsection "The urxvt::term Class" 982.IX Subsection "The urxvt::term Class"
969.ie n .IP "$term = new urxvt::term $envhashref\fR, \f(CW$rxvtname, [arg...]" 4 983.ie n .IP "$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname, [arg...]" 4
970.el .IP "$term = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 984.el .IP "\f(CW$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4
971.IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" 985.IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]"
972Creates a new terminal, very similar as if you had started it with system 986Creates a new terminal, very similar as if you had started it with system
973\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like 987\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like
974hash which defines the environment of the new terminal. 988hash which defines the environment of the new terminal.
975.Sp 989.Sp
976Croaks (and probably outputs an error message) if the new instance 990Croaks (and probably outputs an error message) if the new instance
977couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't 991couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't
978initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and 992initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and
979\&\f(CW\*(C`start\*(C'\fR hooks will be called before this call returns, and are free to 993\&\f(CW\*(C`start\*(C'\fR hooks will be called before this call returns, and are free to
980refer to global data (which is race free). 994refer to global data (which is race free).
981.IP "$term\->destroy" 4 995.ie n .IP "$term\->destroy" 4
996.el .IP "\f(CW$term\fR\->destroy" 4
982.IX Item "$term->destroy" 997.IX Item "$term->destroy"
983Destroy the terminal object (close the window, free resources 998Destroy the terminal object (close the window, free resources
984etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 999etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
985watchers (timers, io watchers) are still active. 1000watchers (timers, io watchers) are still active.
986.ie n .IP "$term\->exec_async ($cmd[, @args])" 4 1001.ie n .IP "$term\fR\->exec_async ($cmd[, \f(CW@args])" 4
987.el .IP "$term\->exec_async ($cmd[, \f(CW@args\fR])" 4 1002.el .IP "\f(CW$term\fR\->exec_async ($cmd[, \f(CW@args\fR])" 4
988.IX Item "$term->exec_async ($cmd[, @args])" 1003.IX Item "$term->exec_async ($cmd[, @args])"
989Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes 1004Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes
990(\*(L"starts\*(R") programs in the background. This function takes care of setting 1005(\*(L"starts\*(R") programs in the background. This function takes care of setting
991the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) and should 1006the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) and should
992be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR. 1007be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR.
993.Sp 1008.Sp
994Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error. 1009Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error.
995.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4 1010.ie n .IP "$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set])" 4
996.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 1011.el .IP "\f(CW$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4
997.IX Item "$isset = $term->option ($optval[, $set])" 1012.IX Item "$isset = $term->option ($optval[, $set])"
998Returns true if the option specified by \f(CW$optval\fR is enabled, and 1013Returns true if the option specified by \f(CW$optval\fR is enabled, and
999optionally change it. All option values are stored by name in the hash 1014optionally change it. All option values are stored by name in the hash
1000\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash. 1015\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash.
1001.Sp 1016.Sp
… …
1003source file \fI/src/optinc.h\fR to see the actual list: 1018source file \fI/src/optinc.h\fR to see the actual list:
1004.Sp 1019.Sp
1005.Vb 6 1020.Vb 6
1006\& borderLess console cursorBlink cursorUnderline hold iconic insecure 1021\& borderLess console cursorBlink cursorUnderline hold iconic insecure
1007\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1022\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1008\& override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1023\& override\-redirect pastableTabs pointerBlank reverseVideo scrollBar
1009\& scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1024\& scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1010\& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1025\& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1011\& transparent tripleclickwords utmpInhibit visualBell 1026\& transparent tripleclickwords utmpInhibit visualBell
1012.Ve 1027.Ve
1013.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4 1028.ie n .IP "$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval])" 4
1014.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 1029.el .IP "\f(CW$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4
1015.IX Item "$value = $term->resource ($name[, $newval])" 1030.IX Item "$value = $term->resource ($name[, $newval])"
1016Returns the current resource value associated with a given name and 1031Returns the current resource value associated with a given name and
1017optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR 1032optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR
1018hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR. 1033hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR.
1019.Sp 1034.Sp
… …
1030.Sp 1045.Sp
1031Here is a likely non-exhaustive list of resource names, not all of which 1046Here is a likely non-exhaustive list of resource names, not all of which
1032are supported in every build, please see the source file \fI/src/rsinc.h\fR 1047are supported in every build, please see the source file \fI/src/rsinc.h\fR
1033to see the actual list: 1048to see the actual list:
1034.Sp 1049.Sp
1035.Vb 13 1050.Vb 10
1036\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1051\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1037\& borderLess color cursorBlink cursorUnderline cutchars delete_key 1052\& borderLess color cursorBlink cursorUnderline cutchars delete_key
1038\& display_name embed ext_bwidth fade font geometry hold iconName 1053\& display_name embed ext_bwidth fade font geometry hold iconName
1039\& imFont imLocale inputMethod insecure int_bwidth intensityStyles 1054\& imFont imLocale inputMethod insecure int_bwidth intensityStyles
1040\& italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1055\& italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
… …
1045\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1060\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1046\& secondaryScreen secondaryScroll shade term_name title 1061\& secondaryScreen secondaryScroll shade term_name title
1047\& transient_for transparent transparent_all tripleclickwords utmpInhibit 1062\& transient_for transparent transparent_all tripleclickwords utmpInhibit
1048\& visualBell 1063\& visualBell
1049.Ve 1064.Ve
1050.ie n .IP "$value = $term\->x_resource ($pattern)" 4 1065.ie n .IP "$value\fR = \f(CW$term\->x_resource ($pattern)" 4
1051.el .IP "$value = \f(CW$term\fR\->x_resource ($pattern)" 4 1066.el .IP "\f(CW$value\fR = \f(CW$term\fR\->x_resource ($pattern)" 4
1052.IX Item "$value = $term->x_resource ($pattern)" 1067.IX Item "$value = $term->x_resource ($pattern)"
1053Returns the X\-Resource for the given pattern, excluding the program or 1068Returns the X\-Resource for the given pattern, excluding the program or
1054class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the 1069class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the
1055same value as used by this instance of rxvt\-unicode. Returns \f(CW\*(C`undef\*(C'\fR if no 1070same value as used by this instance of rxvt-unicode. Returns \f(CW\*(C`undef\*(C'\fR if no
1056resource with that pattern exists. 1071resource with that pattern exists.
1057.Sp 1072.Sp
1058This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is 1073This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is
1059only one resource database per display, and later invocations might return 1074only one resource database per display, and later invocations might return
1060the wrong resources. 1075the wrong resources.
1061.ie n .IP "$success = $term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 1076.ie n .IP "$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4
1062.el .IP "$success = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 1077.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4
1063.IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" 1078.IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)"
1064Adds a keymap translation exactly as specified via a resource. See the 1079Adds a keymap translation exactly as specified via a resource. See the
1065\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. 1080\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage.
1066.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4 1081.ie n .IP "$rend\fR = \f(CW$term\->rstyle ([$new_rstyle])" 4
1067.el .IP "$rend = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 1082.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4
1068.IX Item "$rend = $term->rstyle ([$new_rstyle])" 1083.IX Item "$rend = $term->rstyle ([$new_rstyle])"
1069Return and optionally change the current rendition. Text that is output by 1084Return and optionally change the current rendition. Text that is output by
1070the terminal application will use this style. 1085the terminal application will use this style.
1071.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col])" 4 1086.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col])" 4
1072.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col\fR])" 4 1087.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col\fR])" 4
… …
1084.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4 1099.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4
1085.IX Item "($row, $col) = $term->selection_end ([$row, $col])" 1100.IX Item "($row, $col) = $term->selection_end ([$row, $col])"
1086.PD 1101.PD
1087Return the current values of the selection mark, begin or end positions, 1102Return the current values of the selection mark, begin or end positions,
1088and optionally set them to new values. 1103and optionally set them to new values.
1089.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4 1104.ie n .IP "$term\fR\->selection_make ($eventtime[, \f(CW$rectangular])" 4
1090.el .IP "$term\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4 1105.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4
1091.IX Item "$term->selection_make ($eventtime[, $rectangular])" 1106.IX Item "$term->selection_make ($eventtime[, $rectangular])"
1092Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and 1107Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and
1093\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a 1108\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a
1094rectangular selection will be made. This is the prefered function to make 1109rectangular selection will be made. This is the prefered function to make
1095a selection. 1110a selection.
1096.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 1111.ie n .IP "$success\fR = \f(CW$term\->selection_grab ($eventtime)" 4
1097.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4 1112.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime)" 4
1098.IX Item "$success = $term->selection_grab ($eventtime)" 1113.IX Item "$success = $term->selection_grab ($eventtime)"
1099Try to request the primary selection text from the server (for example, as 1114Try to request the primary selection text from the server (for example, as
1100set by the next method). No visual feedback will be given. This function 1115set by the next method). No visual feedback will be given. This function
1101is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks. 1116is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks.
1102.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 1117.ie n .IP "$oldtext\fR = \f(CW$term\->selection ([$newtext])" 4
1103.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 1118.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext])" 4
1104.IX Item "$oldtext = $term->selection ([$newtext])" 1119.IX Item "$oldtext = $term->selection ([$newtext])"
1105Return the current selection text and optionally replace it by \f(CW$newtext\fR. 1120Return the current selection text and optionally replace it by \f(CW$newtext\fR.
1106.ie n .IP "$term\->overlay_simple ($x, $y\fR, \f(CW$text)" 4 1121.ie n .IP "$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text)" 4
1107.el .IP "$term\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 1122.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4
1108.IX Item "$term->overlay_simple ($x, $y, $text)" 1123.IX Item "$term->overlay_simple ($x, $y, $text)"
1109Create a simple multi-line overlay box. See the next method for details. 1124Create a simple multi-line overlay box. See the next method for details.
1110.ie n .IP "$term\->overlay ($x, $y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 1125.ie n .IP "$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4
1111.el .IP "$term\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 1126.el .IP "\f(CW$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4
1112.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" 1127.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])"
1113Create a new (empty) overlay at the given position with the given 1128Create a new (empty) overlay at the given position with the given
1114width/height. \f(CW$rstyle\fR defines the initial rendition style 1129width/height. \f(CW$rstyle\fR defines the initial rendition style
1115(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR). 1130(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR).
1116.Sp 1131.Sp
… …
1123This method returns an urxvt::overlay object. The overlay will be visible 1138This method returns an urxvt::overlay object. The overlay will be visible
1124as long as the perl object is referenced. 1139as long as the perl object is referenced.
1125.Sp 1140.Sp
1126The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are: 1141The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are:
1127.RS 4 1142.RS 4
1128.ie n .IP "$overlay\->set ($x, $y\fR, \f(CW$text\fR, \f(CW$rend)" 4 1143.ie n .IP "$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend)" 4
1129.el .IP "$overlay\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 1144.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4
1130.IX Item "$overlay->set ($x, $y, $text, $rend)" 1145.IX Item "$overlay->set ($x, $y, $text, $rend)"
1131Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts 1146Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts
1132text in rxvt\-unicode's special encoding and an array of rendition values 1147text in rxvt-unicode's special encoding and an array of rendition values
1133at a specific position inside the overlay. 1148at a specific position inside the overlay.
1134.IP "$overlay\->hide" 4 1149.ie n .IP "$overlay\->hide" 4
1150.el .IP "\f(CW$overlay\fR\->hide" 4
1135.IX Item "$overlay->hide" 1151.IX Item "$overlay->hide"
1136If visible, hide the overlay, but do not destroy it. 1152If visible, hide the overlay, but do not destroy it.
1137.IP "$overlay\->show" 4 1153.ie n .IP "$overlay\->show" 4
1154.el .IP "\f(CW$overlay\fR\->show" 4
1138.IX Item "$overlay->show" 1155.IX Item "$overlay->show"
1139If hidden, display the overlay again. 1156If hidden, display the overlay again.
1140.RE 1157.RE
1141.RS 4 1158.RS 4
1142.RE 1159.RE
1143.ie n .IP "$popup = $term\->popup ($event)" 4 1160.ie n .IP "$popup\fR = \f(CW$term\->popup ($event)" 4
1144.el .IP "$popup = \f(CW$term\fR\->popup ($event)" 4 1161.el .IP "\f(CW$popup\fR = \f(CW$term\fR\->popup ($event)" 4
1145.IX Item "$popup = $term->popup ($event)" 1162.IX Item "$popup = $term->popup ($event)"
1146Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The 1163Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The
1147\&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event, 1164\&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event,
1148currently). 1165currently).
1149.ie n .IP "$cellwidth = $term\->strwidth ($string)" 4 1166.ie n .IP "$cellwidth\fR = \f(CW$term\->strwidth ($string)" 4
1150.el .IP "$cellwidth = \f(CW$term\fR\->strwidth ($string)" 4 1167.el .IP "\f(CW$cellwidth\fR = \f(CW$term\fR\->strwidth ($string)" 4
1151.IX Item "$cellwidth = $term->strwidth ($string)" 1168.IX Item "$cellwidth = $term->strwidth ($string)"
1152Returns the number of screen-cells this string would need. Correctly 1169Returns the number of screen-cells this string would need. Correctly
1153accounts for wide and combining characters. 1170accounts for wide and combining characters.
1154.ie n .IP "$octets = $term\->locale_encode ($string)" 4 1171.ie n .IP "$octets\fR = \f(CW$term\->locale_encode ($string)" 4
1155.el .IP "$octets = \f(CW$term\fR\->locale_encode ($string)" 4 1172.el .IP "\f(CW$octets\fR = \f(CW$term\fR\->locale_encode ($string)" 4
1156.IX Item "$octets = $term->locale_encode ($string)" 1173.IX Item "$octets = $term->locale_encode ($string)"
1157Convert the given text string into the corresponding locale encoding. 1174Convert the given text string into the corresponding locale encoding.
1158.ie n .IP "$string = $term\->locale_decode ($octets)" 4 1175.ie n .IP "$string\fR = \f(CW$term\->locale_decode ($octets)" 4
1159.el .IP "$string = \f(CW$term\fR\->locale_decode ($octets)" 4 1176.el .IP "\f(CW$string\fR = \f(CW$term\fR\->locale_decode ($octets)" 4
1160.IX Item "$string = $term->locale_decode ($octets)" 1177.IX Item "$string = $term->locale_decode ($octets)"
1161Convert the given locale-encoded octets into a perl string. 1178Convert the given locale-encoded octets into a perl string.
1162.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 1179.ie n .IP "$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4
1163.el .IP "$term\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 1180.el .IP "\f(CW$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4
1164.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" 1181.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])"
1165XORs the rendition values in the given span with the provided value 1182XORs the rendition values in the given span with the provided value
1166(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in 1183(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in
1167refresh hooks to provide effects similar to the selection. 1184refresh hooks to provide effects similar to the selection.
1168.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 1185.ie n .IP "$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4
1169.el .IP "$term\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 1186.el .IP "\f(CW$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4
1170.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" 1187.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])"
1171Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing 1188Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing
1172whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults 1189whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults
1173to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines 1190to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines
1174it instead. Both styles \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. 1191it instead. Both styles \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles.
1175.IP "$term\->scr_bell" 4 1192.ie n .IP "$term\->scr_bell" 4
1193.el .IP "\f(CW$term\fR\->scr_bell" 4
1176.IX Item "$term->scr_bell" 1194.IX Item "$term->scr_bell"
1177Ring the bell! 1195Ring the bell!
1178.IP "$term\->scr_add_lines ($string)" 4 1196.ie n .IP "$term\->scr_add_lines ($string)" 4
1197.el .IP "\f(CW$term\fR\->scr_add_lines ($string)" 4
1179.IX Item "$term->scr_add_lines ($string)" 1198.IX Item "$term->scr_add_lines ($string)"
1180Write the given text string to the screen, as if output by the application 1199Write the given text string to the screen, as if output by the application
1181running inside the terminal. It may not contain command sequences (escape 1200running inside the terminal. It may not contain command sequences (escape
1182codes), but is free to use line feeds, carriage returns and tabs. The 1201codes), but is free to use line feeds, carriage returns and tabs. The
1183string is a normal text string, not in locale-dependent encoding. 1202string is a normal text string, not in locale-dependent encoding.
1184.Sp 1203.Sp
1185Normally its not a good idea to use this function, as programs might be 1204Normally its not a good idea to use this function, as programs might be
1186confused by changes in cursor position or scrolling. Its useful inside a 1205confused by changes in cursor position or scrolling. Its useful inside a
1187\&\f(CW\*(C`on_add_lines\*(C'\fR hook, though. 1206\&\f(CW\*(C`on_add_lines\*(C'\fR hook, though.
1188.IP "$term\->scr_change_screen ($screen)" 4 1207.ie n .IP "$term\->scr_change_screen ($screen)" 4
1208.el .IP "\f(CW$term\fR\->scr_change_screen ($screen)" 4
1189.IX Item "$term->scr_change_screen ($screen)" 1209.IX Item "$term->scr_change_screen ($screen)"
1190Switch to given screen \- 0 primary, 1 secondary. 1210Switch to given screen \- 0 primary, 1 secondary.
1191.IP "$term\->cmd_parse ($octets)" 4 1211.ie n .IP "$term\->cmd_parse ($octets)" 4
1212.el .IP "\f(CW$term\fR\->cmd_parse ($octets)" 4
1192.IX Item "$term->cmd_parse ($octets)" 1213.IX Item "$term->cmd_parse ($octets)"
1193Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the 1214Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the
1194locale-specific encoding of the terminal and can contain command sequences 1215locale-specific encoding of the terminal and can contain command sequences
1195(escape codes) that will be interpreted. 1216(escape codes) that will be interpreted.
1196.IP "$term\->tt_write ($octets)" 4 1217.ie n .IP "$term\->tt_write ($octets)" 4
1218.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4
1197.IX Item "$term->tt_write ($octets)" 1219.IX Item "$term->tt_write ($octets)"
1198Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To 1220Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To
1199pass characters instead of octets, you should convert your strings first 1221pass characters instead of octets, you should convert your strings first
1200to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. 1222to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR.
1201.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4 1223.ie n .IP "$old_events\fR = \f(CW$term\->pty_ev_events ([$new_events])" 4
1202.el .IP "$old_events = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 1224.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4
1203.IX Item "$old_events = $term->pty_ev_events ([$new_events])" 1225.IX Item "$old_events = $term->pty_ev_events ([$new_events])"
1204Replaces the event mask of the pty watcher by the given event mask. Can 1226Replaces the event mask of the pty watcher by the given event mask. Can
1205be used to suppress input and output handling to the pty/tty. See the 1227be used to suppress input and output handling to the pty/tty. See the
1206description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore 1228description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore
1207the previous value. 1229the previous value.
1208.ie n .IP "$fd = $term\->pty_fd" 4 1230.ie n .IP "$fd\fR = \f(CW$term\->pty_fd" 4
1209.el .IP "$fd = \f(CW$term\fR\->pty_fd" 4 1231.el .IP "\f(CW$fd\fR = \f(CW$term\fR\->pty_fd" 4
1210.IX Item "$fd = $term->pty_fd" 1232.IX Item "$fd = $term->pty_fd"
1211Returns the master file descriptor for the pty in use, or \f(CW\*(C`\-1\*(C'\fR if no pty 1233Returns the master file descriptor for the pty in use, or \f(CW\*(C`\-1\*(C'\fR if no pty
1212is used. 1234is used.
1213.ie n .IP "$windowid = $term\->parent" 4 1235.ie n .IP "$windowid\fR = \f(CW$term\->parent" 4
1214.el .IP "$windowid = \f(CW$term\fR\->parent" 4 1236.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->parent" 4
1215.IX Item "$windowid = $term->parent" 1237.IX Item "$windowid = $term->parent"
1216Return the window id of the toplevel window. 1238Return the window id of the toplevel window.
1217.ie n .IP "$windowid = $term\->vt" 4 1239.ie n .IP "$windowid\fR = \f(CW$term\->vt" 4
1218.el .IP "$windowid = \f(CW$term\fR\->vt" 4 1240.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->vt" 4
1219.IX Item "$windowid = $term->vt" 1241.IX Item "$windowid = $term->vt"
1220Return the window id of the terminal window. 1242Return the window id of the terminal window.
1221.IP "$term\->vt_emask_add ($x_event_mask)" 4 1243.ie n .IP "$term\->vt_emask_add ($x_event_mask)" 4
1244.el .IP "\f(CW$term\fR\->vt_emask_add ($x_event_mask)" 4
1222.IX Item "$term->vt_emask_add ($x_event_mask)" 1245.IX Item "$term->vt_emask_add ($x_event_mask)"
1223Adds the specified events to the vt event mask. Useful e.g. when you want 1246Adds the specified events to the vt event mask. Useful e.g. when you want
1224to receive pointer events all the times: 1247to receive pointer events all the times:
1225.Sp 1248.Sp
1226.Vb 1 1249.Vb 1
1227\& $term->vt_emask_add (urxvt::PointerMotionMask); 1250\& $term\->vt_emask_add (urxvt::PointerMotionMask);
1228.Ve 1251.Ve
1229.IP "$term\->focus_in" 4 1252.ie n .IP "$term\->focus_in" 4
1253.el .IP "\f(CW$term\fR\->focus_in" 4
1230.IX Item "$term->focus_in" 1254.IX Item "$term->focus_in"
1231.PD 0 1255.PD 0
1232.IP "$term\->focus_out" 4 1256.ie n .IP "$term\->focus_out" 4
1257.el .IP "\f(CW$term\fR\->focus_out" 4
1233.IX Item "$term->focus_out" 1258.IX Item "$term->focus_out"
1234.ie n .IP "$term\->key_press ($state, $keycode\fR[, \f(CW$time])" 4 1259.ie n .IP "$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time])" 4
1235.el .IP "$term\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 1260.el .IP "\f(CW$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4
1236.IX Item "$term->key_press ($state, $keycode[, $time])" 1261.IX Item "$term->key_press ($state, $keycode[, $time])"
1237.ie n .IP "$term\->key_release ($state, $keycode\fR[, \f(CW$time])" 4 1262.ie n .IP "$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time])" 4
1238.el .IP "$term\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 1263.el .IP "\f(CW$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4
1239.IX Item "$term->key_release ($state, $keycode[, $time])" 1264.IX Item "$term->key_release ($state, $keycode[, $time])"
1240.PD 1265.PD
1241Deliver various fake events to to terminal. 1266Deliver various fake events to to terminal.
1242.ie n .IP "$window_width = $term\->width" 4 1267.ie n .IP "$window_width\fR = \f(CW$term\->width" 4
1243.el .IP "$window_width = \f(CW$term\fR\->width" 4 1268.el .IP "\f(CW$window_width\fR = \f(CW$term\fR\->width" 4
1244.IX Item "$window_width = $term->width" 1269.IX Item "$window_width = $term->width"
1245.PD 0 1270.PD 0
1246.ie n .IP "$window_height = $term\->height" 4 1271.ie n .IP "$window_height\fR = \f(CW$term\->height" 4
1247.el .IP "$window_height = \f(CW$term\fR\->height" 4 1272.el .IP "\f(CW$window_height\fR = \f(CW$term\fR\->height" 4
1248.IX Item "$window_height = $term->height" 1273.IX Item "$window_height = $term->height"
1249.ie n .IP "$font_width = $term\->fwidth" 4 1274.ie n .IP "$font_width\fR = \f(CW$term\->fwidth" 4
1250.el .IP "$font_width = \f(CW$term\fR\->fwidth" 4 1275.el .IP "\f(CW$font_width\fR = \f(CW$term\fR\->fwidth" 4
1251.IX Item "$font_width = $term->fwidth" 1276.IX Item "$font_width = $term->fwidth"
1252.ie n .IP "$font_height = $term\->fheight" 4 1277.ie n .IP "$font_height\fR = \f(CW$term\->fheight" 4
1253.el .IP "$font_height = \f(CW$term\fR\->fheight" 4 1278.el .IP "\f(CW$font_height\fR = \f(CW$term\fR\->fheight" 4
1254.IX Item "$font_height = $term->fheight" 1279.IX Item "$font_height = $term->fheight"
1255.ie n .IP "$font_ascent = $term\->fbase" 4 1280.ie n .IP "$font_ascent\fR = \f(CW$term\->fbase" 4
1256.el .IP "$font_ascent = \f(CW$term\fR\->fbase" 4 1281.el .IP "\f(CW$font_ascent\fR = \f(CW$term\fR\->fbase" 4
1257.IX Item "$font_ascent = $term->fbase" 1282.IX Item "$font_ascent = $term->fbase"
1258.ie n .IP "$terminal_rows = $term\->nrow" 4 1283.ie n .IP "$terminal_rows\fR = \f(CW$term\->nrow" 4
1259.el .IP "$terminal_rows = \f(CW$term\fR\->nrow" 4 1284.el .IP "\f(CW$terminal_rows\fR = \f(CW$term\fR\->nrow" 4
1260.IX Item "$terminal_rows = $term->nrow" 1285.IX Item "$terminal_rows = $term->nrow"
1261.ie n .IP "$terminal_columns = $term\->ncol" 4 1286.ie n .IP "$terminal_columns\fR = \f(CW$term\->ncol" 4
1262.el .IP "$terminal_columns = \f(CW$term\fR\->ncol" 4 1287.el .IP "\f(CW$terminal_columns\fR = \f(CW$term\fR\->ncol" 4
1263.IX Item "$terminal_columns = $term->ncol" 1288.IX Item "$terminal_columns = $term->ncol"
1264.ie n .IP "$has_focus = $term\->focus" 4 1289.ie n .IP "$has_focus\fR = \f(CW$term\->focus" 4
1265.el .IP "$has_focus = \f(CW$term\fR\->focus" 4 1290.el .IP "\f(CW$has_focus\fR = \f(CW$term\fR\->focus" 4
1266.IX Item "$has_focus = $term->focus" 1291.IX Item "$has_focus = $term->focus"
1267.ie n .IP "$is_mapped = $term\->mapped" 4 1292.ie n .IP "$is_mapped\fR = \f(CW$term\->mapped" 4
1268.el .IP "$is_mapped = \f(CW$term\fR\->mapped" 4 1293.el .IP "\f(CW$is_mapped\fR = \f(CW$term\fR\->mapped" 4
1269.IX Item "$is_mapped = $term->mapped" 1294.IX Item "$is_mapped = $term->mapped"
1270.ie n .IP "$max_scrollback = $term\->saveLines" 4 1295.ie n .IP "$max_scrollback\fR = \f(CW$term\->saveLines" 4
1271.el .IP "$max_scrollback = \f(CW$term\fR\->saveLines" 4 1296.el .IP "\f(CW$max_scrollback\fR = \f(CW$term\fR\->saveLines" 4
1272.IX Item "$max_scrollback = $term->saveLines" 1297.IX Item "$max_scrollback = $term->saveLines"
1273.ie n .IP "$nrow_plus_saveLines = $term\->total_rows" 4 1298.ie n .IP "$nrow_plus_saveLines\fR = \f(CW$term\->total_rows" 4
1274.el .IP "$nrow_plus_saveLines = \f(CW$term\fR\->total_rows" 4 1299.el .IP "\f(CW$nrow_plus_saveLines\fR = \f(CW$term\fR\->total_rows" 4
1275.IX Item "$nrow_plus_saveLines = $term->total_rows" 1300.IX Item "$nrow_plus_saveLines = $term->total_rows"
1276.ie n .IP "$topmost_scrollback_row = $term\->top_row" 4 1301.ie n .IP "$topmost_scrollback_row\fR = \f(CW$term\->top_row" 4
1277.el .IP "$topmost_scrollback_row = \f(CW$term\fR\->top_row" 4 1302.el .IP "\f(CW$topmost_scrollback_row\fR = \f(CW$term\fR\->top_row" 4
1278.IX Item "$topmost_scrollback_row = $term->top_row" 1303.IX Item "$topmost_scrollback_row = $term->top_row"
1279.PD 1304.PD
1280Return various integers describing terminal characteristics. 1305Return various integers describing terminal characteristics.
1281.ie n .IP "$x_display = $term\->display_id" 4 1306.ie n .IP "$x_display\fR = \f(CW$term\->display_id" 4
1282.el .IP "$x_display = \f(CW$term\fR\->display_id" 4 1307.el .IP "\f(CW$x_display\fR = \f(CW$term\fR\->display_id" 4
1283.IX Item "$x_display = $term->display_id" 1308.IX Item "$x_display = $term->display_id"
1284Return the \s-1DISPLAY\s0 used by rxvt\-unicode. 1309Return the \s-1DISPLAY\s0 used by rxvt-unicode.
1285.ie n .IP "$lc_ctype = $term\->locale" 4 1310.ie n .IP "$lc_ctype\fR = \f(CW$term\->locale" 4
1286.el .IP "$lc_ctype = \f(CW$term\fR\->locale" 4 1311.el .IP "\f(CW$lc_ctype\fR = \f(CW$term\fR\->locale" 4
1287.IX Item "$lc_ctype = $term->locale" 1312.IX Item "$lc_ctype = $term->locale"
1288Returns the \s-1LC_CTYPE\s0 category string used by this rxvt\-unicode. 1313Returns the \s-1LC_CTYPE\s0 category string used by this rxvt-unicode.
1289.ie n .IP "$env = $term\->env" 4 1314.ie n .IP "$env\fR = \f(CW$term\->env" 4
1290.el .IP "$env = \f(CW$term\fR\->env" 4 1315.el .IP "\f(CW$env\fR = \f(CW$term\fR\->env" 4
1291.IX Item "$env = $term->env" 1316.IX Item "$env = $term->env"
1292Returns a copy of the environment in effect for the terminal as a hashref 1317Returns a copy of the environment in effect for the terminal as a hashref
1293similar to \f(CW\*(C`\e%ENV\*(C'\fR. 1318similar to \f(CW\*(C`\e%ENV\*(C'\fR.
1294.ie n .IP "@envv = $term\->envv" 4 1319.ie n .IP "@envv\fR = \f(CW$term\->envv" 4
1295.el .IP "@envv = \f(CW$term\fR\->envv" 4 1320.el .IP "\f(CW@envv\fR = \f(CW$term\fR\->envv" 4
1296.IX Item "@envv = $term->envv" 1321.IX Item "@envv = $term->envv"
1297Returns the environment as array of strings of the form \f(CW\*(C`VAR=VALUE\*(C'\fR. 1322Returns the environment as array of strings of the form \f(CW\*(C`VAR=VALUE\*(C'\fR.
1298.ie n .IP "@argv = $term\->argv" 4 1323.ie n .IP "@argv\fR = \f(CW$term\->argv" 4
1299.el .IP "@argv = \f(CW$term\fR\->argv" 4 1324.el .IP "\f(CW@argv\fR = \f(CW$term\fR\->argv" 4
1300.IX Item "@argv = $term->argv" 1325.IX Item "@argv = $term->argv"
1301Return the argument vector as this terminal, similar to \f(CW@ARGV\fR, but 1326Return the argument vector as this terminal, similar to \f(CW@ARGV\fR, but
1302includes the program name as first element. 1327includes the program name as first element.
1303.ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 1328.ie n .IP "$modifiermask\fR = \f(CW$term\->ModLevel3Mask" 4
1304.el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 1329.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModLevel3Mask" 4
1305.IX Item "$modifiermask = $term->ModLevel3Mask" 1330.IX Item "$modifiermask = $term->ModLevel3Mask"
1306.PD 0 1331.PD 0
1307.ie n .IP "$modifiermask = $term\->ModMetaMask" 4 1332.ie n .IP "$modifiermask\fR = \f(CW$term\->ModMetaMask" 4
1308.el .IP "$modifiermask = \f(CW$term\fR\->ModMetaMask" 4 1333.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModMetaMask" 4
1309.IX Item "$modifiermask = $term->ModMetaMask" 1334.IX Item "$modifiermask = $term->ModMetaMask"
1310.ie n .IP "$modifiermask = $term\->ModNumLockMask" 4 1335.ie n .IP "$modifiermask\fR = \f(CW$term\->ModNumLockMask" 4
1311.el .IP "$modifiermask = \f(CW$term\fR\->ModNumLockMask" 4 1336.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModNumLockMask" 4
1312.IX Item "$modifiermask = $term->ModNumLockMask" 1337.IX Item "$modifiermask = $term->ModNumLockMask"
1313.PD 1338.PD
1314Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often 1339Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often
1315AltGr), the meta key (often Alt) and the num lock key, if applicable. 1340AltGr), the meta key (often Alt) and the num lock key, if applicable.
1316.ie n .IP "$screen = $term\->current_screen" 4 1341.ie n .IP "$screen\fR = \f(CW$term\->current_screen" 4
1317.el .IP "$screen = \f(CW$term\fR\->current_screen" 4 1342.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->current_screen" 4
1318.IX Item "$screen = $term->current_screen" 1343.IX Item "$screen = $term->current_screen"
1319Returns the currently displayed screen (0 primary, 1 secondary). 1344Returns the currently displayed screen (0 primary, 1 secondary).
1320.ie n .IP "$cursor_is_hidden = $term\->hidden_cursor" 4 1345.ie n .IP "$cursor_is_hidden\fR = \f(CW$term\->hidden_cursor" 4
1321.el .IP "$cursor_is_hidden = \f(CW$term\fR\->hidden_cursor" 4 1346.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4
1322.IX Item "$cursor_is_hidden = $term->hidden_cursor" 1347.IX Item "$cursor_is_hidden = $term->hidden_cursor"
1323Returns whether the cursor is currently hidden or not. 1348Returns whether the cursor is currently hidden or not.
1324.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 1349.ie n .IP "$view_start\fR = \f(CW$term\->view_start ([$newvalue])" 4
1325.el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 1350.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4
1326.IX Item "$view_start = $term->view_start ([$newvalue])" 1351.IX Item "$view_start = $term->view_start ([$newvalue])"
1327Returns the row number of the topmost displayed line. Maximum value is 1352Returns the row number of the topmost displayed line. Maximum value is
1328\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll 1353\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll
1329this many lines into the scrollback buffer. 1354this many lines into the scrollback buffer.
1330.IP "$term\->want_refresh" 4 1355.ie n .IP "$term\->want_refresh" 4
1356.el .IP "\f(CW$term\fR\->want_refresh" 4
1331.IX Item "$term->want_refresh" 1357.IX Item "$term->want_refresh"
1332Requests a screen refresh. At the next opportunity, rxvt-unicode will 1358Requests a screen refresh. At the next opportunity, rxvt-unicode will
1333compare the on-screen display with its stored representation. If they 1359compare the on-screen display with its stored representation. If they
1334differ, it redraws the differences. 1360differ, it redraws the differences.
1335.Sp 1361.Sp
1336Used after changing terminal contents to display them. 1362Used after changing terminal contents to display them.
1337.ie n .IP "$text = $term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 1363.ie n .IP "$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4
1338.el .IP "$text = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4 1364.el .IP "\f(CW$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4
1339.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])" 1365.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])"
1340Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW0\fR 1366Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW0\fR
1341is the topmost terminal line, row \f(CW\*(C`$term\->$ncol\-1\*(C'\fR is the bottommost 1367is the topmost terminal line, row \f(CW\*(C`$term\->$ncol\-1\*(C'\fR is the bottommost
1342terminal line. The scrollback buffer starts at line \f(CW\*(C`\-1\*(C'\fR and extends to 1368terminal line. The scrollback buffer starts at line \f(CW\*(C`\-1\*(C'\fR and extends to
1343line \f(CW\*(C`\-$term\->nsaved\*(C'\fR. Nothing will be returned if a nonexistent line 1369line \f(CW\*(C`\-$term\->nsaved\*(C'\fR. Nothing will be returned if a nonexistent line
… …
1358that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on 1384that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on
1359characters. 1385characters.
1360.Sp 1386.Sp
1361The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR 1387The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR
1362can be used to convert normal strings into this encoding and vice versa. 1388can be used to convert normal strings into this encoding and vice versa.
1363.ie n .IP "$rend = $term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 1389.ie n .IP "$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4
1364.el .IP "$rend = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4 1390.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4
1365.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])" 1391.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])"
1366Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition 1392Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition
1367bitsets. Rendition bitsets contain information about colour, font, font 1393bitsets. Rendition bitsets contain information about colour, font, font
1368styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR. 1394styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR.
1369.Sp 1395.Sp
1370When setting rendition, the font mask will be ignored. 1396When setting rendition, the font mask will be ignored.
1371.Sp 1397.Sp
1372See the section on \s-1RENDITION\s0, above. 1398See the section on \s-1RENDITION\s0, above.
1373.ie n .IP "$length = $term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 1399.ie n .IP "$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4
1374.el .IP "$length = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 1400.el .IP "\f(CW$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4
1375.IX Item "$length = $term->ROW_l ($row_number[, $new_length])" 1401.IX Item "$length = $term->ROW_l ($row_number[, $new_length])"
1376Returns the number of screen cells that are in use (\*(L"the line 1402Returns the number of screen cells that are in use (\*(L"the line
1377length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the 1403length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the
1378line is joined with the following one. 1404line is joined with the following one.
1379.ie n .IP "$bool = $term\->is_longer ($row_number)" 4 1405.ie n .IP "$bool\fR = \f(CW$term\->is_longer ($row_number)" 4
1380.el .IP "$bool = \f(CW$term\fR\->is_longer ($row_number)" 4 1406.el .IP "\f(CW$bool\fR = \f(CW$term\fR\->is_longer ($row_number)" 4
1381.IX Item "$bool = $term->is_longer ($row_number)" 1407.IX Item "$bool = $term->is_longer ($row_number)"
1382Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e. 1408Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e.
1383joined with the following row), which means all characters are in use 1409joined with the following row), which means all characters are in use
1384and it is continued on the next row (and possibly a continuation of the 1410and it is continued on the next row (and possibly a continuation of the
1385previous row(s)). 1411previous row(s)).
1386.ie n .IP "$line = $term\->line ($row_number)" 4 1412.ie n .IP "$line\fR = \f(CW$term\->line ($row_number)" 4
1387.el .IP "$line = \f(CW$term\fR\->line ($row_number)" 4 1413.el .IP "\f(CW$line\fR = \f(CW$term\fR\->line ($row_number)" 4
1388.IX Item "$line = $term->line ($row_number)" 1414.IX Item "$line = $term->line ($row_number)"
1389Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information 1415Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information
1390about the logical line that row \f(CW$row_number\fR is part of. It supports the 1416about the logical line that row \f(CW$row_number\fR is part of. It supports the
1391following methods: 1417following methods:
1392.RS 4 1418.RS 4
1393.ie n .IP "$text = $line\->t ([$new_text])" 4 1419.ie n .IP "$text\fR = \f(CW$line\->t ([$new_text])" 4
1394.el .IP "$text = \f(CW$line\fR\->t ([$new_text])" 4 1420.el .IP "\f(CW$text\fR = \f(CW$line\fR\->t ([$new_text])" 4
1395.IX Item "$text = $line->t ([$new_text])" 1421.IX Item "$text = $line->t ([$new_text])"
1396Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR 1422Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR
1397.ie n .IP "$rend = $line\->r ([$new_rend])" 4 1423.ie n .IP "$rend\fR = \f(CW$line\->r ([$new_rend])" 4
1398.el .IP "$rend = \f(CW$line\fR\->r ([$new_rend])" 4 1424.el .IP "\f(CW$rend\fR = \f(CW$line\fR\->r ([$new_rend])" 4
1399.IX Item "$rend = $line->r ([$new_rend])" 1425.IX Item "$rend = $line->r ([$new_rend])"
1400Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR 1426Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR
1401.ie n .IP "$length = $line\->l" 4 1427.ie n .IP "$length\fR = \f(CW$line\->l" 4
1402.el .IP "$length = \f(CW$line\fR\->l" 4 1428.el .IP "\f(CW$length\fR = \f(CW$line\fR\->l" 4
1403.IX Item "$length = $line->l" 1429.IX Item "$length = $line->l"
1404Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR. 1430Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR.
1405.ie n .IP "$rownum = $line\->beg" 4 1431.ie n .IP "$rownum\fR = \f(CW$line\->beg" 4
1406.el .IP "$rownum = \f(CW$line\fR\->beg" 4 1432.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->beg" 4
1407.IX Item "$rownum = $line->beg" 1433.IX Item "$rownum = $line->beg"
1408.PD 0 1434.PD 0
1409.ie n .IP "$rownum = $line\->end" 4 1435.ie n .IP "$rownum\fR = \f(CW$line\->end" 4
1410.el .IP "$rownum = \f(CW$line\fR\->end" 4 1436.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->end" 4
1411.IX Item "$rownum = $line->end" 1437.IX Item "$rownum = $line->end"
1412.PD 1438.PD
1413Return the row number of the first/last row of the line, respectively. 1439Return the row number of the first/last row of the line, respectively.
1414.ie n .IP "$offset = $line\fR\->offset_of ($row, \f(CW$col)" 4 1440.ie n .IP "$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col)" 4
1415.el .IP "$offset = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 1441.el .IP "\f(CW$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4
1416.IX Item "$offset = $line->offset_of ($row, $col)" 1442.IX Item "$offset = $line->offset_of ($row, $col)"
1417Returns the character offset of the given row|col pair within the logical 1443Returns the character offset of the given row|col pair within the logical
1418line. Works for rows outside the line, too, and returns corresponding 1444line. Works for rows outside the line, too, and returns corresponding
1419offsets outside the string. 1445offsets outside the string.
1420.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4 1446.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4
… …
1422.IX Item "($row, $col) = $line->coord_of ($offset)" 1448.IX Item "($row, $col) = $line->coord_of ($offset)"
1423Translates a string offset into terminal coordinates again. 1449Translates a string offset into terminal coordinates again.
1424.RE 1450.RE
1425.RS 4 1451.RS 4
1426.RE 1452.RE
1427.ie n .IP "$text = $term\fR\->special_encode \f(CW$string" 4 1453.ie n .IP "$text\fR = \f(CW$term\fR\->special_encode \f(CW$string" 4
1428.el .IP "$text = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 1454.el .IP "\f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4
1429.IX Item "$text = $term->special_encode $string" 1455.IX Item "$text = $term->special_encode $string"
1430Converts a perl string into the special encoding used by rxvt\-unicode, 1456Converts a perl string into the special encoding used by rxvt-unicode,
1431where one character corresponds to one screen cell. See 1457where one character corresponds to one screen cell. See
1432\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 1458\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
1433.ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 1459.ie n .IP "$string\fR = \f(CW$term\fR\->special_decode \f(CW$text" 4
1434.el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 1460.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4
1435.IX Item "$string = $term->special_decode $text" 1461.IX Item "$string = $term->special_decode $text"
1436Converts rxvt-unicodes text representation into a perl string. See 1462Converts rxvt-unicodes text representation into a perl string. See
1437\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 1463\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
1438.ie n .IP "$success = $term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 1464.ie n .IP "$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4
1439.el .IP "$success = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 1465.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4
1440.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])" 1466.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])"
1441.PD 0 1467.PD 0
1442.ie n .IP "$term\->ungrab_button ($button, $modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 1468.ie n .IP "$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4
1443.el .IP "$term\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 1469.el .IP "\f(CW$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4
1444.IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])" 1470.IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])"
1445.PD 1471.PD
1446Register/unregister a synchronous button grab. See the XGrabButton 1472Register/unregister a synchronous button grab. See the XGrabButton
1447manpage. 1473manpage.
1448.ie n .IP "$success = $term\fR\->grab ($eventtime[, \f(CW$sync])" 4 1474.ie n .IP "$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync])" 4
1449.el .IP "$success = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 1475.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4
1450.IX Item "$success = $term->grab ($eventtime[, $sync])" 1476.IX Item "$success = $term->grab ($eventtime[, $sync])"
1451Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1477Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1452synchronous (\f(CW$sync\fR is true). Also remembers the grab timestamp. 1478synchronous (\f(CW$sync\fR is true). Also remembers the grab timestamp.
1453.IP "$term\->allow_events_async" 4 1479.ie n .IP "$term\->allow_events_async" 4
1480.el .IP "\f(CW$term\fR\->allow_events_async" 4
1454.IX Item "$term->allow_events_async" 1481.IX Item "$term->allow_events_async"
1455Calls XAllowEvents with AsyncBoth for the most recent grab. 1482Calls XAllowEvents with AsyncBoth for the most recent grab.
1456.IP "$term\->allow_events_sync" 4 1483.ie n .IP "$term\->allow_events_sync" 4
1484.el .IP "\f(CW$term\fR\->allow_events_sync" 4
1457.IX Item "$term->allow_events_sync" 1485.IX Item "$term->allow_events_sync"
1458Calls XAllowEvents with SyncBoth for the most recent grab. 1486Calls XAllowEvents with SyncBoth for the most recent grab.
1459.IP "$term\->allow_events_replay" 4 1487.ie n .IP "$term\->allow_events_replay" 4
1488.el .IP "\f(CW$term\fR\->allow_events_replay" 4
1460.IX Item "$term->allow_events_replay" 1489.IX Item "$term->allow_events_replay"
1461Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1490Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1462recent grab. 1491recent grab.
1463.IP "$term\->ungrab" 4 1492.ie n .IP "$term\->ungrab" 4
1493.el .IP "\f(CW$term\fR\->ungrab" 4
1464.IX Item "$term->ungrab" 1494.IX Item "$term->ungrab"
1465Calls XUngrab for the most recent grab. Is called automatically on 1495Calls XUngrab for the most recent grab. Is called automatically on
1466evaluation errors, as it is better to lose the grab in the error case as 1496evaluation errors, as it is better to lose the grab in the error case as
1467the session. 1497the session.
1468.ie n .IP "$atom = $term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4 1498.ie n .IP "$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4
1469.el .IP "$atom = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4 1499.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4
1470.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])" 1500.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])"
1471.PD 0 1501.PD 0
1472.ie n .IP "$atom_name = $term\->XGetAtomName ($atom)" 4 1502.ie n .IP "$atom_name\fR = \f(CW$term\->XGetAtomName ($atom)" 4
1473.el .IP "$atom_name = \f(CW$term\fR\->XGetAtomName ($atom)" 4 1503.el .IP "\f(CW$atom_name\fR = \f(CW$term\fR\->XGetAtomName ($atom)" 4
1474.IX Item "$atom_name = $term->XGetAtomName ($atom)" 1504.IX Item "$atom_name = $term->XGetAtomName ($atom)"
1475.ie n .IP "@atoms = $term\->XListProperties ($window)" 4 1505.ie n .IP "@atoms\fR = \f(CW$term\->XListProperties ($window)" 4
1476.el .IP "@atoms = \f(CW$term\fR\->XListProperties ($window)" 4 1506.el .IP "\f(CW@atoms\fR = \f(CW$term\fR\->XListProperties ($window)" 4
1477.IX Item "@atoms = $term->XListProperties ($window)" 1507.IX Item "@atoms = $term->XListProperties ($window)"
1478.ie n .IP "($type,$format,$octets) = $term\fR\->XGetWindowProperty ($window, \f(CW$property)" 4 1508.ie n .IP "($type,$format,$octets) = $term\fR\->XGetWindowProperty ($window, \f(CW$property)" 4
1479.el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4 1509.el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4
1480.IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)" 1510.IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)"
1481.ie n .IP "$term\->XChangeWindowProperty ($window, $property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4 1511.ie n .IP "$term\fR\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4
1482.el .IP "$term\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4 1512.el .IP "\f(CW$term\fR\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4
1483.IX Item "$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)" 1513.IX Item "$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)"
1484.ie n .IP "$term\->XDeleteProperty ($window, $property)" 4 1514.ie n .IP "$term\fR\->XDeleteProperty ($window, \f(CW$property)" 4
1485.el .IP "$term\->XDeleteProperty ($window, \f(CW$property\fR)" 4 1515.el .IP "\f(CW$term\fR\->XDeleteProperty ($window, \f(CW$property\fR)" 4
1486.IX Item "$term->XDeleteProperty ($window, $property)" 1516.IX Item "$term->XDeleteProperty ($window, $property)"
1487.ie n .IP "$window = $term\->DefaultRootWindow" 4 1517.ie n .IP "$window\fR = \f(CW$term\->DefaultRootWindow" 4
1488.el .IP "$window = \f(CW$term\fR\->DefaultRootWindow" 4 1518.el .IP "\f(CW$window\fR = \f(CW$term\fR\->DefaultRootWindow" 4
1489.IX Item "$window = $term->DefaultRootWindow" 1519.IX Item "$window = $term->DefaultRootWindow"
1490.ie n .IP "$term\->XReparentWindow ($window, $parent\fR, [$x, \f(CW$y])" 4 1520.ie n .IP "$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y])" 4
1491.el .IP "$term\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4 1521.el .IP "\f(CW$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4
1492.IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])" 1522.IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])"
1493.IP "$term\->XMapWindow ($window)" 4 1523.ie n .IP "$term\->XMapWindow ($window)" 4
1524.el .IP "\f(CW$term\fR\->XMapWindow ($window)" 4
1494.IX Item "$term->XMapWindow ($window)" 1525.IX Item "$term->XMapWindow ($window)"
1495.IP "$term\->XUnmapWindow ($window)" 4 1526.ie n .IP "$term\->XUnmapWindow ($window)" 4
1527.el .IP "\f(CW$term\fR\->XUnmapWindow ($window)" 4
1496.IX Item "$term->XUnmapWindow ($window)" 1528.IX Item "$term->XUnmapWindow ($window)"
1497.ie n .IP "$term\->XMoveResizeWindow ($window, $x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4 1529.ie n .IP "$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4
1498.el .IP "$term\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4 1530.el .IP "\f(CW$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4
1499.IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)" 1531.IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)"
1500.ie n .IP "($x, $y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y)" 4 1532.ie n .IP "($x, $y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y)" 4
1501.el .IP "($x, \f(CW$y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y\fR)" 4 1533.el .IP "($x, \f(CW$y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y\fR)" 4
1502.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)" 1534.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)"
1503.ie n .IP "$term\->XChangeInput ($window, $add_events\fR[, \f(CW$del_events])" 4 1535.ie n .IP "$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events])" 4
1504.el .IP "$term\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 1536.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4
1505.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])" 1537.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])"
1506.PD 1538.PD
1507Various X or X\-related functions. The \f(CW$term\fR object only serves as 1539Various X or X\-related functions. The \f(CW$term\fR object only serves as
1508the source of the display, otherwise those functions map more-or-less 1540the source of the display, otherwise those functions map more-or-less
1509directory onto the X functions of the same name. 1541directory onto the X functions of the same name.
1510.ie n .Sh "The ""urxvt::popup"" Class" 1542.ie n .Sh "The ""urxvt::popup"" Class"
1511.el .Sh "The \f(CWurxvt::popup\fP Class" 1543.el .Sh "The \f(CWurxvt::popup\fP Class"
1512.IX Subsection "The urxvt::popup Class" 1544.IX Subsection "The urxvt::popup Class"
1513.IP "$popup\->add_title ($title)" 4 1545.ie n .IP "$popup\->add_title ($title)" 4
1546.el .IP "\f(CW$popup\fR\->add_title ($title)" 4
1514.IX Item "$popup->add_title ($title)" 1547.IX Item "$popup->add_title ($title)"
1515Adds a non-clickable title to the popup. 1548Adds a non-clickable title to the popup.
1516.IP "$popup\->add_separator ([$sepchr])" 4 1549.ie n .IP "$popup\->add_separator ([$sepchr])" 4
1550.el .IP "\f(CW$popup\fR\->add_separator ([$sepchr])" 4
1517.IX Item "$popup->add_separator ([$sepchr])" 1551.IX Item "$popup->add_separator ([$sepchr])"
1518Creates a separator, optionally using the character given as \f(CW$sepchr\fR. 1552Creates a separator, optionally using the character given as \f(CW$sepchr\fR.
1519.ie n .IP "$popup\->add_button ($text, $cb)" 4 1553.ie n .IP "$popup\fR\->add_button ($text, \f(CW$cb)" 4
1520.el .IP "$popup\->add_button ($text, \f(CW$cb\fR)" 4 1554.el .IP "\f(CW$popup\fR\->add_button ($text, \f(CW$cb\fR)" 4
1521.IX Item "$popup->add_button ($text, $cb)" 1555.IX Item "$popup->add_button ($text, $cb)"
1522Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is 1556Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is
1523selected. 1557selected.
1524.ie n .IP "$popup\->add_toggle ($text, $initial_value\fR, \f(CW$cb)" 4 1558.ie n .IP "$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb)" 4
1525.el .IP "$popup\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4 1559.el .IP "\f(CW$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4
1526.IX Item "$popup->add_toggle ($text, $initial_value, $cb)" 1560.IX Item "$popup->add_toggle ($text, $initial_value, $cb)"
1527Adds a toggle/checkbox item to the popup. The callback gets called 1561Adds a toggle/checkbox item to the popup. The callback gets called
1528whenever it gets toggled, with a boolean indicating its new value as its 1562whenever it gets toggled, with a boolean indicating its new value as its
1529first argument. 1563first argument.
1530.IP "$popup\->show" 4 1564.ie n .IP "$popup\->show" 4
1565.el .IP "\f(CW$popup\fR\->show" 4
1531.IX Item "$popup->show" 1566.IX Item "$popup->show"
1532Displays the popup (which is initially hidden). 1567Displays the popup (which is initially hidden).
1533.ie n .Sh "The ""urxvt::timer"" Class" 1568.ie n .Sh "The ""urxvt::timer"" Class"
1534.el .Sh "The \f(CWurxvt::timer\fP Class" 1569.el .Sh "The \f(CWurxvt::timer\fP Class"
1535.IX Subsection "The urxvt::timer Class" 1570.IX Subsection "The urxvt::timer Class"
1536This class implements timer watchers/events. Time is represented as a 1571This class implements timer watchers/events. Time is represented as a
1537fractional number of seconds since the epoch. Example: 1572fractional number of seconds since the epoch. Example:
1538.PP 1573.PP
1539.Vb 8 1574.Vb 8
1540\& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); 1575\& $term\->{overlay} = $term\->overlay (\-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1541\& $term->{timer} = urxvt::timer 1576\& $term\->{timer} = urxvt::timer
1542\& ->new 1577\& \->new
1543\& ->interval (1) 1578\& \->interval (1)
1544\& ->cb (sub { 1579\& \->cb (sub {
1545\& $term->{overlay}->set (0, 0, 1580\& $term\->{overlay}\->set (0, 0,
1546\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1581\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1547\& }); 1582\& });
1548.Ve 1583.Ve
1549.IP "$timer = new urxvt::timer" 4 1584.ie n .IP "$timer = new urxvt::timer" 4
1585.el .IP "\f(CW$timer\fR = new urxvt::timer" 4
1550.IX Item "$timer = new urxvt::timer" 1586.IX Item "$timer = new urxvt::timer"
1551Create a new timer object in started state. It is scheduled to fire 1587Create a new timer object in started state. It is scheduled to fire
1552immediately. 1588immediately.
1553.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 1589.ie n .IP "$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4
1554.el .IP "$timer = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 1590.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4
1555.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })" 1591.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })"
1556Set the callback to be called when the timer triggers. 1592Set the callback to be called when the timer triggers.
1557.ie n .IP "$tstamp = $timer\->at" 4 1593.ie n .IP "$tstamp\fR = \f(CW$timer\->at" 4
1558.el .IP "$tstamp = \f(CW$timer\fR\->at" 4 1594.el .IP "\f(CW$tstamp\fR = \f(CW$timer\fR\->at" 4
1559.IX Item "$tstamp = $timer->at" 1595.IX Item "$tstamp = $timer->at"
1560Return the time this watcher will fire next. 1596Return the time this watcher will fire next.
1561.ie n .IP "$timer = $timer\->set ($tstamp)" 4 1597.ie n .IP "$timer\fR = \f(CW$timer\->set ($tstamp)" 4
1562.el .IP "$timer = \f(CW$timer\fR\->set ($tstamp)" 4 1598.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->set ($tstamp)" 4
1563.IX Item "$timer = $timer->set ($tstamp)" 1599.IX Item "$timer = $timer->set ($tstamp)"
1564Set the time the event is generated to \f(CW$tstamp\fR. 1600Set the time the event is generated to \f(CW$tstamp\fR.
1565.ie n .IP "$timer = $timer\->interval ($interval)" 4 1601.ie n .IP "$timer\fR = \f(CW$timer\->interval ($interval)" 4
1566.el .IP "$timer = \f(CW$timer\fR\->interval ($interval)" 4 1602.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->interval ($interval)" 4
1567.IX Item "$timer = $timer->interval ($interval)" 1603.IX Item "$timer = $timer->interval ($interval)"
1568Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically 1604Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically
1569stop after it has fired once. If \f(CW$interval\fR is non\-zero, then the timer 1605stop after it has fired once. If \f(CW$interval\fR is non-zero, then the timer
1570is automatically rescheduled at the given intervals. 1606is automatically rescheduled at the given intervals.
1571.ie n .IP "$timer = $timer\->start" 4 1607.ie n .IP "$timer\fR = \f(CW$timer\->start" 4
1572.el .IP "$timer = \f(CW$timer\fR\->start" 4 1608.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4
1573.IX Item "$timer = $timer->start" 1609.IX Item "$timer = $timer->start"
1574Start the timer. 1610Start the timer.
1575.ie n .IP "$timer = $timer\->start ($tstamp)" 4 1611.ie n .IP "$timer\fR = \f(CW$timer\->start ($tstamp)" 4
1576.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4 1612.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start ($tstamp)" 4
1577.IX Item "$timer = $timer->start ($tstamp)" 1613.IX Item "$timer = $timer->start ($tstamp)"
1578Set the event trigger time to \f(CW$tstamp\fR and start the timer. 1614Set the event trigger time to \f(CW$tstamp\fR and start the timer.
1579.ie n .IP "$timer = $timer\->after ($delay)" 4 1615.ie n .IP "$timer\fR = \f(CW$timer\->after ($delay)" 4
1580.el .IP "$timer = \f(CW$timer\fR\->after ($delay)" 4 1616.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->after ($delay)" 4
1581.IX Item "$timer = $timer->after ($delay)" 1617.IX Item "$timer = $timer->after ($delay)"
1582Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c<urxvt::NOW + \f(CW$delay\fR>. 1618Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c<urxvt::NOW + \f(CW$delay\fR>.
1583.ie n .IP "$timer = $timer\->stop" 4 1619.ie n .IP "$timer\fR = \f(CW$timer\->stop" 4
1584.el .IP "$timer = \f(CW$timer\fR\->stop" 4 1620.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4
1585.IX Item "$timer = $timer->stop" 1621.IX Item "$timer = $timer->stop"
1586Stop the timer. 1622Stop the timer.
1587.ie n .Sh "The ""urxvt::iow"" Class" 1623.ie n .Sh "The ""urxvt::iow"" Class"
1588.el .Sh "The \f(CWurxvt::iow\fP Class" 1624.el .Sh "The \f(CWurxvt::iow\fP Class"
1589.IX Subsection "The urxvt::iow Class" 1625.IX Subsection "The urxvt::iow Class"
1590This class implements io watchers/events. Example: 1626This class implements io watchers/events. Example:
1591.PP 1627.PP
1592.Vb 12 1628.Vb 12
1593\& $term->{socket} = ... 1629\& $term\->{socket} = ...
1594\& $term->{iow} = urxvt::iow 1630\& $term\->{iow} = urxvt::iow
1595\& ->new 1631\& \->new
1596\& ->fd (fileno $term->{socket}) 1632\& \->fd (fileno $term\->{socket})
1597\& ->events (urxvt::EV_READ) 1633\& \->events (urxvt::EV_READ)
1598\& ->start 1634\& \->start
1599\& ->cb (sub { 1635\& \->cb (sub {
1600\& my ($iow, $revents) = @_; 1636\& my ($iow, $revents) = @_;
1601\& # $revents must be 1 here, no need to check 1637\& # $revents must be 1 here, no need to check
1602\& sysread $term->{socket}, my $buf, 8192 1638\& sysread $term\->{socket}, my $buf, 8192
1603\& or end-of-file; 1639\& or end\-of\-file;
1604\& }); 1640\& });
1605.Ve 1641.Ve
1606.IP "$iow = new urxvt::iow" 4 1642.ie n .IP "$iow = new urxvt::iow" 4
1643.el .IP "\f(CW$iow\fR = new urxvt::iow" 4
1607.IX Item "$iow = new urxvt::iow" 1644.IX Item "$iow = new urxvt::iow"
1608Create a new io watcher object in stopped state. 1645Create a new io watcher object in stopped state.
1609.ie n .IP "$iow = $iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 1646.ie n .IP "$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4
1610.el .IP "$iow = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 1647.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4
1611.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })" 1648.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })"
1612Set the callback to be called when io events are triggered. \f(CW$reventmask\fR 1649Set the callback to be called when io events are triggered. \f(CW$reventmask\fR
1613is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. 1650is a bitset as described in the \f(CW\*(C`events\*(C'\fR method.
1614.ie n .IP "$iow = $iow\->fd ($fd)" 4 1651.ie n .IP "$iow\fR = \f(CW$iow\->fd ($fd)" 4
1615.el .IP "$iow = \f(CW$iow\fR\->fd ($fd)" 4 1652.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4
1616.IX Item "$iow = $iow->fd ($fd)" 1653.IX Item "$iow = $iow->fd ($fd)"
1617Set the file descriptor (not handle) to watch. 1654Set the file descriptor (not handle) to watch.
1618.ie n .IP "$iow = $iow\->events ($eventmask)" 4 1655.ie n .IP "$iow\fR = \f(CW$iow\->events ($eventmask)" 4
1619.el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 1656.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4
1620.IX Item "$iow = $iow->events ($eventmask)" 1657.IX Item "$iow = $iow->events ($eventmask)"
1621Set the event mask to watch. The only allowed values are 1658Set the event mask to watch. The only allowed values are
1622\&\f(CW\*(C`urxvt::EV_READ\*(C'\fR and \f(CW\*(C`urxvt::EV_WRITE\*(C'\fR, which might be ORed 1659\&\f(CW\*(C`urxvt::EV_READ\*(C'\fR and \f(CW\*(C`urxvt::EV_WRITE\*(C'\fR, which might be ORed
1623together, or \f(CW\*(C`urxvt::EV_NONE\*(C'\fR. 1660together, or \f(CW\*(C`urxvt::EV_NONE\*(C'\fR.
1624.ie n .IP "$iow = $iow\->start" 4 1661.ie n .IP "$iow\fR = \f(CW$iow\->start" 4
1625.el .IP "$iow = \f(CW$iow\fR\->start" 4 1662.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->start" 4
1626.IX Item "$iow = $iow->start" 1663.IX Item "$iow = $iow->start"
1627Start watching for requested events on the given handle. 1664Start watching for requested events on the given handle.
1628.ie n .IP "$iow = $iow\->stop" 4 1665.ie n .IP "$iow\fR = \f(CW$iow\->stop" 4
1629.el .IP "$iow = \f(CW$iow\fR\->stop" 4 1666.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4
1630.IX Item "$iow = $iow->stop" 1667.IX Item "$iow = $iow->stop"
1631Stop watching for events on the given file handle. 1668Stop watching for events on the given file handle.
1632.ie n .Sh "The ""urxvt::iw"" Class" 1669.ie n .Sh "The ""urxvt::iw"" Class"
1633.el .Sh "The \f(CWurxvt::iw\fP Class" 1670.el .Sh "The \f(CWurxvt::iw\fP Class"
1634.IX Subsection "The urxvt::iw Class" 1671.IX Subsection "The urxvt::iw Class"
1635This class implements idle watchers, that get called automatically when 1672This class implements idle watchers, that get called automatically when
1636the process is idle. They should return as fast as possible, after doing 1673the process is idle. They should return as fast as possible, after doing
1637some useful work. 1674some useful work.
1638.IP "$iw = new urxvt::iw" 4 1675.ie n .IP "$iw = new urxvt::iw" 4
1676.el .IP "\f(CW$iw\fR = new urxvt::iw" 4
1639.IX Item "$iw = new urxvt::iw" 1677.IX Item "$iw = new urxvt::iw"
1640Create a new idle watcher object in stopped state. 1678Create a new idle watcher object in stopped state.
1641.ie n .IP "$iw = $iw\fR\->cb (sub { my ($iw) = \f(CW@_; ... })" 4 1679.ie n .IP "$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_; ... })" 4
1642.el .IP "$iw = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4 1680.el .IP "\f(CW$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4
1643.IX Item "$iw = $iw->cb (sub { my ($iw) = @_; ... })" 1681.IX Item "$iw = $iw->cb (sub { my ($iw) = @_; ... })"
1644Set the callback to be called when the watcher triggers. 1682Set the callback to be called when the watcher triggers.
1645.ie n .IP "$timer = $timer\->start" 4 1683.ie n .IP "$timer\fR = \f(CW$timer\->start" 4
1646.el .IP "$timer = \f(CW$timer\fR\->start" 4 1684.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4
1647.IX Item "$timer = $timer->start" 1685.IX Item "$timer = $timer->start"
1648Start the watcher. 1686Start the watcher.
1649.ie n .IP "$timer = $timer\->stop" 4 1687.ie n .IP "$timer\fR = \f(CW$timer\->stop" 4
1650.el .IP "$timer = \f(CW$timer\fR\->stop" 4 1688.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4
1651.IX Item "$timer = $timer->stop" 1689.IX Item "$timer = $timer->stop"
1652Stop the watcher. 1690Stop the watcher.
1653.ie n .Sh "The ""urxvt::pw"" Class" 1691.ie n .Sh "The ""urxvt::pw"" Class"
1654.el .Sh "The \f(CWurxvt::pw\fP Class" 1692.el .Sh "The \f(CWurxvt::pw\fP Class"
1655.IX Subsection "The urxvt::pw Class" 1693.IX Subsection "The urxvt::pw Class"
… …
1657process exits, after which they stop automatically. 1695process exits, after which they stop automatically.
1658.PP 1696.PP
1659.Vb 9 1697.Vb 9
1660\& my $pid = fork; 1698\& my $pid = fork;
1661\& ... 1699\& ...
1662\& $term->{pw} = urxvt::pw 1700\& $term\->{pw} = urxvt::pw
1663\& ->new 1701\& \->new
1664\& ->start ($pid) 1702\& \->start ($pid)
1665\& ->cb (sub { 1703\& \->cb (sub {
1666\& my ($pw, $exit_status) = @_; 1704\& my ($pw, $exit_status) = @_;
1667\& ... 1705\& ...
1668\& }); 1706\& });
1669.Ve 1707.Ve
1670.IP "$pw = new urxvt::pw" 4 1708.ie n .IP "$pw = new urxvt::pw" 4
1709.el .IP "\f(CW$pw\fR = new urxvt::pw" 4
1671.IX Item "$pw = new urxvt::pw" 1710.IX Item "$pw = new urxvt::pw"
1672Create a new process watcher in stopped state. 1711Create a new process watcher in stopped state.
1673.ie n .IP "$pw = $pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_; ... })" 4 1712.ie n .IP "$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_; ... })" 4
1674.el .IP "$pw = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4 1713.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4
1675.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })" 1714.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })"
1676Set the callback to be called when the timer triggers. 1715Set the callback to be called when the timer triggers.
1677.ie n .IP "$pw = $timer\->start ($pid)" 4 1716.ie n .IP "$pw\fR = \f(CW$timer\->start ($pid)" 4
1678.el .IP "$pw = \f(CW$timer\fR\->start ($pid)" 4 1717.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4
1679.IX Item "$pw = $timer->start ($pid)" 1718.IX Item "$pw = $timer->start ($pid)"
1680Tells the watcher to start watching for process \f(CW$pid\fR. 1719Tells the watcher to start watching for process \f(CW$pid\fR.
1681.ie n .IP "$pw = $pw\->stop" 4 1720.ie n .IP "$pw\fR = \f(CW$pw\->stop" 4
1682.el .IP "$pw = \f(CW$pw\fR\->stop" 4 1721.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4
1683.IX Item "$pw = $pw->stop" 1722.IX Item "$pw = $pw->stop"
1684Stop the watcher. 1723Stop the watcher.
1685.SH "ENVIRONMENT" 1724.SH "ENVIRONMENT"
1686.IX Header "ENVIRONMENT" 1725.IX Header "ENVIRONMENT"
1687.Sh "\s-1URXVT_PERL_VERBOSITY\s0" 1726.Sh "\s-1URXVT_PERL_VERBOSITY\s0"
… …
1700.PD 1739.PD
1701.SH "AUTHOR" 1740.SH "AUTHOR"
1702.IX Header "AUTHOR" 1741.IX Header "AUTHOR"
1703.Vb 2 1742.Vb 2
1704\& Marc Lehmann <pcg@goof.com> 1743\& Marc Lehmann <pcg@goof.com>
1705\& http://software.schmorp.de/pkg/rxvt-unicode 1744\& http://software.schmorp.de/pkg/rxvt\-unicode
1706.Ve 1745.Ve

Diff Legend

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