repo: rxvt-unicode-sixel action: commit revision: path_from: revision_from: 72da1ae67a47c1a00b8caf94f69d6780deae8085: path_to: revision_to:
commit 72da1ae67a47c1a00b8caf94f69d6780deae8085 Author: Marc LehmannDate: Fri Sep 21 23:26:20 2012 +0000 dynamically generate rxvtperl manpage, install rxvt-extensions diff --git a/MANIFEST b/MANIFEST
--- a/MANIFEST +++ b/MANIFEST @@ -37,7 +37,8 @@ doc/rxvt.1.man.in doc/rxvt.7.man.in doc/rxvtc.1.man.in doc/rxvtd.1.man.in -doc/rxvtperl.3.man.in +doc/extensions.pod.top +doc/extensions.pod.bot src/.cvsignore src/Makefile.in diff --git a/doc/Makefile.in b/doc/Makefile.in
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -40,12 +40,8 @@ all:
sed $(SEDREPLACE) < $(srcdir)/rxvtc.1.man.in >rxvtc.1.man
sed $(SEDREPLACE) < $(srcdir)/rxvtd.1.man.in >rxvtd.1.man
sed $(SEDREPLACE) < $(srcdir)/rxvt.7.man.in >rxvt.7.man
-@IF_PERL@ sed $(SEDREPLACE) < $(srcdir)/rxvtperl.3.man.in >rxvtperl.3.man
-.INTERMEDIATE: rxvtperl.3.pod rxvt.7.tbl
-
-rxvtperl.3.pod: ../src/urxvt.pm
- cp $< $@
+.INTERMEDIATE: rxvt.7.tbl
%.tbl: %.pod
$(srcdir)/podtbl <$< >$@
@@ -76,18 +72,18 @@ $(srcdir)/etc/rxvt-unicode.termcap: $(srcdir)/etc/rxvt-unicode.terminfo
tags allbin:
-alldoc: rxvt.1.man.in rxvt.7.man.in rxvtc.1.man.in rxvtd.1.man.in rxvtperl.3.man.in \
+alldoc: rxvt.1.man.in rxvt.7.man.in rxvtc.1.man.in rxvtd.1.man.in \
../README.configure ../README.FAQ \
$(srcdir)/etc/rxvt-unicode.termcap
clean:
- rm -f rxvt.1.man rxvt.7.man rxvtc.1.man rxvtd.1.man rxvtperl.3.man
+ rm -f rxvt.1.man rxvt.7.man rxvtc.1.man rxvtd.1.man
distclean: clean
rm -f Makefile
realclean: distclean
- rm -f rxvt.1.man.in rxvt.7.man.in rxvtc.1.man.in rxvtd.1.man.in rxvtperl.3.man.in
+ rm -f rxvt.1.man.in rxvt.7.man.in rxvtc.1.man.in rxvtd.1.man.in
rm -f ../README.configure ../README.FAQ
rm -f $(srcdir)/etc/rxvt-unicode.termcap
@@ -100,8 +96,6 @@ install: all
$(INSTALL_DATA) rxvtc.1.man $(DESTDIR)$(man1dir)/$(RXVTNAME)c.$(man1ext)
$(INSTALL_DATA) rxvtd.1.man $(DESTDIR)$(man1dir)/$(RXVTNAME)d.$(man1ext)
$(INSTALL_DATA) rxvt.7.man $(DESTDIR)$(man7dir)/$(RXVTNAME).$(man7ext)
-@IF_PERL@ $(INSTALL) -d $(DESTDIR)$(man3dir)
-@IF_PERL@ $(INSTALL_DATA) rxvtperl.3.man $(DESTDIR)$(man3dir)/$(RXVTNAME)perl.$(man3ext)
@TIC@ $(srcdir)/etc/rxvt-unicode.terminfo
distdepend: alldoc
diff --git a/doc/extensions.pod.bot b/doc/extensions.pod.bot
new file mode 100644
index 0000000000000000000000000000000000000000..89de93d69d91e557dd911babcfd843444ad09b67
--- /dev/null
+++ b/doc/extensions.pod.bot
@@ -0,0 +1,5 @@
+
+=head1 SEE ALSO
+
+urxvt(1), urxvtperl(3).
+
diff --git a/doc/extensions.pod.top b/doc/extensions.pod.top
new file mode 100644
index 0000000000000000000000000000000000000000..929e206356f60c94c1cb832af7b278b5e741cec4
--- /dev/null
+++ b/doc/extensions.pod.top
@@ -0,0 +1,20 @@
+=head1 NAME
+
+urxvt-extensions - briefly list urxvt perl extensions
+
+=head1 SYNOPSIS
+
+ urxvt -pe extension-name
+
+=head1 DESCRIPTION
+
+This manpage briefly lists the rxvt-unicode extensions available in this
+version of rxvt-unicode.
+
+Extensions that use resources or command line switches for configuration
+are loaded automatically when their resources or switches are used. Any
+extension cna be laoded explicitly with the C<-pe> switch.
+
+=head1 EXTENSIONS
+
+
diff --git a/doc/rxvtperl.3.man.in b/doc/rxvtperl.3.man.in
deleted file mode 100644
index 50b29db4888d2d2d618c64d2a43221f3a220c1ec..0000000000000000000000000000000000000000
--- a/doc/rxvtperl.3.man.in
+++ /dev/null
@@ -1,1522 +0,0 @@
-.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
-.nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
-.fi
-..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
-. ds C` ""
-. ds C' ""
-'br\}
-.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
-'br\}
-.\"
-.\" Escape single quotes in literal strings from groff's Unicode transform.
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
-.\" entries marked with X<> in POD. Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.ie \nF \{\
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
-..
-. nr % 0
-. rr F
-.\}
-.el \{\
-. de IX
-..
-.\}
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
-.IX Title "@@RXVT_NAME@@ 3"
-.TH @@RXVT_NAME@@ 3 "2012-09-04" "@@RXVT_VERSION@@" "RXVT-UNICODE"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.if n .ad l
-.nh
-.SH "NAME"
-@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-.Vb 1
-\& # create a file grab_test in $HOME:
-\&
-\& sub on_sel_grab {
-\& warn "you selected ", $_[0]\->selection;
-\& ()
-\& }
-\&
-\& # start a @@RXVT_NAME@@ using it:
-\&
-\& @@RXVT_NAME@@ \-\-perl\-lib $HOME \-pe grab_test
-.Ve
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-Every time a terminal object gets created, extension scripts specified via
-the \f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it.
-.PP
-Scripts are compiled in a 'use strict \*(L"vars\*(R"' and 'use utf8' environment, and
-thus must be encoded as \s-1UTF\-8\s0.
-.PP
-Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
-scripts will be shared (but not enabled) for all terminals.
-.PP
-You can disable the embedded perl interpreter by setting both \*(L"perl-ext\*(R"
-and \*(L"perl-ext-common\*(R" resources to the empty string.
-.SH "PREPACKAGED EXTENSIONS"
-.IX Header "PREPACKAGED EXTENSIONS"
-A number of extensions are delivered with this release. You can find them
-in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR, and the documentation can be viewed
-using \fIman urxvt\-<\s-1EXTENSIONNAME\s0>\fR.
-.PP
-You can activate them like this:
-.PP
-.Vb 1
-\& @@RXVT_NAME@@ \-pe
-.Ve
-.PP
-Or by adding them to the resource for extensions loaded by default:
-.PP
-.Vb 1
-\& URxvt.perl\-ext\-common: default,selection\-autotransform
-.Ve
-.PP
-Extensions that add command line parameters or resources on their own are
-loaded automatically when used.
-.SH "API DOCUMENTATION"
-.IX Header "API DOCUMENTATION"
-.SS "General \s-1API\s0 Considerations"
-.IX Subsection "General API Considerations"
-All objects (such as terminals, time watchers etc.) are typical
-reference-to-hash objects. The hash can be used to store anything you
-like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or
-\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and \fB\s-1MUST\s0 \s-1NOT\s0\fR be accessed or
-modified).
-.PP
-When objects are destroyed on the \*(C+ side, the perl object hashes are
-emptied, so its best to store related objects such as time watchers and
-the like inside the terminal object so they get destroyed as soon as the
-terminal is destroyed.
-.PP
-Argument names also often indicate the type of a parameter. Here are some
-hints on what they mean:
-.ie n .IP "$text" 4
-.el .IP "\f(CW$text\fR" 4
-.IX Item "$text"
-Rxvt-unicode's special way of encoding text, where one \*(L"unicode\*(R" character
-always represents one screen cell. See ROW_t for a discussion of this format.
-.ie n .IP "$string" 4
-.el .IP "\f(CW$string\fR" 4
-.IX Item "$string"
-A perl text string, with an emphasis on \fItext\fR. It can store all unicode
-characters and is to be distinguished with text encoded in a specific
-encoding (often locale-specific) and binary data.
-.ie n .IP "$octets" 4
-.el .IP "\f(CW$octets\fR" 4
-.IX Item "$octets"
-Either binary data or \- more common \- a text string encoded in a
-locale-specific way.
-.ie n .IP "$keysym" 4
-.el .IP "\f(CW$keysym\fR" 4
-.IX Item "$keysym"
-an integer that is a valid X11 keysym code. You can convert a string
-into a keysym and viceversa by using \f(CW\*(C`XStringToKeysym\*(C'\fR and
-\&\f(CW\*(C`XKeysymToString\*(C'\fR.
-.SS "Extension Objects"
-.IX Subsection "Extension Objects"
-Every perl extension is a perl class. A separate perl object is created
-for each terminal, and each terminal has its own set of extension objects,
-which are passed as the first parameter to hooks. So extensions can use
-their \f(CW$self\fR object without having to think about clashes with other
-extensions or other terminals, with the exception of methods and members
-that begin with an underscore character \f(CW\*(C`_\*(C'\fR: these are reserved for
-internal use.
-.PP
-Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the
-\&\f(CW\*(C`urxvt::term\*(C'\fR class on this object.
-.PP
-Additional methods only supported for extension objects are described in
-the \f(CW\*(C`urxvt::extension\*(C'\fR section below.
-.SS "Hooks"
-.IX Subsection "Hooks"
-The following subroutines can be declared in extension files, and will be
-called whenever the relevant event happens.
-.PP
-The first argument passed to them is an extension object as described in
-the in the \f(CW\*(C`Extension Objects\*(C'\fR section.
-.PP
-\&\fBAll\fR of these hooks must return a boolean value. If any of the called
-hooks returns true, then the event counts as being \fIconsumed\fR, and the
-relevant action might not be carried out by the \*(C+ code.
-.PP
-\&\fIWhen in doubt, return a false value (preferably \f(CI\*(C`()\*(C'\fI).\fR
-.ie n .IP "on_init $term" 4
-.el .IP "on_init \f(CW$term\fR" 4
-.IX Item "on_init $term"
-Called after a new terminal object has been initialized, but before
-windows are created or the command gets run. Most methods are unsafe to
-call or deliver senseless data, as terminal size and other characteristics
-have not yet been determined. You can safely query and change resources
-and options, though. For many purposes the \f(CW\*(C`on_start\*(C'\fR hook is a better
-place.
-.ie n .IP "on_start $term" 4
-.el .IP "on_start \f(CW$term\fR" 4
-.IX Item "on_start $term"
-Called at the very end of initialisation of a new terminal, just before
-trying to map (display) the toplevel and returning to the main loop.
-.ie n .IP "on_destroy $term" 4
-.el .IP "on_destroy \f(CW$term\fR" 4
-.IX Item "on_destroy $term"
-Called whenever something tries to destroy terminal, when the terminal is
-still fully functional (not for long, though).
-.ie n .IP "on_reset $term" 4
-.el .IP "on_reset \f(CW$term\fR" 4
-.IX Item "on_reset $term"
-Called after the screen is \*(L"reset\*(R" for any reason, such as resizing or
-control sequences. Here is where you can react on changes to size-related
-variables.
-.ie n .IP "on_child_start $term, $pid" 4
-.el .IP "on_child_start \f(CW$term\fR, \f(CW$pid\fR" 4
-.IX Item "on_child_start $term, $pid"
-Called just after the child process has been \f(CW\*(C`fork\*(C'\fRed.
-.ie n .IP "on_child_exit $term, $status" 4
-.el .IP "on_child_exit \f(CW$term\fR, \f(CW$status\fR" 4
-.IX Item "on_child_exit $term, $status"
-Called just after the child process has exited. \f(CW$status\fR is the status
-from \f(CW\*(C`waitpid\*(C'\fR.
-.ie n .IP "on_sel_make $term, $eventtime" 4
-.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4
-.IX Item "on_sel_make $term, $eventtime"
-Called whenever a selection has been made by the user, but before the
-selection text is copied, so changes to the beginning, end or type of the
-selection will be honored.
-.Sp
-Returning a true value aborts selection making by urxvt, in which case you
-have to make a selection yourself by calling \f(CW\*(C`$term\->selection_grab\*(C'\fR.
-.ie n .IP "on_sel_grab $term, $eventtime" 4
-.el .IP "on_sel_grab \f(CW$term\fR, \f(CW$eventtime\fR" 4
-.IX Item "on_sel_grab $term, $eventtime"
-Called whenever a selection has been copied, but before the selection is
-requested from the server. The selection text can be queried and changed
-by calling \f(CW\*(C`$term\->selection\*(C'\fR.
-.Sp
-Returning a true value aborts selection grabbing. It will still be highlighted.
-.ie n .IP "on_sel_extend $term" 4
-.el .IP "on_sel_extend \f(CW$term\fR" 4
-.IX Item "on_sel_extend $term"
-Called whenever the user tries to extend the selection (e.g. with a double
-click) and is either supposed to return false (normal operation), or
-should extend the selection itself and return true to suppress the built-in
-processing. This can happen multiple times, as long as the callback
-returns true, it will be called on every further click by the user and is
-supposed to enlarge the selection more and more, if possible.
-.Sp
-See the \fIselection\fR example extension.
-.ie n .IP "on_view_change $term, $offset" 4
-.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4
-.IX Item "on_view_change $term, $offset"
-Called whenever the view offset changes, i.e. the user or program
-scrolls. Offset \f(CW0\fR means display the normal terminal, positive values
-show this many lines of scrollback.
-.ie n .IP "on_scroll_back $term, $lines, $saved" 4
-.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4
-.IX Item "on_scroll_back $term, $lines, $saved"
-Called whenever lines scroll out of the terminal area into the scrollback
-buffer. \f(CW$lines\fR is the number of lines scrolled out and may be larger
-than the scroll back buffer or the terminal.
-.Sp
-It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1,
-\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total
-number of lines that will be in the scrollback buffer.
-.ie n .IP "on_osc_seq $term, $op, $args, $resp" 4
-.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp\fR" 4
-.IX Item "on_osc_seq $term, $op, $args, $resp"
-Called on every \s-1OSC\s0 sequence and can be used to suppress it or modify its
-behaviour. The default should be to return an empty list. A true value
-suppresses execution of the request completely. Make sure you don't get
-confused by recursive invocations when you output an \s-1OSC\s0 sequence within
-this callback.
-.Sp
-\&\f(CW\*(C`on_osc_seq_perl\*(C'\fR should be used for new behaviour.
-.ie n .IP "on_osc_seq_perl $term, $args, $resp" 4
-.el .IP "on_osc_seq_perl \f(CW$term\fR, \f(CW$args\fR, \f(CW$resp\fR" 4
-.IX Item "on_osc_seq_perl $term, $args, $resp"
-Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 =
-operating system command) is processed. Cursor position and other state
-information is up-to-date when this happens. For interoperability, the
-string should start with the extension name (sans \-osc) and a semicolon,
-to distinguish it from commands for other extensions, and this might be
-enforced in the future.
-.Sp
-For example, \f(CW\*(C`overlay\-osc\*(C'\fR uses this:
-.Sp
-.Vb 2
-\& sub on_osc_seq_perl {
-\& my ($self, $osc, $resp) = @_;
-\&
-\& return unless $osc =~ s/^overlay;//;
-\&
-\& ... process remaining $osc string
-\& }
-.Ve
-.Sp
-Be careful not ever to trust (in a security sense) the data you receive,
-as its source can not easily be controlled (e\-mail content, messages from
-other users on the same system etc.).
-.Sp
-For responses, \f(CW$resp\fR contains the end-of-args separator used by the
-sender.
-.ie n .IP "on_add_lines $term, $string" 4
-.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4
-.IX Item "on_add_lines $term, $string"
-Called whenever text is about to be output, with the text as argument. You
-can filter/change and output the text yourself by returning a true value
-and calling \f(CW\*(C`$term\->scr_add_lines\*(C'\fR yourself. Please note that this
-might be very slow, however, as your hook is called for \fBall\fR text being
-output.
-.ie n .IP "on_tt_write $term, $octets" 4
-.el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4
-.IX Item "on_tt_write $term, $octets"
-Called whenever some data is written to the tty/pty and can be used to
-suppress or filter tty input.
-.ie n .IP "on_tt_paste $term, $octets" 4
-.el .IP "on_tt_paste \f(CW$term\fR, \f(CW$octets\fR" 4
-.IX Item "on_tt_paste $term, $octets"
-Called whenever text is about to be pasted, with the text as argument. You
-can filter/change and paste the text yourself by returning a true value
-and calling \f(CW\*(C`$term\->tt_paste\*(C'\fR yourself. \f(CW$octets\fR is
-locale-encoded.
-.ie n .IP "on_line_update $term, $row" 4
-.el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4
-.IX Item "on_line_update $term, $row"
-Called whenever a line was updated or changed. Can be used to filter
-screen output (e.g. underline urls or other useless stuff). Only lines
-that are being shown will be filtered, and, due to performance reasons,
-not always immediately.
-.Sp
-The row number is always the topmost row of the line if the line spans
-multiple rows.
-.Sp
-Please note that, if you change the line, then the hook might get called
-later with the already-modified line (e.g. if unrelated parts change), so
-you cannot just toggle rendition bits, but only set them.
-.ie n .IP "on_refresh_begin $term" 4
-.el .IP "on_refresh_begin \f(CW$term\fR" 4
-.IX Item "on_refresh_begin $term"
-Called just before the screen gets redrawn. Can be used for overlay or
-similar effects by modifying the terminal contents in refresh_begin, and
-restoring them in refresh_end. The built-in overlay and selection display
-code is run after this hook, and takes precedence.
-.ie n .IP "on_refresh_end $term" 4
-.el .IP "on_refresh_end \f(CW$term\fR" 4
-.IX Item "on_refresh_end $term"
-Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR.
-.ie n .IP "on_user_command $term, $string" 4
-.el .IP "on_user_command \f(CW$term\fR, \f(CW$string\fR" 4
-.IX Item "on_user_command $term, $string"
-Called whenever a user-configured event is being activated (e.g. via
-a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR
-resource in the @@RXVT_NAME@@(1) manpage).
-.Sp
-The event is simply the action string. This interface is assumed to change
-slightly in the future.
-.ie n .IP "on_register_command $term, $keysym, $modifiermask, $string" 4
-.el .IP "on_register_command \f(CW$term\fR, \f(CW$keysym\fR, \f(CW$modifiermask\fR, \f(CW$string\fR" 4
-.IX Item "on_register_command $term, $keysym, $modifiermask, $string"
-Called after parsing a keysym resource but before registering the
-associated binding. If this hook returns \s-1TRUE\s0 the binding is not
-registered. It can be used to modify a binding by calling
-\&\f(CW\*(C`register_command\*(C'\fR.
-.ie n .IP "on_resize_all_windows $term, $new_width, $new_height" 4
-.el .IP "on_resize_all_windows \f(CW$term\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4
-.IX Item "on_resize_all_windows $term, $new_width, $new_height"
-Called just after the new window size has been calculated, but before
-windows are actually being resized or hints are being set. If this hook
-returns \s-1TRUE\s0, setting of the window hints is being skipped.
-.ie n .IP "on_x_event $term, $event" 4
-.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_x_event $term, $event"
-Called on every X event received on the vt window (and possibly other
-windows). Should only be used as a last resort. Most event structure
-members are not passed.
-.ie n .IP "on_root_event $term, $event" 4
-.el .IP "on_root_event \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_root_event $term, $event"
-Like \f(CW\*(C`on_x_event\*(C'\fR, but is called for events on the root window.
-.ie n .IP "on_focus_in $term" 4
-.el .IP "on_focus_in \f(CW$term\fR" 4
-.IX Item "on_focus_in $term"
-Called whenever the window gets the keyboard focus, before rxvt-unicode
-does focus in processing.
-.ie n .IP "on_focus_out $term" 4
-.el .IP "on_focus_out \f(CW$term\fR" 4
-.IX Item "on_focus_out $term"
-Called whenever the window loses keyboard focus, before rxvt-unicode does
-focus out processing.
-.ie n .IP "on_configure_notify $term, $event" 4
-.el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_configure_notify $term, $event"
-.PD 0
-.ie n .IP "on_property_notify $term, $event" 4
-.el .IP "on_property_notify \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_property_notify $term, $event"
-.ie n .IP "on_key_press $term, $event, $keysym, $octets" 4
-.el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4
-.IX Item "on_key_press $term, $event, $keysym, $octets"
-.ie n .IP "on_key_release $term, $event, $keysym" 4
-.el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4
-.IX Item "on_key_release $term, $event, $keysym"
-.ie n .IP "on_button_press $term, $event" 4
-.el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_button_press $term, $event"
-.ie n .IP "on_button_release $term, $event" 4
-.el .IP "on_button_release \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_button_release $term, $event"
-.ie n .IP "on_motion_notify $term, $event" 4
-.el .IP "on_motion_notify \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_motion_notify $term, $event"
-.ie n .IP "on_map_notify $term, $event" 4
-.el .IP "on_map_notify \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_map_notify $term, $event"
-.ie n .IP "on_unmap_notify $term, $event" 4
-.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_unmap_notify $term, $event"
-.PD
-Called whenever the corresponding X event is received for the terminal. If
-the hook returns true, then the event will be ignored by rxvt-unicode.
-.Sp
-The event is a hash with most values as named by Xlib (see the XEvent
-manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the
-(real, not screen-based) row and column under the mouse cursor.
-.Sp
-\&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would
-output, if any, in locale-specific encoding.
-.Sp
-subwindow.
-.ie n .IP "on_client_message $term, $event" 4
-.el .IP "on_client_message \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_client_message $term, $event"
-.PD 0
-.ie n .IP "on_wm_protocols $term, $event" 4
-.el .IP "on_wm_protocols \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_wm_protocols $term, $event"
-.ie n .IP "on_wm_delete_window $term, $event" 4
-.el .IP "on_wm_delete_window \f(CW$term\fR, \f(CW$event\fR" 4
-.IX Item "on_wm_delete_window $term, $event"
-.PD
-Called when various types of ClientMessage events are received (all with
-format=32, \s-1WM_PROTOCOLS\s0 or \s-1WM_PROTOCOLS:WM_DELETE_WINDOW\s0).
-.ie n .IP "on_bell $term" 4
-.el .IP "on_bell \f(CW$term\fR" 4
-.IX Item "on_bell $term"
-Called on receipt of a bell character.
-.ie n .SS "Variables in the ""urxvt"" Package"
-.el .SS "Variables in the \f(CWurxvt\fP Package"
-.IX Subsection "Variables in the urxvt Package"
-.ie n .IP "$urxvt::LIBDIR" 4
-.el .IP "\f(CW$urxvt::LIBDIR\fR" 4
-.IX Item "$urxvt::LIBDIR"
-The rxvt-unicode library directory, where, among other things, the perl
-modules and scripts are stored.
-.ie n .IP "$urxvt::RESCLASS, $urxvt::RESCLASS" 4
-.el .IP "\f(CW$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS\fR" 4
-.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS"
-The resource class and name rxvt-unicode uses to look up X resources.
-.ie n .IP "$urxvt::RXVTNAME" 4
-.el .IP "\f(CW$urxvt::RXVTNAME\fR" 4
-.IX Item "$urxvt::RXVTNAME"
-The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR.
-.ie n .IP "$urxvt::TERM" 4
-.el .IP "\f(CW$urxvt::TERM\fR" 4
-.IX Item "$urxvt::TERM"
-The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR
-object, whenever a callback/hook is executing.
-.ie n .IP "@urxvt::TERM_INIT" 4
-.el .IP "\f(CW@urxvt::TERM_INIT\fR" 4
-.IX Item "@urxvt::TERM_INIT"
-All code references in this array will be called as methods of the next newly
-created \f(CW\*(C`urxvt::term\*(C'\fR object (during the \f(CW\*(C`on_init\*(C'\fR phase). The array
-gets cleared before the code references that were in it are being executed,
-so references can push themselves onto it again if they so desire.
-.Sp
-This complements to the perl-eval command line option, but gets executed
-first.
-.ie n .IP "@urxvt::TERM_EXT" 4
-.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4
-.IX Item "@urxvt::TERM_EXT"
-Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which
-get registered as normal extensions after calling the hooks in \f(CW@TERM_INIT\fR
-but before other extensions. Gets cleared just like \f(CW@TERM_INIT\fR.
-.ie n .SS "Functions in the ""urxvt"" Package"
-.el .SS "Functions in the \f(CWurxvt\fP Package"
-.IX Subsection "Functions in the urxvt Package"
-.ie n .IP "urxvt::fatal $errormessage" 4
-.el .IP "urxvt::fatal \f(CW$errormessage\fR" 4
-.IX Item "urxvt::fatal $errormessage"
-Fatally aborts execution with the given error message (which should
-include a trailing newline). Avoid at all costs! The only time this
-is acceptable (and useful) is in the init hook, where it prevents the
-terminal from starting up.
-.ie n .IP "urxvt::warn $string" 4
-.el .IP "urxvt::warn \f(CW$string\fR" 4
-.IX Item "urxvt::warn $string"
-Calls \f(CW\*(C`rxvt_warn\*(C'\fR with the given string which should include a trailing
-newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function
-that calls this function.
-.Sp
-Using this function has the advantage that its output ends up in the
-correct place, e.g. on stderr of the connecting urxvtc client.
-.Sp
-Messages have a size limit of 1023 bytes currently.
-.ie n .IP "@terms = urxvt::termlist" 4
-.el .IP "\f(CW@terms\fR = urxvt::termlist" 4
-.IX Item "@terms = urxvt::termlist"
-Returns all urxvt::term objects that exist in this process, regardless of
-whether they are started, being destroyed etc., so be careful. Only term
-objects that have perl extensions attached will be returned (because there
-is no urxvt::term object associated with others).
-.ie n .IP "$time = urxvt::NOW" 4
-.el .IP "\f(CW$time\fR = urxvt::NOW" 4
-.IX Item "$time = urxvt::NOW"
-Returns the \*(L"current time\*(R" (as per the event loop).
-.IP "urxvt::CurrentTime" 4
-.IX Item "urxvt::CurrentTime"
-.PD 0
-.IP "urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask, AnyModifier" 4
-.IX Item "urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask, AnyModifier"
-.IP "urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask" 4
-.IX Item "urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask"
-.IP "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify" 4
-.IX Item "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify"
-.PD
-Various constants for use in X calls and event processing.
-.SS "\s-1RENDITION\s0"
-.IX Subsection "RENDITION"
-Rendition bitsets contain information about colour, font, font styles and
-similar information for each screen cell.
-.PP
-The following \*(L"macros\*(R" deal with changes in rendition sets. You should
-never just create a bitset, you should always modify an existing one,
-as they contain important information required for correct operation of
-rxvt-unicode.
-.ie n .IP "$rend = urxvt::DEFAULT_RSTYLE" 4
-.el .IP "\f(CW$rend\fR = urxvt::DEFAULT_RSTYLE" 4
-.IX Item "$rend = urxvt::DEFAULT_RSTYLE"
-Returns the default rendition, as used when the terminal is starting up or
-being reset. Useful as a base to start when creating renditions.
-.ie n .IP "$rend = urxvt::OVERLAY_RSTYLE" 4
-.el .IP "\f(CW$rend\fR = urxvt::OVERLAY_RSTYLE" 4
-.IX Item "$rend = urxvt::OVERLAY_RSTYLE"
-Return the rendition mask used for overlays by default.
-.ie n .IP "$rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, urxvt::RS_RVid, urxvt::RS_Uline" 4
-.el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, urxvt::RS_RVid, urxvt::RS_Uline" 4
-.IX Item "$rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, urxvt::RS_RVid, urxvt::RS_Uline"
-Return the bit that enabled bold, italic, blink, reverse-video and
-underline, respectively. To enable such a style, just logically \s-1OR\s0 it into
-the bitset.
-.ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4
-.el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4
-.IX Item "$foreground = urxvt::GET_BASEFG $rend"
-.PD 0
-.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4
-.el .IP "\f(CW$background\fR = urxvt::GET_BASEBG \f(CW$rend\fR" 4
-.IX Item "$background = urxvt::GET_BASEBG $rend"
-.PD
-Return the foreground/background colour index, respectively.
-.ie n .IP "$rend = urxvt::SET_FGCOLOR $rend, $new_colour" 4
-.el .IP "\f(CW$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
-.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour"
-.PD 0
-.ie n .IP "$rend = urxvt::SET_BGCOLOR $rend, $new_colour" 4
-.el .IP "\f(CW$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
-.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour"
-.ie n .IP "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg" 4
-.el .IP "\f(CW$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4
-.IX Item "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg"
-.PD
-Replace the foreground/background colour in the rendition mask with the
-specified one.
-.ie n .IP "$value = urxvt::GET_CUSTOM $rend" 4
-.el .IP "\f(CW$value\fR = urxvt::GET_CUSTOM \f(CW$rend\fR" 4
-.IX Item "$value = urxvt::GET_CUSTOM $rend"
-Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by
-extensions. They can be set and changed as you like and are initially
-zero.
-.ie n .IP "$rend = urxvt::SET_CUSTOM $rend, $new_value" 4
-.el .IP "\f(CW$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4
-.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value"
-Change the custom value.
-.ie n .SS "The ""urxvt::term::extension"" class"
-.el .SS "The \f(CWurxvt::term::extension\fP class"
-.IX Subsection "The urxvt::term::extension class"
-Each extension attached to a terminal object is represented by
-a \f(CW\*(C`urxvt::term::extension\*(C'\fR object.
-.PP
-You can use these objects, which are passed to all callbacks to store any
-state related to the terminal and extension instance.
-.PP
-The methods (And data members) documented below can be called on extension
-objects, in addition to call methods documented for the
-class.
-.ie n .IP "$urxvt_term = $self\->{term}" 4
-.el .IP "\f(CW$urxvt_term\fR = \f(CW$self\fR\->{term}" 4
-.IX Item "$urxvt_term = $self->{term}"
-Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the
-extension. This member \fImust not\fR be changed in any way.
-.ie n .IP "$self\->enable ($hook_name => $cb[, $hook_name => $cb..])" 4
-.el .IP "\f(CW$self\fR\->enable ($hook_name => \f(CW$cb\fR[, \f(CW$hook_name\fR => \f(CW$cb\fR..])" 4
-.IX Item "$self->enable ($hook_name => $cb[, $hook_name => $cb..])"
-Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for
-this extension, replacing any previous hook. This is useful when you want
-to overwrite time-critical hooks only temporarily.
-.Sp
-To install additional callbacks for the same hook, you can use the \f(CW\*(C`on\*(C'\fR
-method of the \f(CW\*(C`urxvt::term\*(C'\fR class.
-.ie n .IP "$self\->disable ($hook_name[, $hook_name..])" 4
-.el .IP "\f(CW$self\fR\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4
-.IX Item "$self->disable ($hook_name[, $hook_name..])"
-Dynamically disable the given hooks.
-.ie n .IP "$guard = $self\->on ($hook_name => $cb[, $hook_name => $cb..])" 4
-.el .IP "\f(CW$guard\fR = \f(CW$self\fR\->on ($hook_name => \f(CW$cb\fR[, \f(CW$hook_name\fR => \f(CW$cb\fR..])" 4
-.IX Item "$guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])"
-Similar to the \f(CW\*(C`enable\*(C'\fR enable, but installs additional callbacks for
-the given hook(s) (that is, it doesn't replace existing callbacks), and
-returns a guard object. When the guard object is destroyed the callbacks
-are disabled again.
-.ie n .IP "$self\->x_resource ($pattern)" 4
-.el .IP "\f(CW$self\fR\->x_resource ($pattern)" 4
-.IX Item "$self->x_resource ($pattern)"
-.PD 0
-.ie n .IP "$self\->x_resource_boolean ($pattern)" 4
-.el .IP "\f(CW$self\fR\->x_resource_boolean ($pattern)" 4
-.IX Item "$self->x_resource_boolean ($pattern)"
-.PD
-These methods support an additional \f(CW\*(C`%\*(C'\fR prefix when called on an
-extension object \- see the description of these methods in the
-\&\f(CW\*(C`urxvt::term\*(C'\fR class for details.
-.ie n .SS "The ""urxvt::anyevent"" Class"
-.el .SS "The \f(CWurxvt::anyevent\fP Class"
-.IX Subsection "The urxvt::anyevent Class"
-The sole purpose of this class is to deliver an interface to the
-\&\f(CW\*(C`AnyEvent\*(C'\fR module \- any module using it will work inside urxvt without
-further programming. The only exception is that you cannot wait on
-condition variables, but non-blocking condvar use is ok.
-.PP
-In practical terms this means is that you cannot use blocking APIs, but
-the non-blocking variant should work.
-.ie n .SS "The ""urxvt::term"" Class"
-.el .SS "The \f(CWurxvt::term\fP Class"
-.IX Subsection "The urxvt::term Class"
-.ie n .IP "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" 4
-.el .IP "\f(CW$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4
-.IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]"
-Creates a new terminal, very similar as if you had started it with system
-\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like
-hash which defines the environment of the new terminal.
-.Sp
-Croaks (and probably outputs an error message) if the new instance
-couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't
-initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and
-\&\f(CW\*(C`start\*(C'\fR hooks will be called before this call returns, and are free to
-refer to global data (which is race free).
-.ie n .IP "$term\->destroy" 4
-.el .IP "\f(CW$term\fR\->destroy" 4
-.IX Item "$term->destroy"
-Destroy the terminal object (close the window, free resources
-etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
-watchers (timers, io watchers) are still active.
-.ie n .IP "$term\->exec_async ($cmd[, @args])" 4
-.el .IP "\f(CW$term\fR\->exec_async ($cmd[, \f(CW@args\fR])" 4
-.IX Item "$term->exec_async ($cmd[, @args])"
-Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes
-(\*(L"starts\*(R") programs in the background. This function takes care of setting
-the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) and should
-be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR.
-.Sp
-Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error.
-.ie n .IP "$isset = $term\->option ($optval[, $set])" 4
-.el .IP "\f(CW$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4
-.IX Item "$isset = $term->option ($optval[, $set])"
-Returns true if the option specified by \f(CW$optval\fR is enabled, and
-optionally change it. All option values are stored by name in the hash
-\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash.
-.Sp
-Here is a likely non-exhaustive list of option names, please see the
-source file \fI/src/optinc.h\fR to see the actual list:
-.Sp
-.Vb 7
-\& borderLess buffered console cursorBlink cursorUnderline hold iconic
-\& insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
-\& mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
-\& pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
-\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
-\& secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
-\& urgentOnBell utmpInhibit visualBell
-.Ve
-.ie n .IP "$value = $term\->resource ($name[, $newval])" 4
-.el .IP "\f(CW$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4
-.IX Item "$value = $term->resource ($name[, $newval])"
-Returns the current resource value associated with a given name and
-optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR
-hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR.
-.Sp
-The new value must be properly encoded to a suitable character encoding
-before passing it to this method. Similarly, the returned value may need
-to be converted from the used encoding to text.
-.Sp
-Resource names are as defined in \fIsrc/rsinc.h\fR. Colours can be specified
-as resource names of the form \f(CW\*(C`color+\*(C'\fR, e.g. \f(CW\*(C`color+5\*(C'\fR. (will
-likely change).
-.Sp
-Please note that resource strings will currently only be freed when the
-terminal is destroyed, so changing options frequently will eat memory.
-.Sp
-Here is a likely non-exhaustive list of resource names, not all of which
-are supported in every build, please see the source file \fI/src/rsinc.h\fR
-to see the actual list:
-.Sp
-.Vb 10
-\& answerbackstring backgroundPixmap backspace_key blurradius
-\& boldFont boldItalicFont borderLess buffered chdir color cursorBlink
-\& cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
-\& fade font geometry hold iconName iconfile imFont imLocale inputMethod
-\& insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
-\& jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
-\& mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
-\& perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
-\& preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
-\& scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
-\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
-\& secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
-\& term_name title transient_for transparent tripleclickwords urgentOnBell
-\& utmpInhibit visualBell
-.Ve
-.ie n .IP "$value = $term\->x_resource ($pattern)" 4
-.el .IP "\f(CW$value\fR = \f(CW$term\fR\->x_resource ($pattern)" 4
-.IX Item "$value = $term->x_resource ($pattern)"
-Returns the X\-Resource for the given pattern, excluding the program or
-class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the
-same value as used by this instance of rxvt-unicode. Returns \f(CW\*(C`undef\*(C'\fR if no
-resource with that pattern exists.
-.Sp
-Extensions that define extra resource or command line arguments also need
-to call this method to access their values.
-.Sp
-If the method is called on an extension object (basically, from an
-extension), then the special prefix \f(CW\*(C`%.\*(C'\fR will be replaced by the name of
-the extension and a dot, and the lone string \f(CW\*(C`%\*(C'\fR will be replaced by the
-extension name itself. This makes it possible to code extensions so you
-can rename them and get a new set of commandline switches and resources
-without having to change the actual code.
-.Sp
-This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is
-only one resource database per display, and later invocations might return
-the wrong resources.
-.ie n .IP "$value = $term\->x_resource_boolean ($pattern)" 4
-.el .IP "\f(CW$value\fR = \f(CW$term\fR\->x_resource_boolean ($pattern)" 4
-.IX Item "$value = $term->x_resource_boolean ($pattern)"
-Like \f(CW\*(C`x_resource\*(C'\fR, above, but interprets the string value as a boolean
-and returns \f(CW1\fR for true values, \f(CW0\fR for false values and \f(CW\*(C`undef\*(C'\fR if
-the resource or option isn't specified.
-.Sp
-You should always use this method to parse boolean resources.
-.ie n .IP "$success = $term\->parse_keysym ($key, $octets)" 4
-.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($key, \f(CW$octets\fR)" 4
-.IX Item "$success = $term->parse_keysym ($key, $octets)"
-Adds a key binding exactly as specified via a resource. See the
-\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage.
-.ie n .IP "$term\->register_command ($keysym, $modifiermask, $string)" 4
-.el .IP "\f(CW$term\fR\->register_command ($keysym, \f(CW$modifiermask\fR, \f(CW$string\fR)" 4
-.IX Item "$term->register_command ($keysym, $modifiermask, $string)"
-Adds a key binding. This is a lower level api compared to
-\&\f(CW\*(C`parse_keysym\*(C'\fR, as it expects a parsed key description, and can be
-used only inside either the \f(CW\*(C`on_init\*(C'\fR hook, to add a binding, or the
-\&\f(CW\*(C`on_register_command\*(C'\fR hook, to modify a parsed binding.
-.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4
-.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4
-.IX Item "$rend = $term->rstyle ([$new_rstyle])"
-Return and optionally change the current rendition. Text that is output by
-the terminal application will use this style.
-.ie n .IP "($row, $col) = $term\->screen_cur ([$row, $col])" 4
-.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col\fR])" 4
-.IX Item "($row, $col) = $term->screen_cur ([$row, $col])"
-Return the current coordinates of the text cursor position and optionally
-set it (which is usually bad as applications don't expect that).
-.ie n .IP "($row, $col) = $term\->selection_mark ([$row, $col])" 4
-.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col\fR])" 4
-.IX Item "($row, $col) = $term->selection_mark ([$row, $col])"
-.PD 0
-.ie n .IP "($row, $col) = $term\->selection_beg ([$row, $col])" 4
-.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col\fR])" 4
-.IX Item "($row, $col) = $term->selection_beg ([$row, $col])"
-.ie n .IP "($row, $col) = $term\->selection_end ([$row, $col])" 4
-.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4
-.IX Item "($row, $col) = $term->selection_end ([$row, $col])"
-.PD
-Return the current values of the selection mark, begin or end positions.
-.Sp
-When arguments are given, then the selection coordinates are set to
-\&\f(CW$row\fR and \f(CW$col\fR, and the selection screen is set to the current
-screen.
-.ie n .IP "$screen = $term\->selection_screen ([$screen])" 4
-.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->selection_screen ([$screen])" 4
-.IX Item "$screen = $term->selection_screen ([$screen])"
-Returns the current selection screen, and then optionally sets it.
-.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4
-.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4
-.IX Item "$term->selection_make ($eventtime[, $rectangular])"
-Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and
-\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a
-rectangular selection will be made. This is the preferred function to make
-a selection.
-.ie n .IP "$success = $term\->selection_grab ($eventtime[, $clipboard])" 4
-.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime[, \f(CW$clipboard\fR])" 4
-.IX Item "$success = $term->selection_grab ($eventtime[, $clipboard])"
-Try to acquire ownership of the primary (clipboard if \f(CW$clipboard\fR is
-true) selection from the server. The corresponding text can be set
-with the next method. No visual feedback will be given. This function
-is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks.
-.ie n .IP "$oldtext = $term\->selection ([$newtext, $clipboard])" 4
-.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext, \f(CW$clipboard\fR])" 4
-.IX Item "$oldtext = $term->selection ([$newtext, $clipboard])"
-Return the current selection (clipboard if \f(CW$clipboard\fR is true) text
-and optionally replace it by \f(CW$newtext\fR.
-.ie n .IP "$term\->selection_clear ([$clipboard])" 4
-.el .IP "\f(CW$term\fR\->selection_clear ([$clipboard])" 4
-.IX Item "$term->selection_clear ([$clipboard])"
-Revoke ownership of the primary (clipboard if \f(CW$clipboard\fR is true) selection.
-.ie n .IP "$term\->overlay_simple ($x, $y, $text)" 4
-.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4
-.IX Item "$term->overlay_simple ($x, $y, $text)"
-Create a simple multi-line overlay box. See the next method for details.
-.ie n .IP "$term\->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" 4
-.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
-.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])"
-Create a new (empty) overlay at the given position with the given
-width/height. \f(CW$rstyle\fR defines the initial rendition style
-(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR).
-.Sp
-If \f(CW$border\fR is \f(CW2\fR (default), then a decorative border will be put
-around the box.
-.Sp
-If either \f(CW$x\fR or \f(CW$y\fR is negative, then this is counted from the
-right/bottom side, respectively.
-.Sp
-This method returns an urxvt::overlay object. The overlay will be visible
-as long as the perl object is referenced.
-.Sp
-The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are:
-.RS 4
-.ie n .IP "$overlay\->set ($x, $y, $text[, $rend])" 4
-.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend\fR])" 4
-.IX Item "$overlay->set ($x, $y, $text[, $rend])"
-Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts
-text in rxvt-unicode's special encoding and an array of rendition values
-at a specific position inside the overlay.
-.Sp
-If \f(CW$rend\fR is missing, then the rendition will not be changed.
-.ie n .IP "$overlay\->hide" 4
-.el .IP "\f(CW$overlay\fR\->hide" 4
-.IX Item "$overlay->hide"
-If visible, hide the overlay, but do not destroy it.
-.ie n .IP "$overlay\->show" 4
-.el .IP "\f(CW$overlay\fR\->show" 4
-.IX Item "$overlay->show"
-If hidden, display the overlay again.
-.RE
-.RS 4
-.RE
-.ie n .IP "$popup = $term\->popup ($event)" 4
-.el .IP "\f(CW$popup\fR = \f(CW$term\fR\->popup ($event)" 4
-.IX Item "$popup = $term->popup ($event)"
-Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The
-\&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event,
-currently).
-.ie n .IP "$cellwidth = $term\->strwidth ($string)" 4
-.el .IP "\f(CW$cellwidth\fR = \f(CW$term\fR\->strwidth ($string)" 4
-.IX Item "$cellwidth = $term->strwidth ($string)"
-Returns the number of screen-cells this string would need. Correctly
-accounts for wide and combining characters.
-.ie n .IP "$octets = $term\->locale_encode ($string)" 4
-.el .IP "\f(CW$octets\fR = \f(CW$term\fR\->locale_encode ($string)" 4
-.IX Item "$octets = $term->locale_encode ($string)"
-Convert the given text string into the corresponding locale encoding.
-.ie n .IP "$string = $term\->locale_decode ($octets)" 4
-.el .IP "\f(CW$string\fR = \f(CW$term\fR\->locale_decode ($octets)" 4
-.IX Item "$string = $term->locale_decode ($octets)"
-Convert the given locale-encoded octets into a perl string.
-.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" 4
-.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
-.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])"
-XORs the rendition values in the given span with the provided value
-(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in
-refresh hooks to provide effects similar to the selection.
-.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" 4
-.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
-.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])"
-Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing
-whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults
-to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines
-it instead. Both styles \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles.
-.ie n .IP "$term\->scr_bell" 4
-.el .IP "\f(CW$term\fR\->scr_bell" 4
-.IX Item "$term->scr_bell"
-Ring the bell!
-.ie n .IP "$term\->scr_add_lines ($string)" 4
-.el .IP "\f(CW$term\fR\->scr_add_lines ($string)" 4
-.IX Item "$term->scr_add_lines ($string)"
-Write the given text string to the screen, as if output by the application
-running inside the terminal. It may not contain command sequences (escape
-codes), but is free to use line feeds, carriage returns and tabs. The
-string is a normal text string, not in locale-dependent encoding.
-.Sp
-Normally its not a good idea to use this function, as programs might be
-confused by changes in cursor position or scrolling. Its useful inside a
-\&\f(CW\*(C`on_add_lines\*(C'\fR hook, though.
-.ie n .IP "$term\->scr_change_screen ($screen)" 4
-.el .IP "\f(CW$term\fR\->scr_change_screen ($screen)" 4
-.IX Item "$term->scr_change_screen ($screen)"
-Switch to given screen \- 0 primary, 1 secondary.
-.ie n .IP "$term\->cmd_parse ($octets)" 4
-.el .IP "\f(CW$term\fR\->cmd_parse ($octets)" 4
-.IX Item "$term->cmd_parse ($octets)"
-Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the
-locale-specific encoding of the terminal and can contain command sequences
-(escape codes) that will be interpreted.
-.ie n .IP "$term\->tt_write ($octets)" 4
-.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4
-.IX Item "$term->tt_write ($octets)"
-Write the octets given in \f(CW$octets\fR to the tty (i.e. as program input). To
-pass characters instead of octets, you should convert your strings first
-to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR.
-.ie n .IP "$term\->tt_paste ($octets)" 4
-.el .IP "\f(CW$term\fR\->tt_paste ($octets)" 4
-.IX Item "$term->tt_paste ($octets)"
-Write the octets given in \f(CW$octets\fR to the tty as a paste, converting \s-1NL\s0 to
-\&\s-1CR\s0 and bracketing the data with control sequences if bracketed paste mode
-is set.
-.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4
-.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4
-.IX Item "$old_events = $term->pty_ev_events ([$new_events])"
-Replaces the event mask of the pty watcher by the given event mask. Can
-be used to suppress input and output handling to the pty/tty. See the
-description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore
-the previous value.
-.ie n .IP "$fd = $term\->pty_fd" 4
-.el .IP "\f(CW$fd\fR = \f(CW$term\fR\->pty_fd" 4
-.IX Item "$fd = $term->pty_fd"
-Returns the master file descriptor for the pty in use, or \f(CW\*(C`\-1\*(C'\fR if no pty
-is used.
-.ie n .IP "$windowid = $term\->parent" 4
-.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->parent" 4
-.IX Item "$windowid = $term->parent"
-Return the window id of the toplevel window.
-.ie n .IP "$windowid = $term\->vt" 4
-.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->vt" 4
-.IX Item "$windowid = $term->vt"
-Return the window id of the terminal window.
-.ie n .IP "$term\->vt_emask_add ($x_event_mask)" 4
-.el .IP "\f(CW$term\fR\->vt_emask_add ($x_event_mask)" 4
-.IX Item "$term->vt_emask_add ($x_event_mask)"
-Adds the specified events to the vt event mask. Useful e.g. when you want
-to receive pointer events all the times:
-.Sp
-.Vb 1
-\& $term\->vt_emask_add (urxvt::PointerMotionMask);
-.Ve
-.ie n .IP "$term\->set_urgency ($set)" 4
-.el .IP "\f(CW$term\fR\->set_urgency ($set)" 4
-.IX Item "$term->set_urgency ($set)"
-Enable/disable the urgency hint on the toplevel window.
-.ie n .IP "$term\->focus_in" 4
-.el .IP "\f(CW$term\fR\->focus_in" 4
-.IX Item "$term->focus_in"
-.PD 0
-.ie n .IP "$term\->focus_out" 4
-.el .IP "\f(CW$term\fR\->focus_out" 4
-.IX Item "$term->focus_out"
-.ie n .IP "$term\->key_press ($state, $keycode[, $time])" 4
-.el .IP "\f(CW$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4
-.IX Item "$term->key_press ($state, $keycode[, $time])"
-.ie n .IP "$term\->key_release ($state, $keycode[, $time])" 4
-.el .IP "\f(CW$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4
-.IX Item "$term->key_release ($state, $keycode[, $time])"
-.PD
-Deliver various fake events to to terminal.
-.ie n .IP "$window_width = $term\->width" 4
-.el .IP "\f(CW$window_width\fR = \f(CW$term\fR\->width" 4
-.IX Item "$window_width = $term->width"
-.PD 0
-.ie n .IP "$window_height = $term\->height" 4
-.el .IP "\f(CW$window_height\fR = \f(CW$term\fR\->height" 4
-.IX Item "$window_height = $term->height"
-.ie n .IP "$font_width = $term\->fwidth" 4
-.el .IP "\f(CW$font_width\fR = \f(CW$term\fR\->fwidth" 4
-.IX Item "$font_width = $term->fwidth"
-.ie n .IP "$font_height = $term\->fheight" 4
-.el .IP "\f(CW$font_height\fR = \f(CW$term\fR\->fheight" 4
-.IX Item "$font_height = $term->fheight"
-.ie n .IP "$font_ascent = $term\->fbase" 4
-.el .IP "\f(CW$font_ascent\fR = \f(CW$term\fR\->fbase" 4
-.IX Item "$font_ascent = $term->fbase"
-.ie n .IP "$terminal_rows = $term\->nrow" 4
-.el .IP "\f(CW$terminal_rows\fR = \f(CW$term\fR\->nrow" 4
-.IX Item "$terminal_rows = $term->nrow"
-.ie n .IP "$terminal_columns = $term\->ncol" 4
-.el .IP "\f(CW$terminal_columns\fR = \f(CW$term\fR\->ncol" 4
-.IX Item "$terminal_columns = $term->ncol"
-.ie n .IP "$has_focus = $term\->focus" 4
-.el .IP "\f(CW$has_focus\fR = \f(CW$term\fR\->focus" 4
-.IX Item "$has_focus = $term->focus"
-.ie n .IP "$is_mapped = $term\->mapped" 4
-.el .IP "\f(CW$is_mapped\fR = \f(CW$term\fR\->mapped" 4
-.IX Item "$is_mapped = $term->mapped"
-.ie n .IP "$max_scrollback = $term\->saveLines" 4
-.el .IP "\f(CW$max_scrollback\fR = \f(CW$term\fR\->saveLines" 4
-.IX Item "$max_scrollback = $term->saveLines"
-.ie n .IP "$nrow_plus_saveLines = $term\->total_rows" 4
-.el .IP "\f(CW$nrow_plus_saveLines\fR = \f(CW$term\fR\->total_rows" 4
-.IX Item "$nrow_plus_saveLines = $term->total_rows"
-.ie n .IP "$topmost_scrollback_row = $term\->top_row" 4
-.el .IP "\f(CW$topmost_scrollback_row\fR = \f(CW$term\fR\->top_row" 4
-.IX Item "$topmost_scrollback_row = $term->top_row"
-.PD
-Return various integers describing terminal characteristics.
-.ie n .IP "$x_display = $term\->display_id" 4
-.el .IP "\f(CW$x_display\fR = \f(CW$term\fR\->display_id" 4
-.IX Item "$x_display = $term->display_id"
-Return the \s-1DISPLAY\s0 used by rxvt-unicode.
-.ie n .IP "$lc_ctype = $term\->locale" 4
-.el .IP "\f(CW$lc_ctype\fR = \f(CW$term\fR\->locale" 4
-.IX Item "$lc_ctype = $term->locale"
-Returns the \s-1LC_CTYPE\s0 category string used by this rxvt-unicode.
-.ie n .IP "$env = $term\->env" 4
-.el .IP "\f(CW$env\fR = \f(CW$term\fR\->env" 4
-.IX Item "$env = $term->env"
-Returns a copy of the environment in effect for the terminal as a hashref
-similar to \f(CW\*(C`\e%ENV\*(C'\fR.
-.ie n .IP "@envv = $term\->envv" 4
-.el .IP "\f(CW@envv\fR = \f(CW$term\fR\->envv" 4
-.IX Item "@envv = $term->envv"
-Returns the environment as array of strings of the form \f(CW\*(C`VAR=VALUE\*(C'\fR.
-.ie n .IP "@argv = $term\->argv" 4
-.el .IP "\f(CW@argv\fR = \f(CW$term\fR\->argv" 4
-.IX Item "@argv = $term->argv"
-Return the argument vector as this terminal, similar to \f(CW@ARGV\fR, but
-includes the program name as first element.
-.ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4
-.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModLevel3Mask" 4
-.IX Item "$modifiermask = $term->ModLevel3Mask"
-.PD 0
-.ie n .IP "$modifiermask = $term\->ModMetaMask" 4
-.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModMetaMask" 4
-.IX Item "$modifiermask = $term->ModMetaMask"
-.ie n .IP "$modifiermask = $term\->ModNumLockMask" 4
-.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModNumLockMask" 4
-.IX Item "$modifiermask = $term->ModNumLockMask"
-.PD
-Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often
-AltGr), the meta key (often Alt) and the num lock key, if applicable.
-.ie n .IP "$screen = $term\->current_screen" 4
-.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->current_screen" 4
-.IX Item "$screen = $term->current_screen"
-Returns the currently displayed screen (0 primary, 1 secondary).
-.ie n .IP "$cursor_is_hidden = $term\->hidden_cursor" 4
-.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4
-.IX Item "$cursor_is_hidden = $term->hidden_cursor"
-Returns whether the cursor is currently hidden or not.
-.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4
-.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4
-.IX Item "$view_start = $term->view_start ([$newvalue])"
-Returns the row number of the topmost displayed line. Maximum value is
-\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll
-this many lines into the scrollback buffer.
-.ie n .IP "$term\->want_refresh" 4
-.el .IP "\f(CW$term\fR\->want_refresh" 4
-.IX Item "$term->want_refresh"
-Requests a screen refresh. At the next opportunity, rxvt-unicode will
-compare the on-screen display with its stored representation. If they
-differ, it redraws the differences.
-.Sp
-Used after changing terminal contents to display them.
-.ie n .IP "$text = $term\->ROW_t ($row_number[, $new_text[, $start_col]])" 4
-.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
-.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])"
-Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW\*(C`$term\->top_row\*(C'\fR
-is the topmost terminal line, row \f(CW\*(C`$term\->nrow\-1\*(C'\fR is the bottommost
-terminal line. Nothing will be returned if a nonexistent line
-is requested.
-.Sp
-If \f(CW$new_text\fR is specified, it will replace characters in the current
-line, starting at column \f(CW$start_col\fR (default \f(CW0\fR), which is useful
-to replace only parts of a line. The font index in the rendition will
-automatically be updated.
-.Sp
-\&\f(CW$text\fR is in a special encoding: tabs and wide characters that use more
-than one cell when displayed are padded with \f(CW$urxvt::NOCHAR\fR (chr 65535)
-characters. Characters with combining characters and other characters that
-do not fit into the normal text encoding will be replaced with characters
-in the private use area.
-.Sp
-You have to obey this encoding when changing text. The advantage is
-that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on
-characters.
-.Sp
-The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR
-can be used to convert normal strings into this encoding and vice versa.
-.ie n .IP "$rend = $term\->ROW_r ($row_number[, $new_rend[, $start_col]])" 4
-.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
-.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])"
-Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition
-bitsets. Rendition bitsets contain information about colour, font, font
-styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR.
-.Sp
-When setting rendition, the font mask will be ignored.
-.Sp
-See the section on \s-1RENDITION\s0, above.
-.ie n .IP "$length = $term\->ROW_l ($row_number[, $new_length])" 4
-.el .IP "\f(CW$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4
-.IX Item "$length = $term->ROW_l ($row_number[, $new_length])"
-Returns the number of screen cells that are in use (\*(L"the line
-length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the
-line is joined with the following one.
-.ie n .IP "$bool = $term\->is_longer ($row_number)" 4
-.el .IP "\f(CW$bool\fR = \f(CW$term\fR\->is_longer ($row_number)" 4
-.IX Item "$bool = $term->is_longer ($row_number)"
-Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e.
-joined with the following row), which means all characters are in use
-and it is continued on the next row (and possibly a continuation of the
-previous row(s)).
-.ie n .IP "$line = $term\->line ($row_number)" 4
-.el .IP "\f(CW$line\fR = \f(CW$term\fR\->line ($row_number)" 4
-.IX Item "$line = $term->line ($row_number)"
-Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information
-about the logical line that row \f(CW$row_number\fR is part of. It supports the
-following methods:
-.RS 4
-.ie n .IP "$text = $line\->t ([$new_text])" 4
-.el .IP "\f(CW$text\fR = \f(CW$line\fR\->t ([$new_text])" 4
-.IX Item "$text = $line->t ([$new_text])"
-Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR
-.ie n .IP "$rend = $line\->r ([$new_rend])" 4
-.el .IP "\f(CW$rend\fR = \f(CW$line\fR\->r ([$new_rend])" 4
-.IX Item "$rend = $line->r ([$new_rend])"
-Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR
-.ie n .IP "$length = $line\->l" 4
-.el .IP "\f(CW$length\fR = \f(CW$line\fR\->l" 4
-.IX Item "$length = $line->l"
-Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR.
-.ie n .IP "$rownum = $line\->beg" 4
-.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->beg" 4
-.IX Item "$rownum = $line->beg"
-.PD 0
-.ie n .IP "$rownum = $line\->end" 4
-.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->end" 4
-.IX Item "$rownum = $line->end"
-.PD
-Return the row number of the first/last row of the line, respectively.
-.ie n .IP "$offset = $line\->offset_of ($row, $col)" 4
-.el .IP "\f(CW$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4
-.IX Item "$offset = $line->offset_of ($row, $col)"
-Returns the character offset of the given row|col pair within the logical
-line. Works for rows outside the line, too, and returns corresponding
-offsets outside the string.
-.ie n .IP "($row, $col) = $line\->coord_of ($offset)" 4
-.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4
-.IX Item "($row, $col) = $line->coord_of ($offset)"
-Translates a string offset into terminal coordinates again.
-.RE
-.RS 4
-.RE
-.ie n .IP "$text = $term\->special_encode $string" 4
-.el .IP "\f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4
-.IX Item "$text = $term->special_encode $string"
-Converts a perl string into the special encoding used by rxvt-unicode,
-where one character corresponds to one screen cell. See
-\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
-.ie n .IP "$string = $term\->special_decode $text" 4
-.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4
-.IX Item "$string = $term->special_decode $text"
-Converts rxvt-unicodes text representation into a perl string. See
-\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
-.ie n .IP "$success = $term\->grab_button ($button, $modifiermask[, $window = $term\->vt])" 4
-.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
-.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])"
-.PD 0
-.ie n .IP "$term\->ungrab_button ($button, $modifiermask[, $window = $term\->vt])" 4
-.el .IP "\f(CW$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4
-.IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])"
-.PD
-Register/unregister a synchronous button grab. See the XGrabButton
-manpage.
-.ie n .IP "$success = $term\->grab ($eventtime[, $sync])" 4
-.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4
-.IX Item "$success = $term->grab ($eventtime[, $sync])"
-Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
-synchronous (\f(CW$sync\fR is true). Also remembers the grab timestamp.
-.ie n .IP "$term\->allow_events_async" 4
-.el .IP "\f(CW$term\fR\->allow_events_async" 4
-.IX Item "$term->allow_events_async"
-Calls XAllowEvents with AsyncBoth for the most recent grab.
-.ie n .IP "$term\->allow_events_sync" 4
-.el .IP "\f(CW$term\fR\->allow_events_sync" 4
-.IX Item "$term->allow_events_sync"
-Calls XAllowEvents with SyncBoth for the most recent grab.
-.ie n .IP "$term\->allow_events_replay" 4
-.el .IP "\f(CW$term\fR\->allow_events_replay" 4
-.IX Item "$term->allow_events_replay"
-Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
-recent grab.
-.ie n .IP "$term\->ungrab" 4
-.el .IP "\f(CW$term\fR\->ungrab" 4
-.IX Item "$term->ungrab"
-Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
-evaluation errors, as it is better to lose the grab in the error case as
-the session.
-.ie n .IP "$atom = $term\->XInternAtom ($atom_name[, $only_if_exists])" 4
-.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4
-.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])"
-.PD 0
-.ie n .IP "$atom_name = $term\->XGetAtomName ($atom)" 4
-.el .IP "\f(CW$atom_name\fR = \f(CW$term\fR\->XGetAtomName ($atom)" 4
-.IX Item "$atom_name = $term->XGetAtomName ($atom)"
-.ie n .IP "@atoms = $term\->XListProperties ($window)" 4
-.el .IP "\f(CW@atoms\fR = \f(CW$term\fR\->XListProperties ($window)" 4
-.IX Item "@atoms = $term->XListProperties ($window)"
-.ie n .IP "($type,$format,$octets) = $term\->XGetWindowProperty ($window, $property)" 4
-.el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4
-.IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)"
-.ie n .IP "$term\->XChangeProperty ($window, $property, $type, $format, $octets)" 4
-.el .IP "\f(CW$term\fR\->XChangeProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4
-.IX Item "$term->XChangeProperty ($window, $property, $type, $format, $octets)"
-.ie n .IP "$term\->XDeleteProperty ($window, $property)" 4
-.el .IP "\f(CW$term\fR\->XDeleteProperty ($window, \f(CW$property\fR)" 4
-.IX Item "$term->XDeleteProperty ($window, $property)"
-.ie n .IP "$window = $term\->DefaultRootWindow" 4
-.el .IP "\f(CW$window\fR = \f(CW$term\fR\->DefaultRootWindow" 4
-.IX Item "$window = $term->DefaultRootWindow"
-.ie n .IP "$term\->XReparentWindow ($window, $parent, [$x, $y])" 4
-.el .IP "\f(CW$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4
-.IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])"
-.ie n .IP "$term\->XMapWindow ($window)" 4
-.el .IP "\f(CW$term\fR\->XMapWindow ($window)" 4
-.IX Item "$term->XMapWindow ($window)"
-.ie n .IP "$term\->XUnmapWindow ($window)" 4
-.el .IP "\f(CW$term\fR\->XUnmapWindow ($window)" 4
-.IX Item "$term->XUnmapWindow ($window)"
-.ie n .IP "$term\->XMoveResizeWindow ($window, $x, $y, $width, $height)" 4
-.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
-.IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)"
-.ie n .IP "($x, $y, $child_window) = $term\->XTranslateCoordinates ($src, $dst, $x, $y)" 4
-.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
-.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)"
-.ie n .IP "$term\->XChangeInput ($window, $add_events[, $del_events])" 4
-.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4
-.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])"
-.ie n .IP "$keysym = $term\->XStringToKeysym ($string)" 4
-.el .IP "\f(CW$keysym\fR = \f(CW$term\fR\->XStringToKeysym ($string)" 4
-.IX Item "$keysym = $term->XStringToKeysym ($string)"
-.ie n .IP "$string = $term\->XKeysymToString ($keysym)" 4
-.el .IP "\f(CW$string\fR = \f(CW$term\fR\->XKeysymToString ($keysym)" 4
-.IX Item "$string = $term->XKeysymToString ($keysym)"
-.PD
-Various X or X\-related functions. The \f(CW$term\fR object only serves as
-the source of the display, otherwise those functions map more-or-less
-directly onto the X functions of the same name.
-.ie n .SS "The ""urxvt::popup"" Class"
-.el .SS "The \f(CWurxvt::popup\fP Class"
-.IX Subsection "The urxvt::popup Class"
-.ie n .IP "$popup\->add_title ($title)" 4
-.el .IP "\f(CW$popup\fR\->add_title ($title)" 4
-.IX Item "$popup->add_title ($title)"
-Adds a non-clickable title to the popup.
-.ie n .IP "$popup\->add_separator ([$sepchr])" 4
-.el .IP "\f(CW$popup\fR\->add_separator ([$sepchr])" 4
-.IX Item "$popup->add_separator ([$sepchr])"
-Creates a separator, optionally using the character given as \f(CW$sepchr\fR.
-.ie n .IP "$popup\->add_button ($text, $cb)" 4
-.el .IP "\f(CW$popup\fR\->add_button ($text, \f(CW$cb\fR)" 4
-.IX Item "$popup->add_button ($text, $cb)"
-Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is
-selected.
-.ie n .IP "$popup\->add_toggle ($text, $initial_value, $cb)" 4
-.el .IP "\f(CW$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4
-.IX Item "$popup->add_toggle ($text, $initial_value, $cb)"
-Adds a toggle/checkbox item to the popup. The callback gets called
-whenever it gets toggled, with a boolean indicating its new value as its
-first argument.
-.ie n .IP "$popup\->show" 4
-.el .IP "\f(CW$popup\fR\->show" 4
-.IX Item "$popup->show"
-Displays the popup (which is initially hidden).
-.ie n .SS "The ""urxvt::timer"" Class"
-.el .SS "The \f(CWurxvt::timer\fP Class"
-.IX Subsection "The urxvt::timer Class"
-This class implements timer watchers/events. Time is represented as a
-fractional number of seconds since the epoch. Example:
-.PP
-.Vb 8
-\& $term\->{overlay} = $term\->overlay (\-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
-\& $term\->{timer} = urxvt::timer
-\& \->new
-\& \->interval (1)
-\& \->cb (sub {
-\& $term\->{overlay}\->set (0, 0,
-\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
-\& });
-.Ve
-.ie n .IP "$timer = new urxvt::timer" 4
-.el .IP "\f(CW$timer\fR = new urxvt::timer" 4
-.IX Item "$timer = new urxvt::timer"
-Create a new timer object in started state. It is scheduled to fire
-immediately.
-.ie n .IP "$timer = $timer\->cb (sub { my ($timer) = @_; ... })" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4
-.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })"
-Set the callback to be called when the timer triggers.
-.ie n .IP "$timer = $timer\->set ($tstamp[, $interval])" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->set ($tstamp[, \f(CW$interval\fR])" 4
-.IX Item "$timer = $timer->set ($tstamp[, $interval])"
-Set the time the event is generated to \f(CW$tstamp\fR (and optionally specifies a
-new \f(CW$interval\fR).
-.ie n .IP "$timer = $timer\->interval ($interval)" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->interval ($interval)" 4
-.IX Item "$timer = $timer->interval ($interval)"
-By default (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically
-stop after it has fired once. If \f(CW$interval\fR is non-zero, then the timer
-is automatically rescheduled at the given intervals.
-.ie n .IP "$timer = $timer\->start" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4
-.IX Item "$timer = $timer->start"
-Start the timer.
-.ie n .IP "$timer = $timer\->start ($tstamp[, $interval])" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start ($tstamp[, \f(CW$interval\fR])" 4
-.IX Item "$timer = $timer->start ($tstamp[, $interval])"
-Set the event trigger time to \f(CW$tstamp\fR and start the timer. Optionally
-also replaces the interval.
-.ie n .IP "$timer = $timer\->after ($delay[, $interval])" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->after ($delay[, \f(CW$interval\fR])" 4
-.IX Item "$timer = $timer->after ($delay[, $interval])"
-Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c.
-.ie n .IP "$timer = $timer\->stop" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4
-.IX Item "$timer = $timer->stop"
-Stop the timer.
-.ie n .SS "The ""urxvt::iow"" Class"
-.el .SS "The \f(CWurxvt::iow\fP Class"
-.IX Subsection "The urxvt::iow Class"
-This class implements io watchers/events. Example:
-.PP
-.Vb 12
-\& $term\->{socket} = ...
-\& $term\->{iow} = urxvt::iow
-\& \->new
-\& \->fd (fileno $term\->{socket})
-\& \->events (urxvt::EV_READ)
-\& \->start
-\& \->cb (sub {
-\& my ($iow, $revents) = @_;
-\& # $revents must be 1 here, no need to check
-\& sysread $term\->{socket}, my $buf, 8192
-\& or end\-of\-file;
-\& });
-.Ve
-.ie n .IP "$iow = new urxvt::iow" 4
-.el .IP "\f(CW$iow\fR = new urxvt::iow" 4
-.IX Item "$iow = new urxvt::iow"
-Create a new io watcher object in stopped state.
-.ie n .IP "$iow = $iow\->cb (sub { my ($iow, $reventmask) = @_; ... })" 4
-.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4
-.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })"
-Set the callback to be called when io events are triggered. \f(CW$reventmask\fR
-is a bitset as described in the \f(CW\*(C`events\*(C'\fR method.
-.ie n .IP "$iow = $iow\->fd ($fd)" 4
-.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4
-.IX Item "$iow = $iow->fd ($fd)"
-Set the file descriptor (not handle) to watch.
-.ie n .IP "$iow = $iow\->events ($eventmask)" 4
-.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4
-.IX Item "$iow = $iow->events ($eventmask)"
-Set the event mask to watch. The only allowed values are
-\&\f(CW\*(C`urxvt::EV_READ\*(C'\fR and \f(CW\*(C`urxvt::EV_WRITE\*(C'\fR, which might be ORed
-together, or \f(CW\*(C`urxvt::EV_NONE\*(C'\fR.
-.ie n .IP "$iow = $iow\->start" 4
-.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->start" 4
-.IX Item "$iow = $iow->start"
-Start watching for requested events on the given handle.
-.ie n .IP "$iow = $iow\->stop" 4
-.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4
-.IX Item "$iow = $iow->stop"
-Stop watching for events on the given file handle.
-.ie n .SS "The ""urxvt::iw"" Class"
-.el .SS "The \f(CWurxvt::iw\fP Class"
-.IX Subsection "The urxvt::iw Class"
-This class implements idle watchers, that get called automatically when
-the process is idle. They should return as fast as possible, after doing
-some useful work.
-.ie n .IP "$iw = new urxvt::iw" 4
-.el .IP "\f(CW$iw\fR = new urxvt::iw" 4
-.IX Item "$iw = new urxvt::iw"
-Create a new idle watcher object in stopped state.
-.ie n .IP "$iw = $iw\->cb (sub { my ($iw) = @_; ... })" 4
-.el .IP "\f(CW$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4
-.IX Item "$iw = $iw->cb (sub { my ($iw) = @_; ... })"
-Set the callback to be called when the watcher triggers.
-.ie n .IP "$timer = $timer\->start" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4
-.IX Item "$timer = $timer->start"
-Start the watcher.
-.ie n .IP "$timer = $timer\->stop" 4
-.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4
-.IX Item "$timer = $timer->stop"
-Stop the watcher.
-.ie n .SS "The ""urxvt::pw"" Class"
-.el .SS "The \f(CWurxvt::pw\fP Class"
-.IX Subsection "The urxvt::pw Class"
-This class implements process watchers. They create an event whenever a
-process exits, after which they stop automatically.
-.PP
-.Vb 9
-\& my $pid = fork;
-\& ...
-\& $term\->{pw} = urxvt::pw
-\& \->new
-\& \->start ($pid)
-\& \->cb (sub {
-\& my ($pw, $exit_status) = @_;
-\& ...
-\& });
-.Ve
-.ie n .IP "$pw = new urxvt::pw" 4
-.el .IP "\f(CW$pw\fR = new urxvt::pw" 4
-.IX Item "$pw = new urxvt::pw"
-Create a new process watcher in stopped state.
-.ie n .IP "$pw = $pw\->cb (sub { my ($pw, $exit_status) = @_; ... })" 4
-.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4
-.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })"
-Set the callback to be called when the timer triggers.
-.ie n .IP "$pw = $timer\->start ($pid)" 4
-.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4
-.IX Item "$pw = $timer->start ($pid)"
-Tells the watcher to start watching for process \f(CW$pid\fR.
-.ie n .IP "$pw = $pw\->stop" 4
-.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4
-.IX Item "$pw = $pw->stop"
-Stop the watcher.
-.SH "ENVIRONMENT"
-.IX Header "ENVIRONMENT"
-.SS "\s-1URXVT_PERL_VERBOSITY\s0"
-.IX Subsection "URXVT_PERL_VERBOSITY"
-This variable controls the verbosity level of the perl extension. Higher
-numbers indicate more verbose output.
-.IP "== 0 \- fatal messages" 4
-.IX Item "== 0 - fatal messages"
-.PD 0
-.IP ">= 3 \- script loading and management" 4
-.IX Item ">= 3 - script loading and management"
-.IP ">=10 \- all called hooks" 4
-.IX Item ">=10 - all called hooks"
-.IP ">=11 \- hook return values" 4
-.IX Item ">=11 - hook return values"
-.PD
-.SH "AUTHOR"
-.IX Header "AUTHOR"
-.Vb 2
-\& Marc Lehmann
-\& http://software.schmorp.de/pkg/rxvt\-unicode
-.Ve
diff --git a/src/Makefile.in b/src/Makefile.in
--- a/src/Makefile.in +++ b/src/Makefile.in @@ -8,6 +8,9 @@ bindir = @bindir@ libdir = @libdir@ man1dir = @mandir@/man1 man1ext = 1 +man3dir = @mandir@/man3 +man3ext = 3 +PODOPTS = quotes => q<"> , center => q, release => q<$(RXVTNAME)-$(VERSION)> CXX = @CXX@ PERL = @PERL@ INSTALL = @INSTALL@ @@ -26,8 +29,8 @@ EXEEXT = @EXEEXT@ PERLFLAGS = @PERLFLAGS@ PERLLIB = @PERLLIB@ -srcdir = @srcdir@ -VPATH = @srcdir@ +srcdir = @srcdir@ +VPATH = @srcdir@ first_rule: all dummy: @@ -84,7 +87,7 @@ allbin: rxvt rxvtd rxvtc alldoc: clean: - rm -f rxvt rxvtc rxvtd perlxsi.c rxvtperl.C mantmp + rm -f rxvt rxvtc rxvtd perlxsi.c rxvtperl.C manlst mantmp rm -f *.o distclean: clean @@ -99,15 +102,27 @@ install-perl: @IF_PERL@ $(INSTALL) -d $(DESTDIR)$(libdir) @IF_PERL@ $(INSTALL) -d $(DESTDIR)$(libdir)/urxvt @IF_PERL@ $(INSTALL) -d $(DESTDIR)$(libdir)/urxvt/perl +@IF_PERL@ $(INSTALL) -d $(DESTDIR)$(man1dir) +@IF_PERL@ $(INSTALL) -d $(DESTDIR)$(man3dir) @IF_PERL@ $(INSTALL_DATA) $(srcdir)/urxvt.pm $(DESTDIR)$(libdir)/urxvt/urxvt.pm -@IF_PERL@ cd $(srcdir)/perl; for ext in *; do \ +@IF_PERL@ cd $(srcdir)/perl; \ +@IF_PERL@ for ext in *; do \ @IF_PERL@ test -f "$$ext" || continue; \ @IF_PERL@ $(INSTALL_DATA) "$$ext" $(DESTDIR)$(libdir)/urxvt/perl/; \ @IF_PERL@ < "$$ext" \ -@IF_PERL@ $(PERL) -MPod::Man -e '(new Pod::Man name => "abc", quotes => q<"> , center => q )->parse_from_file' \ +@IF_PERL@ $(PERL) -MPod::Man -e '(new Pod::Man name => "'rxvt-$$ext'", $(PODOPTS))->parse_from_file' \ @IF_PERL@ > ../mantmp; \ @IF_PERL@ test -s ../mantmp && $(INSTALL_DATA) ../mantmp $(DESTDIR)$(man1dir)/$(RXVTNAME)-$$ext.$(man1ext); \ -@IF_PERL@ done +@IF_PERL@ < "$$ext" $(PERL) -ne '<>, (print <> . "\n"), exit if /^=head1/' >&3; \ +@IF_PERL@ done 3>../manlst +@IF_PERL@ cat ../doc/extensions.pod.top manlst ../doc/extensions.pod.bot | \ +@IF_PERL@ $(PERL) -MPod::Man -e '(new Pod::Man name => "$(RXVTNAME)-extensions", $(PODOPTS))->parse_from_file' \ +@IF_PERL@ > mantmp +@IF_PERL@ $(INSTALL_DATA) mantmp $(DESTDIR)$(man1dir)/$(RXVTNAME)-extensions.$(man1ext) +@IF_PERL@ < urxvt.pm \ +@IF_PERL@ $(PERL) -MPod::Man -e '(new Pod::Man name => "$(RXVTNAME)perl", $(PODOPTS))->parse_from_file' \ +@IF_PERL@ > mantmp +@IF_PERL@ $(INSTALL_DATA) mantmp $(DESTDIR)$(man3dir)/$(RXVTNAME)perl.$(man3ext) install-bin: allbin $(INSTALL) -d $(DESTDIR)$(bindir)
-----END OF PAGE-----