From 269734c015031bd808d2f5af6196f17a07a38936 Mon Sep 17 00:00:00 2001 From: root Date: Wed, 30 Dec 2009 06:14:03 +0000 Subject: [PATCH] 9.07 --- Changes | 21 --- README.FAQ | 24 ++- README.configure | 8 +- doc/rxvt.1.man.in | 36 ++-- doc/rxvt.7.man.in | 77 +++++---- doc/rxvtd.1.man.in | 30 ++-- doc/rxvtperl.3.man.in | 392 ++++++++++++++++++++++-------------------- src/Makefile.in | 118 +++++++------ 8 files changed, 371 insertions(+), 335 deletions(-) diff --git a/Changes b/Changes index c8116c41..e0f04e3c 100644 --- a/Changes +++ b/Changes @@ -1,26 +1,5 @@ rxvt-unicode changelog <= google-friendly title -TODO: init_secondary serves what purpose? maybe move it to earlier startup phase and re-think -TODO: xcopyarea pass broken, fix and improve -TODO: event mechanism that replaces on_user_command with something more scalable. -TODO: slipwheeling needs a keyboard grab to get key release events. -TODO: overlays collide with the way the out-of-focus cursor is being drawn -TODO: "slow" rendering mode for bidi and scripts, pango! -TODO: read property sequence is broken with respect to utf-8 etc. -TODO: slow drag selection on remote display - other things seem fast (rxvt illness, motion hints?) -TODO: better resource handling for tabbar in -pe tabbed. -WISH: investigate -pe tabbed -g 80x25 being 23 not 24 or 25 lines - => when setting the constraints, the wm might (correctly) - resize the outer window, which might result in a smaller window overall. - or something like that. guys, send me a patch. -WISH: coloured pastebin -WISH: selection-color-pair instead of reverse video -WISH: load system-wide config file even if we don't have one -WISH: look into XAddConnectionWatch, does anybody need that? -DUMB: support tex fonts - -TODO: perl-shell-window? -TODO: zweimal numlock? falsche codes rxvt urxvt for numpad? 9.07 Wed Dec 30 07:07:18 CET 2009 - port to glibc-2.10 changes (strchr etc. returning const char * in C++), based on patches by Milos Jakubicek and Oliver Mader. diff --git a/README.FAQ b/README.FAQ index 386570cc..80460cac 100644 --- a/README.FAQ +++ b/README.FAQ @@ -500,6 +500,10 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS In this case either do not specify a preeditStyle or specify more than one pre-edit style, such as OverTheSpot,Root,None. + If it still doesn't work, then maybe your input method doesn't support + compose sequences - to fall back to the built-in one, make sure you + don't specify an input method via "-im" or "XMODIFIERS". + I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO 14755 Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on international keyboards) or simply use ISO 14755 support to your @@ -745,7 +749,7 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 - "Alt-Shift-1" and "Alt-Shift-2" switch between two different font sizes. + "Alt-Ctrl-1" and "Alt-Ctrl-2" switch between two different font sizes. "suxuseuro" allows me to keep an eye (and actually read) stuff while keeping a very small window. If somebody pastes something complicated (e.g. japanese), I temporarily switch to a larger font. @@ -791,14 +795,14 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS arises). The correct solution for this problem is to install the terminfo, this - can be done like this (with ncurses' infocmp and works as user and - admin): + can be done by simply installing rxvt-unicode on the remote system as + well (in case you have a nice package manager ready), or you can install + the terminfo database manually like this (with ncurses infocmp. works as + user and root): REMOTE=remotesystem.domain infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" - ... or by installing rxvt-unicode normally on the remote system, - One some systems you might need to set $TERMINFO to the full path of $HOME/.terminfo for this to work. @@ -817,6 +821,11 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS If you don't plan to use rxvt (quite common...) you could also replace the rxvt terminfo file with the rxvt-unicode one and use "TERM=rxvt". + nano fails with "Error opening terminal: rxvt-unicode" + This exceptionally confusing and useless error message is printed by + nano when it can't find the terminfo database. Nothing is wrong with + your terminal, read the previous answer for a solution. + "tic" outputs some error when compiling the terminfo entry. Most likely it's the empty definition for "enacs=". Just replace it by "enacs=\E[0@" and try again. @@ -1113,3 +1122,8 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c + I want 256 colors + Are you sure you need 256 colors? 88 colors should be enough for most + purposes. If you really need more, there is an unsupported patch for it + in the doc directory, but please do not ask for it to be applied. + diff --git a/README.configure b/README.configure index 1808c8e1..672f685a 100644 --- a/README.configure +++ b/README.configure @@ -9,7 +9,7 @@ CONFIGURE OPTIONS --enable-everything Add (or remove) support for all non-multichoice options listed in - "./configure --help". + "./configure --help", except for "--enable-assert". You can specify this and then disable options you do not like by *following* this with the appropriate "--disable-..." arguments, or @@ -171,7 +171,7 @@ CONFIGURE OPTIONS tripleclickwords (-tcw) settable insecure mode (-insecure) keysym remapping support - cursor blinking and underline cursor (-cb, -uc) + cursor blinking and underline cursor (-bc, -uc) XEmbed support (-embed) user-pty (-pty-fd) hold on exit (-hold) @@ -236,6 +236,10 @@ CONFIGURE OPTIONS --perl-ext-common """, so it should be safe to enable from a resource standpoint. + --enable-assert (default: off) + Enables the assertions in the code, normally disabled. This switch + is only useful when developing rxvt-unicode. + --with-afterimage-config=DIR Look for the libAfterImage config script in DIR. diff --git a/doc/rxvt.1.man.in b/doc/rxvt.1.man.in index a7036852..6b80bcdb 100644 --- a/doc/rxvt.1.man.in +++ b/doc/rxvt.1.man.in @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -53,7 +45,7 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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 \{\ @@ -132,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "@@RXVT_NAME@@ 1" -.TH @@RXVT_NAME@@ 1 "2008-11-08" "@@RXVT_VERSION@@" "RXVT-UNICODE" +.TH @@RXVT_NAME@@ 1 "2009-12-30" "@@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 @@ -418,6 +410,9 @@ on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR. .IP "\fB\-bc\fR|\fB+bc\fR" 4 .IX Item "-bc|+bc" Blink the cursor; resource \fBcursorBlink\fR. +.IP "\fB\-uc\fR|\fB+uc\fR" 4 +.IX Item "-uc|+uc" +Make the cursor underlined; resource \fBcursorUnderline\fR. .IP "\fB\-iconic\fR" 4 .IX Item "-iconic" Start iconified, if the window manager supports that option. @@ -461,7 +456,7 @@ the display. Useful to work around font rendering problems; resource Compile \fIfrills\fR: Amount to adjust the computed character width by to control overall letter spacing. Negative values will tighten up the letter spacing, positive values will space letters out more. Useful to -work around odd font metrics; resource \&\fBletterSpace\fR. +work around odd font metrics; resource \fBletterSpace\fR. .IP "\fB\-tn\fR \fItermname\fR" 4 .IX Item "-tn termname" This option specifies the name of the terminal type to be set in the @@ -1026,6 +1021,10 @@ movement only; option \f(CW\*(C`\-ptab\*(C'\fR. .IX Item "cursorBlink: boolean" \&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default]; option \fB\-bc\fR. +.IP "\fBcursorUnderline:\fR \fIboolean\fR" 4 +.IX Item "cursorUnderline: boolean" +\&\fBTrue\fR: Make the cursor underlined. \fBFalse\fR: Make the cursor a box [default]; +option \fB\-uc\fR. .IP "\fBpointerBlank:\fR \fIboolean\fR" 4 .IX Item "pointerBlank: boolean" \&\fBTrue\fR: blank the pointer when a key is pressed or after a set number @@ -1478,11 +1477,14 @@ Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse vide always swapping the foreground/background colours. This is in contrast to \&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise been specified. For example, -.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 -.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" -would yield White on Black, while on \fIxterm\fR(1) it would yield Black -on White. -.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0" +.PP +.Vb 1 +\& @@RXVT_NAME@@ \-fg Black \-bg White \-rv +.Ve +.PP +would yield White on Black, while on \fIxterm\fR(1) it would yield Black on +White. +.SS "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0" .IX Subsection "ALPHA CHANNEL SUPPORT" If Xft support has been compiled in and as long as Xft/Xrender/X don't get their act together, rxvt-unicode will do it's own alpha channel management: diff --git a/doc/rxvt.7.man.in b/doc/rxvt.7.man.in index ce511787..2ae84d50 100644 --- a/doc/rxvt.7.man.in +++ b/doc/rxvt.7.man.in @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -53,7 +45,7 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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 \{\ @@ -132,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "@@RXVT_NAME@@ 7" -.TH @@RXVT_NAME@@ 7 "2008-11-08" "@@RXVT_VERSION@@" "RXVT-UNICODE" +.TH @@RXVT_NAME@@ 7 "2009-12-30" "@@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 @@ -163,7 +155,7 @@ The main manual page for @@RXVT_NAME@@ itself is available at . .SH "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS" .IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS" -.Sh "Meta, Features & Commandline Issues" +.SS "Meta, Features & Commandline Issues" .IX Subsection "Meta, Features & Commandline Issues" \fIMy question isn't answered here, can I ask a human?\fR .IX Subsection "My question isn't answered here, can I ask a human?" @@ -382,7 +374,7 @@ And here is rxvt-unicode: .PP No large bloated libraries (of course, none were linked in statically), except maybe libX11 :) -.Sh "Rendering, Font & Look and Feel Issues" +.SS "Rendering, Font & Look and Feel Issues" .IX Subsection "Rendering, Font & Look and Feel Issues" \fII can't get transparency working, what am I doing wrong?\fR .IX Subsection "I can't get transparency working, what am I doing wrong?" @@ -676,7 +668,7 @@ We are working on it, in the meantime, as a workaround, use something like: .Vb 1 \& @@URXVT_NAME@@ \-b 600 \-geometry 20x1 \-e sh \-c \*(Aqmplayer \-wid $WINDOWID file...\*(Aq .Ve -.Sh "Keyboard, Mouse & User Interaction" +.SS "Keyboard, Mouse & User Interaction" .IX Subsection "Keyboard, Mouse & User Interaction" \fIThe new selection selects pieces that are too big, how can I select single words?\fR .IX Subsection "The new selection selects pieces that are too big, how can I select single words?" @@ -770,6 +762,10 @@ rxvt-unicode will continue without an input method. In this case either do not specify a \fBpreeditStyle\fR or specify more than one pre-edit style, such as \fBOverTheSpot,Root,None\fR. .PP +If it still doesn't work, then maybe your input method doesn't support +compose sequences \- to fall back to the built-in one, make sure you don't +specify an input method via \f(CW\*(C`\-im\*(C'\fR or \f(CW\*(C`XMODIFIERS\*(C'\fR. +.PP \fII cannot type \f(CI\*(C`Ctrl\-Shift\-2\*(C'\fI to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755\fR .IX Subsection "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755" .PP @@ -898,7 +894,7 @@ See some more examples in the documentation for the \fBkeysym\fR resource. Rather than have rxvt-unicode try to accommodate all the various possible keyboard mappings, it is better to use `xmodmap' to remap the keys as required for your particular machine. -.Sh "Terminal Configuration" +.SS "Terminal Configuration" .IX Subsection "Terminal Configuration" \fICan I see a typical configuration?\fR .IX Subsection "Can I see a typical configuration?" @@ -1062,7 +1058,7 @@ defaults: \& IRC*keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 .Ve .PP -\&\f(CW\*(C`Alt\-Shift\-1\*(C'\fR and \f(CW\*(C`Alt\-Shift\-2\*(C'\fR switch between two different font +\&\f(CW\*(C`Alt\-Ctrl\-1\*(C'\fR and \f(CW\*(C`Alt\-Ctrl\-2\*(C'\fR switch between two different font sizes. \f(CW\*(C`suxuseuro\*(C'\fR allows me to keep an eye (and actually read) stuff while keeping a very small window. If somebody pastes something complicated (e.g. japanese), I temporarily switch to a larger font. @@ -1115,15 +1111,16 @@ The terminal description used by rxvt-unicode is not as widely available as that for xterm, or even rxvt (for which the same problem often arises). .PP The correct solution for this problem is to install the terminfo, this can -be done like this (with ncurses' infocmp and works as user and admin): +be done by simply installing rxvt-unicode on the remote system as well +(in case you have a nice package manager ready), or you can install the +terminfo database manually like this (with ncurses infocmp. works as +user and root): .PP .Vb 2 \& REMOTE=remotesystem.domain \& infocmp rxvt\-unicode | ssh $REMOTE "mkdir \-p .terminfo && cat >/tmp/ti && tic /tmp/ti" .Ve .PP -\&... or by installing rxvt-unicode normally on the remote system, -.PP One some systems you might need to set \f(CW$TERMINFO\fR to the full path of \&\fI\f(CI$HOME\fI/.terminfo\fR for this to work. .PP @@ -1144,6 +1141,13 @@ resource to set it: If you don't plan to use \fBrxvt\fR (quite common...) you could also replace the rxvt terminfo file with the rxvt-unicode one and use \f(CW\*(C`TERM=rxvt\*(C'\fR. .PP +\fInano fails with \*(L"Error opening terminal: rxvt-unicode\*(R"\fR +.IX Subsection "nano fails with Error opening terminal: rxvt-unicode" +.PP +This exceptionally confusing and useless error message is printed by nano +when it can't find the terminfo database. Nothing is wrong with your +terminal, read the previous answer for a solution. +.PP \fI\f(CI\*(C`tic\*(C'\fI outputs some error when compiling the terminfo entry.\fR .IX Subsection "tic outputs some error when compiling the terminfo entry." .PP @@ -1215,7 +1219,7 @@ GNU/Linux) furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR file, so you will need to install it on your own (See the question \fBWhen I log-in to another system it tells me about missing terminfo data?\fR on how to do this). -.Sh "Encoding / Locale / Input Method Issues" +.SS "Encoding / Locale / Input Method Issues" .IX Subsection "Encoding / Locale / Input Method Issues" \fIRxvt-unicode does not seem to understand the selected encoding?\fR .IX Subsection "Rxvt-unicode does not seem to understand the selected encoding?" @@ -1342,7 +1346,7 @@ For example, \fBkinput2\fR does not support \s-1UTF\-8\s0 locales, you should us .IP "\- Make sure your \s-1XIM\s0 server is actually running." 4 .IX Item "- Make sure your XIM server is actually running." .PD 0 -.ie n .IP "\- Make sure the ""XMODIFIERS""\fR environment variable is set correctly when \fIstarting rxvt-unicode." 4 +.ie n .IP "\- Make sure the ""XMODIFIERS"" environment variable is set correctly when \fIstarting\fR rxvt-unicode." 4 .el .IP "\- Make sure the \f(CWXMODIFIERS\fR environment variable is set correctly when \fIstarting\fR rxvt-unicode." 4 .IX Item "- Make sure the XMODIFIERS environment variable is set correctly when starting rxvt-unicode." .PD @@ -1381,7 +1385,7 @@ while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however, crashes cannot be completely avoided even if both sides cooperate. .PP So the only workaround is not to kill your Input Method Servers. -.Sh "Operating Systems / Package Maintaining" +.SS "Operating Systems / Package Maintaining" .IX Subsection "Operating Systems / Package Maintaining" \fII am using Debian GNU/Linux and have a problem...\fR .IX Subsection "I am using Debian GNU/Linux and have a problem..." @@ -1499,13 +1503,20 @@ The solution is to upgrade your system or switch to a better one. A possibly working workaround is to use a wcwidth implementation like .PP http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c +.PP +\fII want 256 colors\fR +.IX Subsection "I want 256 colors" +.PP +Are you sure you need 256 colors? 88 colors should be enough for most +purposes. If you really need more, there is an unsupported patch for +it in the doc directory, but please do not ask for it to be applied. .SH "RXVT-UNICODE TECHNICAL REFERENCE" .IX Header "RXVT-UNICODE TECHNICAL REFERENCE" The rest of this document describes various technical aspects of \&\fBrxvt-unicode\fR. First the description of supported command sequences, followed by pixmap support and last by a description of all features selectable at \f(CW\*(C`configure\*(C'\fR time. -.Sh "Definitions" +.SS "Definitions" .IX Subsection "Definitions" .ie n .IP "\fB\fB""c""\fB\fR" 4 .el .IP "\fB\f(CBc\fB\fR" 4 @@ -1529,7 +1540,7 @@ parameters, separated by \f(CW\*(C`;\*(C'\fR character(s). .el .IP "\fB\f(CBPt\fB\fR" 4 .IX Item "Pt" A text parameter composed of printable characters. -.Sh "Values" +.SS "Values" .IX Subsection "Values" .ie n .IP "\fB\fB""ENQ""\fB\fR" 4 .el .IP "\fB\f(CBENQ\fB\fR" 4 @@ -1578,7 +1589,7 @@ Switch to Standard Character Set .el .IP "\fB\f(CBSPC\fB\fR" 4 .IX Item "SPC" Space Character -.Sh "Escape Sequences" +.SS "Escape Sequences" .IX Subsection "Escape Sequences" .ie n .IP "\fB\fB""ESC # 8""\fB\fR" 4 .el .IP "\fB\f(CBESC # 8\fB\fR" 4 @@ -1681,7 +1692,7 @@ C = K German character set unimplemented .PP .IX Xref "CSI" -.Sh "\s-1CSI\s0 (Command Sequence Introducer) Sequences" +.SS "\s-1CSI\s0 (Command Sequence Introducer) Sequences" .IX Subsection "CSI (Command Sequence Introducer) Sequences" .ie n .IP "\fB\fB""ESC [ Ps @""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Ps @\fB\fR" 4 @@ -1947,7 +1958,7 @@ Request Terminal Parameters (\s-1DECREQTPARM\s0) .PP .IX Xref "PrivateModes" -.Sh "\s-1DEC\s0 Private Modes" +.SS "\s-1DEC\s0 Private Modes" .IX Subsection "DEC Private Modes" .ie n .IP "\fB\fB""ESC [ ? Pm h""\fB\fR" 4 .el .IP "\fB\f(CBESC [ ? Pm h\fB\fR" 4 @@ -2223,7 +2234,7 @@ l Disable bracketed paste mode .PP .IX Xref "XTerm" -.Sh "XTerm Operating System Commands" +.SS "XTerm Operating System Commands" .IX Subsection "XTerm Operating System Commands" .ie n .IP "\fB\fB""ESC ] Ps;Pt ST""\fB\fR" 4 .el .IP "\fB\f(CBESC ] Ps;Pt ST\fB\fR" 4 @@ -2436,8 +2447,8 @@ work, so it can be fixed. Marc Lehmann . All .IP "\-\-enable\-everything" 4 .IX Item "--enable-everything" -Add (or remove) support for all non-multichoice options listed in \*(L"./configure -\&\-\-help\*(R". +Add (or remove) support for all non-multichoice options listed in +\&\f(CW\*(C`./configure \-\-help\*(C'\fR, except for \f(CW\*(C`\-\-enable\-assert\*(C'\fR. .Sp You can specify this and then disable options you do not like by \&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments, @@ -2598,7 +2609,7 @@ in combination with other switches) is: \& tripleclickwords (\-tcw) \& settable insecure mode (\-insecure) \& keysym remapping support -\& cursor blinking and underline cursor (\-cb, \-uc) +\& cursor blinking and underline cursor (\-bc, \-uc) \& XEmbed support (\-embed) \& user\-pty (\-pty\-fd) \& hold on exit (\-hold) @@ -2664,6 +2675,10 @@ environment variable when running configure. Even when compiled in, perl will \fInot\fR be initialised when all extensions have been disabled \&\f(CW\*(C`\-pe "" \-\-perl\-ext\-common ""\*(C'\fR, so it should be safe to enable from a resource standpoint. +.IP "\-\-enable\-assert (default: off)" 4 +.IX Item "--enable-assert (default: off)" +Enables the assertions in the code, normally disabled. This switch is only +useful when developing rxvt-unicode. .IP "\-\-with\-afterimage\-config=DIR" 4 .IX Item "--with-afterimage-config=DIR" Look for the libAfterImage config script in \s-1DIR\s0. diff --git a/doc/rxvtd.1.man.in b/doc/rxvtd.1.man.in index b825e3b4..45e91bcf 100644 --- a/doc/rxvtd.1.man.in +++ b/doc/rxvtd.1.man.in @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -53,7 +45,7 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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 \{\ @@ -132,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "@@RXVT_NAME@@ 1" -.TH @@RXVT_NAME@@ 1 "2008-06-15" "@@RXVT_VERSION@@" "RXVT-UNICODE" +.TH @@RXVT_NAME@@ 1 "2009-12-30" "@@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 @@ -141,7 +133,7 @@ @@RXVT_NAME@@d \- @@RXVT_NAME@@ terminal daemon .SH "SYNOPSIS" .IX Header "SYNOPSIS" -\&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork] +\&\fB@@RXVT_NAME@@d\fR [\-q|\-\-quiet] [\-o|\-\-opendisplay] [\-f|\-\-fork] [\-m|\-\-mlock] .PP \&\fB@@RXVT_NAME@@d\fR \-q \-o \-f # for .xsession use .SH "DESCRIPTION" @@ -183,6 +175,20 @@ the lifetime of a specific display/server. If the server does a reset, .IX Item "-f, --fork" This makes \fB@@RXVT_NAME@@d\fR fork after it has bound itself to its control socket. +.IP "\fB\-m\fR, \fB\-\-mlock\fR" 4 +.IX Item "-m, --mlock" +This makes \fB@@RXVT_NAME@@d\fR call \fImlockall\fR\|(2) on itself. This locks +\&\fB@@RXVT_NAME@@d\fR in \s-1RAM\s0 and prevents it from being swapped out to disk, +at the cost of consuming a lot more memory on most operating systems. +.Sp +Note: In order to use this feature, your system administrator must have set +your user's \s-1RLIMIT_MEMLOCK\s0 to a size greater than or equal to the size of the +\&\fB@@RXVT_NAME@@d\fR binary (or to unlimited). See \fI/etc/security/limits.conf\fR. +.Sp +Note 2: There is a known bug in glibc (possibly fixed in 2.8 and later +versions) where calloc returns non-zeroed memory when mlockall is in +effect. If you experience crashes or other odd behaviour while using +\&\-\-mlock, try it without it. .SH "EXAMPLES" .IX Header "EXAMPLES" This is a useful invocation of \fB@@RXVT_NAME@@d\fR in a \fI.xsession\fR\-style diff --git a/doc/rxvtperl.3.man.in b/doc/rxvtperl.3.man.in index a73b382a..fb026bc6 100644 --- a/doc/rxvtperl.3.man.in +++ b/doc/rxvtperl.3.man.in @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -53,7 +45,7 @@ .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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 \{\ @@ -132,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "@@RXVT_NAME@@ 3" -.TH @@RXVT_NAME@@ 3 "2008-11-08" "@@RXVT_VERSION@@" "RXVT-UNICODE" +.TH @@RXVT_NAME@@ 3 "2009-12-30" "@@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 @@ -531,6 +523,21 @@ for the filename): the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead, which works regardless of wether xrdb is used to parse the resource file or not. +.IP "macosx-pastebin and macosx-pastebin-native" 4 +.IX Item "macosx-pastebin and macosx-pastebin-native" +These two modules implement an extended clipboard for Mac \s-1OS\s0 X. They are +used like this: +.Sp +.Vb 3 +\& URxvt.perl\-ext\-common: default,macosx\-clipboard +\& URxvt.keysym.M\-c: perl:macosx\-clipboard:copy +\& URxvt.keysym.M\-v: perl:macosx\-clipboard:paste +.Ve +.Sp +The difference between them is that the native variant requires a +perl from apple's devkit or so, and \f(CW\*(C`maxosx\-pastebin\*(C'\fR requires the +\&\f(CW\*(C`Mac::Pasteboard\*(C'\fR module, works with other perls, has fewer bugs, is +simpler etc. etc. .IP "example-refresh-hooks" 4 .IX Item "example-refresh-hooks" Displays a very simple digital clock in the upper right corner of the @@ -538,7 +545,7 @@ window. Illustrates overwriting the refresh callbacks to create your own overlays or changes. .SH "API DOCUMENTATION" .IX Header "API DOCUMENTATION" -.Sh "General \s-1API\s0 Considerations" +.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 @@ -569,7 +576,7 @@ encoding (often locale-specific) and binary data. .IX Item "$octets" Either binary data or \- more common \- a text string encoded in a locale-specific way. -.Sh "Extension Objects" +.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 extenion objects, @@ -583,22 +590,22 @@ Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all metho \&\f(CW\*(C`urxvt::term\*(C'\fR class on this object. .PP It has the following methods and data members: -.ie n .IP "$urxvt_term\fR = \f(CW$self\->{term}" 4 +.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\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb..])" 4 +.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, [$hook_name => \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. -.ie n .IP "$self\fR\->disable ($hook_name[, \f(CW$hook_name..])" 4 +.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. -.Sh "Hooks" +.SS "Hooks" .IX Subsection "Hooks" The following subroutines can be declared in extension files, and will be called whenever the relevant event happens. @@ -636,16 +643,16 @@ still fully functional (not for long, though). 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\fR, \f(CW$pid" 4 +.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\fR, \f(CW$status" 4 +.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\fR, \f(CW$eventtime" 4 +.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 @@ -654,7 +661,7 @@ 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\fR, \f(CW$eventtime" 4 +.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 @@ -673,13 +680,13 @@ 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\fR, \f(CW$offset" 4 +.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\fR, \f(CW$lines\fR, \f(CW$saved" 4 +.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 @@ -689,7 +696,7 @@ than the scroll back buffer or the terminal. 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\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp" 4 +.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 @@ -699,7 +706,7 @@ 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\fR, \f(CW$args\fR, \f(CW$resp" 4 +.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 = @@ -727,7 +734,7 @@ 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\fR, \f(CW$string" 4 +.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 @@ -735,12 +742,12 @@ 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\fR, \f(CW$octets" 4 +.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_line_update $term\fR, \f(CW$row" 4 +.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 @@ -765,7 +772,7 @@ code is run after this hook, and takes precedence. .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\fR, \f(CW$string" 4 +.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 @@ -774,19 +781,19 @@ 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_resize_all_windows $tern\fR, \f(CW$new_width\fR, \f(CW$new_height" 4 +.ie n .IP "on_resize_all_windows $tern, $new_width, $new_height" 4 .el .IP "on_resize_all_windows \f(CW$tern\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4 .IX Item "on_resize_all_windows $tern, $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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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. @@ -800,32 +807,32 @@ does focus in processing. .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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 +.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\fR, \f(CW$event\fR, \f(CW$keysym" 4 +.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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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 @@ -840,28 +847,28 @@ manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*( output, if any, in locale-specific encoding. .Sp subwindow. -.ie n .IP "on_client_message $term\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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\fR, \f(CW$event" 4 +.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 .Sh "Variables in the ""urxvt"" Package" -.el .Sh "Variables in the \f(CWurxvt\fP Package" +.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\fR, \f(CW$urxvt::RESCLASS" 4 +.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. @@ -890,8 +897,8 @@ first. 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 .Sh "Functions in the ""urxvt"" Package" -.el .Sh "Functions in the \f(CWurxvt\fP Package" +.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 @@ -932,7 +939,7 @@ Returns the \*(L"current time\*(R" (as per the event loop). .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. -.Sh "\s-1RENDITION\s0" +.SS "\s-1RENDITION\s0" .IX Subsection "RENDITION" Rendition bitsets contain information about colour, font, font styles and similar information for each screen cell. @@ -956,40 +963,40 @@ Return the rendition mask used for overlays by default. 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\fR = urxvt::GET_BASEFG \f(CW$rend" 4 +.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\fR = urxvt::GET_BASEBG \f(CW$rend" 4 +.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\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4 +.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\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4 +.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\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg" 4 +.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\fR = urxvt::GET_CUSTOM \f(CW$rend" 4 +.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\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value" 4 +.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 .Sh "The ""urxvt::anyevent"" Class" -.el .Sh "The \f(CWurxvt::anyevent\fP Class" +.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 @@ -997,10 +1004,10 @@ further programming. The only exception is that you cannot wait on condition variables, but non-blocking condvar use is ok. What this means is that you cannot use blocking APIs, but the non-blocking variant should work. -.ie n .Sh "The ""urxvt::term"" Class" -.el .Sh "The \f(CWurxvt::term\fP Class" +.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\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname, [arg...]" 4 +.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 @@ -1018,7 +1025,7 @@ refer to global data (which is race free). 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\fR\->exec_async ($cmd[, \f(CW@args])" 4 +.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 @@ -1027,7 +1034,7 @@ the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) a 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\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set])" 4 +.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 @@ -1045,7 +1052,7 @@ source file \fI/src/optinc.h\fR to see the actual list: \& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs \& transparent tripleclickwords utmpInhibit visualBell .Ve -.ie n .IP "$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval])" 4 +.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 @@ -1072,9 +1079,9 @@ to see the actual list: \& borderLess chdir color cursorBlink cursorUnderline cutchars delete_key \& display_name embed ext_bwidth fade font geometry hold iconName \& imFont imLocale inputMethod insecure int_bwidth intensityStyles -\& italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier -\& mouseWheelScrollPage name override_redirect pastableTabs path perl_eval -\& perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay +\& italicFont jumpScroll lineSpace letterSpace 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 @@ -1082,7 +1089,7 @@ to see the actual list: \& transient_for transparent transparent_all tripleclickwords utmpInhibit \& visualBell .Ve -.ie n .IP "$value\fR = \f(CW$term\->x_resource ($pattern)" 4 +.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 @@ -1093,56 +1100,63 @@ resource with that pattern exists. 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 "$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 +.ie n .IP "$success = $term\->parse_keysym ($keysym_spec, $command_string)" 4 .el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 .IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" Adds a keymap translation exactly as specified via a resource. See the \&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. -.ie n .IP "$rend\fR = \f(CW$term\->rstyle ([$new_rstyle])" 4 +.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\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col])" 4 +.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\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col])" 4 +.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\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col])" 4 +.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\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col])" 4 +.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, -and optionally set them to new values. -.ie n .IP "$term\fR\->selection_make ($eventtime[, \f(CW$rectangular])" 4 +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 prefered function to make a selection. -.ie n .IP "$success\fR = \f(CW$term\->selection_grab ($eventtime)" 4 +.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 .el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime)" 4 .IX Item "$success = $term->selection_grab ($eventtime)" Try to request the primary selection text from the server (for example, as set by 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\fR = \f(CW$term\->selection ([$newtext])" 4 +.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 .el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext])" 4 .IX Item "$oldtext = $term->selection ([$newtext])" Return the current selection text and optionally replace it by \f(CW$newtext\fR. -.ie n .IP "$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text)" 4 +.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\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 +.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 @@ -1160,7 +1174,7 @@ 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\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend])" 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 @@ -1179,32 +1193,32 @@ If hidden, display the overlay again. .RE .RS 4 .RE -.ie n .IP "$popup\fR = \f(CW$term\->popup ($event)" 4 +.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\fR = \f(CW$term\->strwidth ($string)" 4 +.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\fR = \f(CW$term\->locale_encode ($string)" 4 +.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\fR = \f(CW$term\->locale_decode ($octets)" 4 +.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\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 +.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\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 +.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 @@ -1242,23 +1256,23 @@ locale-specific encoding of the terminal and can contain command sequences Write the octets given in \f(CW$data\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 "$old_events\fR = \f(CW$term\->pty_ev_events ([$new_events])" 4 +.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\fR = \f(CW$term\->pty_fd" 4 +.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\fR = \f(CW$term\->parent" 4 +.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\fR = \f(CW$term\->vt" 4 +.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. @@ -1278,97 +1292,97 @@ to receive pointer events all the times: .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\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time])" 4 +.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\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time])" 4 +.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\fR = \f(CW$term\->width" 4 +.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\fR = \f(CW$term\->height" 4 +.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\fR = \f(CW$term\->fwidth" 4 +.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\fR = \f(CW$term\->fheight" 4 +.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\fR = \f(CW$term\->fbase" 4 +.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\fR = \f(CW$term\->nrow" 4 +.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\fR = \f(CW$term\->ncol" 4 +.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\fR = \f(CW$term\->focus" 4 +.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\fR = \f(CW$term\->mapped" 4 +.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\fR = \f(CW$term\->saveLines" 4 +.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\fR = \f(CW$term\->total_rows" 4 +.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\fR = \f(CW$term\->top_row" 4 +.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\fR = \f(CW$term\->display_id" 4 +.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\fR = \f(CW$term\->locale" 4 +.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\fR = \f(CW$term\->env" 4 +.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\fR = \f(CW$term\->envv" 4 +.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\fR = \f(CW$term\->argv" 4 +.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\fR = \f(CW$term\->ModLevel3Mask" 4 +.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\fR = \f(CW$term\->ModMetaMask" 4 +.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\fR = \f(CW$term\->ModNumLockMask" 4 +.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\fR = \f(CW$term\->current_screen" 4 +.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\fR = \f(CW$term\->hidden_cursor" 4 +.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\fR = \f(CW$term\->view_start ([$newvalue])" 4 +.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 @@ -1382,7 +1396,7 @@ 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\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 +.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 @@ -1407,7 +1421,7 @@ 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\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 +.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 @@ -1417,82 +1431,82 @@ styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR. When setting rendition, the font mask will be ignored. .Sp See the section on \s-1RENDITION\s0, above. -.ie n .IP "$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 +.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\fR = \f(CW$term\->is_longer ($row_number)" 4 +.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\fR = \f(CW$term\->line ($row_number)" 4 +.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\fR = \f(CW$line\->t ([$new_text])" 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\fR = \f(CW$line\->r ([$new_rend])" 4 +.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\fR = \f(CW$line\->l" 4 +.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\fR = \f(CW$line\->beg" 4 +.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\fR = \f(CW$line\->end" 4 +.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\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col)" 4 +.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\fR) = \f(CW$line\->coord_of ($offset)" 4 +.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\fR = \f(CW$term\fR\->special_encode \f(CW$string" 4 +.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\fR = \f(CW$term\fR\->special_decode \f(CW$text" 4 +.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\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 +.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\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 +.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\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync])" 4 +.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 @@ -1516,29 +1530,29 @@ recent grab. Calls XUngrab 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\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4 +.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\fR = \f(CW$term\->XGetAtomName ($atom)" 4 +.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\fR = \f(CW$term\->XListProperties ($window)" 4 +.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\fR\->XGetWindowProperty ($window, \f(CW$property)" 4 +.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\fR\->XChangeProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4 +.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\fR\->XDeleteProperty ($window, \f(CW$property)" 4 +.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\fR = \f(CW$term\->DefaultRootWindow" 4 +.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\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y])" 4 +.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 @@ -1547,21 +1561,21 @@ the session. .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\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4 +.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\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y)" 4 +.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\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events])" 4 +.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])" .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 directory onto the X functions of the same name. -.ie n .Sh "The ""urxvt::popup"" Class" -.el .Sh "The \f(CWurxvt::popup\fP Class" +.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 @@ -1571,12 +1585,12 @@ Adds a non-clickable title to the popup. .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\fR\->add_button ($text, \f(CW$cb)" 4 +.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\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb)" 4 +.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 @@ -1586,8 +1600,8 @@ first argument. .el .IP "\f(CW$popup\fR\->show" 4 .IX Item "$popup->show" Displays the popup (which is initially hidden). -.ie n .Sh "The ""urxvt::timer"" Class" -.el .Sh "The \f(CWurxvt::timer\fP Class" +.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: @@ -1607,42 +1621,40 @@ fractional number of seconds since the epoch. Example: .IX Item "$timer = new urxvt::timer" Create a new timer object in started state. It is scheduled to fire immediately. -.ie n .IP "$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 +.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 "$tstamp\fR = \f(CW$timer\->at" 4 -.el .IP "\f(CW$tstamp\fR = \f(CW$timer\fR\->at" 4 -.IX Item "$tstamp = $timer->at" -Return the time this watcher will fire next. -.ie n .IP "$timer\fR = \f(CW$timer\->set ($tstamp)" 4 -.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->set ($tstamp)" 4 -.IX Item "$timer = $timer->set ($tstamp)" -Set the time the event is generated to \f(CW$tstamp\fR. -.ie n .IP "$timer\fR = \f(CW$timer\->interval ($interval)" 4 +.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)" -Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically +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\fR = \f(CW$timer\->start" 4 +.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\fR = \f(CW$timer\->start ($tstamp)" 4 -.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start ($tstamp)" 4 -.IX Item "$timer = $timer->start ($tstamp)" -Set the event trigger time to \f(CW$tstamp\fR and start the timer. -.ie n .IP "$timer\fR = \f(CW$timer\->after ($delay)" 4 -.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->after ($delay)" 4 -.IX Item "$timer = $timer->after ($delay)" +.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\fR = \f(CW$timer\->stop" 4 +.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 .Sh "The ""urxvt::iow"" Class" -.el .Sh "The \f(CWurxvt::iow\fP Class" +.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 @@ -1664,31 +1676,31 @@ This class implements io watchers/events. Example: .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\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 +.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\fR = \f(CW$iow\->fd ($fd)" 4 +.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\fR = \f(CW$iow\->events ($eventmask)" 4 +.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\fR = \f(CW$iow\->start" 4 +.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\fR = \f(CW$iow\->stop" 4 +.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 .Sh "The ""urxvt::iw"" Class" -.el .Sh "The \f(CWurxvt::iw\fP Class" +.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 @@ -1697,20 +1709,20 @@ some useful work. .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\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_; ... })" 4 +.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\fR = \f(CW$timer\->start" 4 +.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\fR = \f(CW$timer\->stop" 4 +.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 .Sh "The ""urxvt::pw"" Class" -.el .Sh "The \f(CWurxvt::pw\fP Class" +.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. @@ -1730,21 +1742,21 @@ process exits, after which they stop automatically. .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\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_; ... })" 4 +.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\fR = \f(CW$timer\->start ($pid)" 4 +.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\fR = \f(CW$pw\->stop" 4 +.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" -.Sh "\s-1URXVT_PERL_VERBOSITY\s0" +.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. diff --git a/src/Makefile.in b/src/Makefile.in index 64006b80..a4a95b0a 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -124,13 +124,13 @@ depend: # DO NOT DELETE: nice dependency list follows background.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -background.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -background.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h -background.o: background.h rsinc.h optinc.h +background.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h +background.o: ../libev/ev.h callback.h scrollbar.h salloc.h libptytty.h +background.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h command.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -command.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -command.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -command.o: rsinc.h optinc.h version.h command.h keyboard.h +command.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +command.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +command.o: background.h rsinc.h optinc.h version.h command.h keyboard.h encoding.o: ../config.h encoding.h table/iso8859_1.h table/iso8859_15.h encoding.o: table/iso8859_2.h table/iso8859_3.h table/iso8859_4.h encoding.o: table/iso8859_5.h table/iso8859_6.h table/iso8859_7.h @@ -146,89 +146,93 @@ encoding.o: table/cns11643_1992_f.h table/big5_ext.h table/big5_plus.h encoding.o: table/viscii.h table/jis0201_1976_0.h table/jis0208_1990_0.h encoding.o: table/jis0212_1990_0.h table/jis0213_1.h table/jis0213_2.h encoding.o: table/compose.h table/category.h -ev_cpp.o: ev_cpp.h ../libev/ev++.h ../libev/ev.h ../libev/ev.c ../config.h +ev_cpp.o: ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h ../libev/ev.c ev_cpp.o: ../libev/ev_vars.h ../libev/ev_epoll.c ../libev/ev_select.c fdpass.o: ../config.h libptytty.h init.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -init.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -init.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -init.o: rsinc.h optinc.h init.h keyboard.h +init.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +init.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +init.o: background.h rsinc.h optinc.h init.h keyboard.h keyboard.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -keyboard.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -keyboard.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +keyboard.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +keyboard.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h keyboard.o: background.h rsinc.h optinc.h keyboard.h command.h logging.o: ../config.h ptytty.h libptytty.h ptytty_conf.h rxvt.h feature.h logging.o: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h ev_cpp.h -logging.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h salloc.h -logging.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h +logging.o: ../config.h ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h +logging.o: salloc.h rxvtperl.h hookinc.h background.h rsinc.h optinc.h main.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -main.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -main.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -main.o: rsinc.h optinc.h keyboard.h +main.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +main.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +main.o: background.h rsinc.h optinc.h keyboard.h misc.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -misc.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -misc.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -misc.o: rsinc.h optinc.h +misc.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +misc.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +misc.o: background.h rsinc.h optinc.h proxy.o: ../config.h ptytty.h libptytty.h ptytty_conf.h rxvt.h feature.h -proxy.o: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h ev_cpp.h +proxy.o: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h proxy.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h salloc.h proxy.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h ptytty.o: ../config.h ptytty.h libptytty.h ptytty_conf.h rxvt.h feature.h -ptytty.o: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h ev_cpp.h +ptytty.o: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h ptytty.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h salloc.h ptytty.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h rxvt.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -rxvt.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -rxvt.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -rxvt.o: rsinc.h optinc.h +rxvt.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +rxvt.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +rxvt.o: background.h rsinc.h optinc.h rxvtc.o: ../config.h rxvtdaemon.h rxvtutil.h libptytty.h rxvt.h feature.h -rxvtc.o: encoding.h rxvtfont.h rxvttoolkit.h ev_cpp.h ../libev/ev++.h -rxvtc.o: ../libev/ev.h callback.h scrollbar.h salloc.h rxvtperl.h hookinc.h -rxvtc.o: background.h rsinc.h optinc.h +rxvtc.o: encoding.h rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h +rxvtc.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h salloc.h +rxvtc.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h rxvtd.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -rxvtd.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -rxvtd.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -rxvtd.o: rsinc.h optinc.h rxvtdaemon.h +rxvtd.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +rxvtd.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +rxvtd.o: background.h rsinc.h optinc.h rxvtdaemon.h rxvtdaemon.o: rxvtdaemon.h rxvtutil.h rxvtfont.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -rxvtfont.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -rxvtfont.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +rxvtfont.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +rxvtfont.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h rxvtfont.o: background.h rsinc.h optinc.h table/linedraw.h -rxvtperl.o: ../config.h ev_cpp.h ../libev/ev++.h ../libev/ev.h rxvt.h -rxvtperl.o: feature.h encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h +rxvtperl.o: ../config.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +rxvtperl.o: rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h rxvtperl.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h rxvtperl.o: background.h rsinc.h optinc.h keyboard.h perlxsi.c iom_perl.h rxvttoolkit.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -rxvttoolkit.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h -rxvttoolkit.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h -rxvttoolkit.o: hookinc.h background.h rsinc.h optinc.h +rxvttoolkit.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h +rxvttoolkit.o: ../libev/ev.h callback.h scrollbar.h salloc.h libptytty.h +rxvttoolkit.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h rxvtutil.o: rxvtutil.h salloc.o: salloc.h screen.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -screen.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -screen.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h background.h -screen.o: rsinc.h optinc.h salloc.C +screen.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +screen.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +screen.o: background.h rsinc.h optinc.h salloc.C scrollbar-next.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h -scrollbar-next.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../libev/ev++.h -scrollbar-next.o: ../libev/ev.h callback.h scrollbar.h salloc.h libptytty.h -scrollbar-next.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h +scrollbar-next.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h +scrollbar-next.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h +scrollbar-next.o: salloc.h libptytty.h rxvtperl.h hookinc.h background.h +scrollbar-next.o: rsinc.h optinc.h scrollbar-plain.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h -scrollbar-plain.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../libev/ev++.h -scrollbar-plain.o: ../libev/ev.h callback.h scrollbar.h salloc.h libptytty.h -scrollbar-plain.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h +scrollbar-plain.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h +scrollbar-plain.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h +scrollbar-plain.o: salloc.h libptytty.h rxvtperl.h hookinc.h background.h +scrollbar-plain.o: rsinc.h optinc.h scrollbar-rxvt.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h -scrollbar-rxvt.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../libev/ev++.h -scrollbar-rxvt.o: ../libev/ev.h callback.h scrollbar.h salloc.h libptytty.h -scrollbar-rxvt.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h +scrollbar-rxvt.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h +scrollbar-rxvt.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h +scrollbar-rxvt.o: salloc.h libptytty.h rxvtperl.h hookinc.h background.h +scrollbar-rxvt.o: rsinc.h optinc.h scrollbar-xterm.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h -scrollbar-xterm.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../libev/ev++.h -scrollbar-xterm.o: ../libev/ev.h callback.h scrollbar.h salloc.h libptytty.h -scrollbar-xterm.o: rxvtperl.h hookinc.h background.h rsinc.h optinc.h +scrollbar-xterm.o: rxvtfont.h rxvttoolkit.h ev_cpp.h ../config.h +scrollbar-xterm.o: ../libev/ev++.h ../libev/ev.h callback.h scrollbar.h +scrollbar-xterm.o: salloc.h libptytty.h rxvtperl.h hookinc.h background.h +scrollbar-xterm.o: rsinc.h optinc.h scrollbar.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -scrollbar.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -scrollbar.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +scrollbar.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +scrollbar.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h scrollbar.o: background.h rsinc.h optinc.h xdefaults.o: ../config.h rxvt.h feature.h encoding.h rxvtutil.h rxvtfont.h -xdefaults.o: rxvttoolkit.h ev_cpp.h ../libev/ev++.h ../libev/ev.h callback.h -xdefaults.o: scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h +xdefaults.o: rxvttoolkit.h ev_cpp.h ../config.h ../libev/ev++.h ../libev/ev.h +xdefaults.o: callback.h scrollbar.h salloc.h libptytty.h rxvtperl.h hookinc.h xdefaults.o: background.h rsinc.h optinc.h version.h keyboard.h -- 2.34.1