--- rxvt-unicode/doc/rxvt.7.man.in 2005/12/17 20:55:45 1.27 +++ rxvt-unicode/doc/rxvt.7.man.in 2006/01/16 15:12:48 1.48 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: .\" ======================================================================== @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "rxvt 7" -.TH rxvt 7 "2005-12-17" "5.9" "RXVT-UNICODE" +.TH rxvt 7 "2006-01-16" "7.0" "RXVT-UNICODE" .SH "NAME" RXVT REFERENCE \- FAQ, command sequences and other background information .SH "SYNOPSIS" @@ -158,10 +158,146 @@ . .SH "FREQUENTLY ASKED QUESTIONS" .IX Header "FREQUENTLY ASKED QUESTIONS" +.IP "The new selection selects pieces that are too big, how can I select single words?" 4 +.IX Item "The new selection selects pieces that are too big, how can I select single words?" +Yes. For example, if you want to select alphanumeric words, you can use +the following resource: +.Sp +.Vb 1 +\& URxvt.selection.pattern-0: ([[:word:]]+) +.Ve +.Sp +If you click more than twice, the selection will be extended +more and more. +.Sp +To get a selection that is very similar to the old code, try this pattern: +.Sp +.Vb 1 +\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+) +.Ve +.Sp +Please also note that the \fILeftClick Shift-LeftClik\fR combination also +selects words like the old code. +.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4 +.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" +You can disable the perl extension completely by setting the +\&\fBperl-ext-common\fR resource to the empty string, which also keeps +rxvt-unicode from initialising perl, saving memory. +.Sp +If you only want to disable specific features, you first have to +identify which perl extension is responsible. For this, read the section +\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. For +example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify +this \fBperl-ext-common\fR resource: +.Sp +.Vb 1 +\& URxvt.perl-ext-common: default,-selection-popup,-option-popup +.Ve +.Sp +This will keep the default extensions, but disable the two popup +extensions. Some extensions can also be configured, for example, +scrollback search mode is triggered by \fBM\-s\fR. You can move it to any +other combination either by setting the \fBsearchable-scrollback\fR resource: +.Sp +.Vb 1 +\& URxvt.searchable-scrollback: CM-s +.Ve +.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 +.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" +I often get asked about this, and I think, no, they didn't cause extra +bloat. If you compare a minimal rxvt and a minimal urxvt, you can see +that the urxvt binary is larger (due to some encoding tables always being +compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even +with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many +features unique to urxvt (locale, encoding conversion, iso14755 etc.) are +already in use in this mode. +.Sp +.Vb 3 +\& text data bss drs rss filename +\& 98398 1664 24 15695 1824 rxvt --disable-everything +\& 188985 9048 66616 18222 1788 urxvt --disable-everything +.Ve +.Sp +When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which _is_ unfair, as this involves xft +and full locale/XIM support which are quite bloaty inside libX11 and my +libc), the two diverge, but not unreasnobaly so. +.Sp +.Vb 3 +\& text data bss drs rss filename +\& 163431 2152 24 20123 2060 rxvt --enable-everything +\& 1035683 49680 66648 29096 3680 urxvt --enable-everything +.Ve +.Sp +The very large size of the text section is explained by the east-asian +encoding tables, which, if unused, take up disk space but nothing else +and can be compiled out unless you rely on X11 core fonts that use those +encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++ +compiler allocates (but of course doesn't use unless you are out of +memory). Also, using an xft font instead of a core font immediately adds a +few megabytes of \s-1RSS\s0. Xft indeed is responsible for a lot of \s-1RSS\s0 even when +not used. +.Sp +Of course, due to every character using two or four bytes instead of one, +a large scrollback buffer will ultimately make rxvt-unicode use more +memory. +.Sp +Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this +still fares rather well. And compared to some monsters like gnome-terminal +(21152k + extra 4204k in separate processes) or konsole (22200k + extra +43180k in daemons that stay around after exit, plus half a minute of +startup time, including the hundreds of warnings it spits out), it fares +extremely well *g*. +.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4 +.IX Item "Why , isn't that unportable/bloated/uncool?" +Is this a question? :) It comes up very often. The simple answer is: I had +to write it, and \*(C+ allowed me to write and maintain it in a fraction +of the time and effort (which is a scarce resource for me). Put even +shorter: It simply wouldn't exist without \*(C+. +.Sp +My personal stance on this is that \*(C+ is less portable than C, but in +the case of rxvt-unicode this hardly matters, as its portability limits +are defined by things like X11, pseudo terminals, locale support and unix +domain sockets, which are all less portable than \*(C+ itself. +.Sp +Regarding the bloat, see the above question: It's easy to write programs +in C that use gobs of memory, an certainly possible to write programs in +\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is +not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my +system with a minimal config: +.Sp +.Vb 4 +\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) +\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) +\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) +\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) +.Ve +.Sp +And here is rxvt\-unicode: +.Sp +.Vb 5 +\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) +\& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) +\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) +\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) +\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) +.Ve +.Sp +No large bloated libraries (of course, none were linked in statically), +except maybe libX11 :) +.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4 +.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?" +rxvt-unicode does not directly support tabs. It will work fine with +tabbing functionality of many window managers or similar tabbing programs, +and its embedding-features allow it to be embedded into other programs, +as witnessed by \fIdoc/rxvt\-tabbed\fR or the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl +module, which features a tabbed urxvt (murxvt) terminal as an example +embedding application. .IP "How do I know which rxvt-unicode version I'm using?" 4 .IX Item "How do I know which rxvt-unicode version I'm using?" The version number is displayed with the usage (\-h). Also the escape -sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. +sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When +using the @@RXVT_NAME@@c client, the version displayed is that of the +daemon. .IP "I am using Debian GNU/Linux and have a problem..." 4 .IX Item "I am using Debian GNU/Linux and have a problem..." The Debian GNU/Linux package of rxvt-unicode in sarge contains large @@ -177,6 +313,43 @@ probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a bug in the Debian version and it serves as a reminder for other users that might encounter the same issue. +.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4 +.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?" +You should build one binary with the default options. \fIconfigure\fR +now enables most useful options, and the trend goes to making them +runtime\-switchable, too, so there is usually no drawback to enbaling them, +except higher disk and possibly memory usage. The perl interpreter should +be enabled, as important functionality (menus, selection, likely more in +the future) depends on it. +.Sp +You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources +system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful +behaviour. If your distribution aims at low memory, add an empty +\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the +perl interpreter disabled until the user enables it. +.Sp +If you can/want build more binaries, I recommend building a minimal +one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with +\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of +encodings built-in that increase download times and are rarely used). +.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4 +.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?" +Likely not. While I honestly try to make it secure, and am probably not +bad at it, I think it is simply unreasonable to expect all of freetype ++ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be +secure. Also, rxvt-unicode disables some options when it detects that it +runs setuid or setgid, which is not nice. Besides, with the embedded perl +interpreter the possibility for security problems easily multiplies. +.Sp +Elevated privileges are only required for utmp and pty operations on some +systems (for example, GNU/Linux doesn't need any extra privileges for +ptys, but some need it for utmp support). It is planned to mvoe this into +a forked handler process, but this is not yet done. +.Sp +So, while setuid/setgid operation is supported and not a problem on your +typical single-user-no-other-logins unix desktop, always remember that +its an awful lot of code, most of which isn't checked for security issues +regularly. .IP "When I log-in to another system it tells me about missing terminfo data?" 4 .IX Item "When I log-in to another system it tells me about missing terminfo data?" The terminal description used by rxvt-unicode is not as widely available @@ -604,7 +777,7 @@ terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: .Sp .Vb 1 -\& URxvt*imlocale: ja_JP.EUC-JP +\& URxvt.imlocale: ja_JP.EUC-JP .Ve .Sp Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still @@ -656,7 +829,7 @@ some editors prematurely may leave the mouse in mouse report mode. I've heard that tcsh may use mouse reporting unless it otherwise specified. A quick check is to see if cut/paste works when the Alt or Shift keys are -depressed. See @@RXVT_NAME@@(7) +depressed. .IP "What's with this bold/blink stuff?" 4 .IX Item "What's with this bold/blink stuff?" If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the @@ -761,7 +934,7 @@ \& $ @@RXVT_NAME@@ .Ve .Sp -Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7). +Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR. .Sp For an existing rxvt\-unicode: .Sp @@ -887,8 +1060,8 @@ .IX Header "DESCRIPTION" The rest of this document describes various technical aspects of \&\fBrxvt-unicode\fR. First the description of supported command sequences, -followed by menu and pixmap support and last by a description of all -features selectable at \f(CW\*(C`configure\*(C'\fR time. +followed by pixmap support and last by a description of all features +selectable at \f(CW\*(C`configure\*(C'\fR time. .SH "Definitions" .IX Header "Definitions" .ie n .IP "\fB\fB""c""\fB\fR" 4 @@ -1445,15 +1618,6 @@ l No mouse reporting. .TE -.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4 -.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4 -.IX Item "Ps = 10 (rxvt)" -.TS -l l . -h menuBar visible -l menuBar invisible -.TE - .ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 .el .IP "\fB\f(CBPs = 25\fB\fR" 4 .IX Item "Ps = 25" @@ -1584,6 +1748,15 @@ l Don't scroll to bottom when a key is pressed .TE +.ie n .IP "\fB\fB""Ps = 1021""\fB\fR (\fBrxvt\fR)" 4 +.el .IP "\fB\f(CBPs = 1021\fB\fR (\fBrxvt\fR)" 4 +.IX Item "Ps = 1021 (rxvt)" +.TS +l l . +h Bold/italic implies high intensity (see option -is) +l Font styles have no effect on intensity (Compile styles) +.TE + .ie n .IP "\fB\fB""Ps = 1047""\fB\fR" 4 .el .IP "\fB\f(CBPs = 1047\fB\fR" 4 .IX Item "Ps = 1047" @@ -1638,8 +1811,8 @@ Ps = 12 Change colour of text cursor foreground to Pt Ps = 13 Change colour of mouse foreground to Pt Ps = 17 Change colour of highlight characters to Pt -Ps = 18 Change colour of bold characters to Pt -Ps = 19 Change colour of underlined characters to Pt +Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] +Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] Ps = 20 Change default background to Pt Ps = 39 Change default foreground colour to Pt. Ps = 46 Change Log File to Pt unimplemented @@ -1647,393 +1820,22 @@ Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n Ps = 55 Log all scrollback buffer and all of screen to Pt Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). -Ps = 703 Menubar command Pt (Compile menubar). Ps = 704 Change colour of italic characters to Pt Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). +Ps = 706 Change colour of bold characters to Pt +Ps = 707 Change colour of underlined characters to Pt Ps = 710 Set normal fontset to Pt. Same as Ps = 50. Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). +Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). .TE .PP -.IX Xref "menuBar" -.SH "menuBar" -.IX Header "menuBar" -\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR -In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a -menuBar. -.PP -Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be -omitted: use \fB./\fR to specify a menu relative to the current menu. -.Sh "Overview of menuBar operation" -.IX Subsection "Overview of menuBar operation" -For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax -of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks: -.PP -At the top level is the current menuBar which is a member of a circular -linked-list of other such menuBars. -.PP -The menuBar acts as a parent for the various drop-down menus, which in -turn, may have labels, separator lines, menuItems and subMenus. -.PP -The menuItems are the useful bits: you can use them to mimic keyboard -input or even to send text or escape sequences back to rxvt. -.PP -The menuBar syntax is intended to provide a simple yet robust method of -constructing and manipulating menus and navigating through the -menuBars. -.PP -The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates -the menuBar called \fIname\fR and allows access. You may now or menus, -subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the -menuBar access as \fBreadonly\fR to prevent accidental corruption of the -menus. To re-access the current menuBar for alterations, use the tag -\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR -.PP - -.IX Xref "menuBarCommands" -.Sh "Commands" -.IX Subsection "Commands" -.IP "\fB[menu:+\f(BIname\fB]\fR" 4 -.IX Item "[menu:+name]" -access the named menuBar for creation or alteration. If a new menuBar -is created, it is called \fIname\fR (max of 15 chars) and the current -menuBar is pushed onto the stack -.IP "\fB[menu]\fR" 4 -.IX Item "[menu]" -access the current menuBar for alteration -.IP "\fB[title:+\f(BIstring\fB]\fR" 4 -.IX Item "[title:+string]" -set the current menuBar's title to \fIstring\fR, which may contain the -following format specifiers: -.Sp -.Vb 3 -\& B<%n> rxvt name (as per the B<-name> command-line option) -\& B<%v> rxvt version -\& B<%%> literal B<%> character -.Ve -.IP "\fB[done]\fR" 4 -.IX Item "[done]" -set menuBar access as \fBreadonly\fR. -End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations. -.IP "\fB[read:+\f(BIfile\fB]\fR" 4 -.IX Item "[read:+file]" -read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be -appended if required.) Start reading at a line with \fB[menu]\fR or \fB[menu:+\f(BIname\fB\fR and continuing until \fB[done]\fR is encountered. -.Sp -Blank and comment lines (starting with \fB#\fR) are ignored. Actually, -since any invalid menu commands are also ignored, almost anything could -be construed as a comment line, but this may be tightened up in the -future ... so don't count on it!. -.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4 -.IX Item "[read:+file;+name]" -The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with -\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or -\&\fB[done]\fR is encountered. -.IP "\fB[dump]\fR" 4 -.IX Item "[dump]" -dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for -later rereading. -.IP "\fB[rm:name]\fR" 4 -.IX Item "[rm:name]" -remove the named menuBar -.IP "\fB[rm] [rm:]\fR" 4 -.IX Item "[rm] [rm:]" -remove the current menuBar -.IP "\fB[rm*] [rm:*]\fR" 4 -.IX Item "[rm*] [rm:*]" -remove all menuBars -.IP "\fB[swap]\fR" 4 -.IX Item "[swap]" -swap the top two menuBars -.IP "\fB[prev]\fR" 4 -.IX Item "[prev]" -access the previous menuBar -.IP "\fB[next]\fR" 4 -.IX Item "[next]" -access the next menuBar -.IP "\fB[show]\fR" 4 -.IX Item "[show]" -Enable display of the menuBar -.IP "\fB[hide]\fR" 4 -.IX Item "[hide]" -Disable display of the menuBar -.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4 -.IX Item "[pixmap:+name]" -.PD 0 -.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4 -.IX Item "[pixmap:+name;scaling]" -.PD -(set the background pixmap globally -.Sp -\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR) -.IP "\fB[:+\f(BIcommand\fB:]\fR" 4 -.IX Item "[:+command:]" -ignore the menu readonly status and issue a \fIcommand\fR to or a menu or -menuitem or change the ; a useful shortcut for setting the quick arrows -from a menuBar. -.PP - -.IX Xref "menuBarAdd" -.Sh "Adding and accessing menus" -.IX Subsection "Adding and accessing menus" -The following commands may also be \fB+\fR prefixed. -.IP "\fB/+\fR" 4 -.IX Item "/+" -access menuBar top level -.IP "\fB./+\fR" 4 -.IX Item "./+" -access current menu level -.IP "\fB../+\fR" 4 -.IX Item "../+" -access parent menu (1 level up) -.IP "\fB../../\fR" 4 -.IX Item "../../" -access parent menu (multiple levels up) -.IP "\fB\f(BI/path/\fBmenu\fR" 4 -.IX Item "/path/menu" -add/access menu -.IP "\fB\f(BI/path/\fBmenu/*\fR" 4 -.IX Item "/path/menu/*" -add/access menu and clear it if it exists -.IP "\fB\f(BI/path/\fB{\-}\fR" 4 -.IX Item "/path/{-}" -add separator -.IP "\fB\f(BI/path/\fB{item}\fR" 4 -.IX Item "/path/{item}" -add \fBitem\fR as a label -.IP "\fB\f(BI/path/\fB{item} action\fR" 4 -.IX Item "/path/{item} action" -add/alter \fImenuitem\fR with an associated \fIaction\fR -.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4 -.IX Item "/path/{item}{right-text}" -add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text -and as the associated \fIaction\fR -.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4 -.IX Item "/path/{item}{rtext} action" -add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as -the right-justified text. -.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4 -.IX Item "Special characters in action must be backslash-escaped:" -\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR -.IP "or in control-character notation:" 4 -.IX Item "or in control-character notation:" -\&\fB^@, ^A .. ^Z .. ^_, ^?\fR -.PP -To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the -program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR), -the first of which will be stripped off and the balance directed to the -program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by -non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the -balance is sent back to rxvt. -.PP -As a convenience for the many Emacs-type editors, \fIaction\fR may start -with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be -appended if missed from \fBM\-x\fR commands. -.PP -As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or -quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed. -.IP "For example," 4 -.IX Item "For example," -\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR -.IP "and" 4 -.IX Item "and" -\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR -.PP -The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the -absence of a specified action, this text will be used as the \fIaction\fR -as well. -.IP "For example," 4 -.IX Item "For example," -\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR -.PP -The left label \fIis\fR necessary, since it's used for matching, but -implicitly hiding the left label (by using same name for both left and -right labels), or explicitly hiding the left label (by preceeding it -with a dot), makes it possible to have right-justified text only. -.IP "For example," 4 -.IX Item "For example," -\&\fB/File/{Open}{Open} Open-File-Action\fR -.IP "or hiding it" 4 -.IX Item "or hiding it" -\&\fB/File/{.anylabel}{Open} Open-File-Action\fR -.PP - -.IX Xref "menuBarRemove" -.Sh "Removing menus" -.IX Subsection "Removing menus" -.IP "\fB\-/*+\fR" 4 -.IX Item "-/*+" -remove all menus from the menuBar, the same as \fB[clear]\fR -.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4 -.IX Item "-+/pathmenu+" -remove menu -.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4 -.IX Item "-+/path{item}+" -remove item -.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4 -.IX Item "-+/path{-}" -remove separator) -.IP "\fB\-/path/menu/*\fR" 4 -.IX Item "-/path/menu/*" -remove all items, separators and submenus from menu -.PP - -.IX Xref "menuBarArrows" -.Sh "Quick Arrows" -.IX Subsection "Quick Arrows" -The menus also provide a hook for \fIquick arrows\fR to provide easier -user access. If nothing has been explicitly set, the default is to -emulate the curror keys. The syntax permits each arrow to be altered -individually or all four at once without re-entering their common -beginning/end text. For example, to explicitly associate cursor actions -with the arrows, any of the following forms could be used: -.IP "\fB+\f(BIRight\fB\fR" 4 -.IX Item "+Right" -.PD 0 -.IP "\fB+\f(BILeft\fB\fR" 4 -.IX Item "+Left" -.IP "\fB+\f(BIUp\fB\fR" 4 -.IX Item "+Up" -.IP "\fB+\f(BIDown\fB\fR" 4 -.IX Item "+Down" -.PD -Define actions for the respective arrow buttons -.IP "\fB+\f(BIBegin\fB\fR" 4 -.IX Item "+Begin" -.PD 0 -.IP "\fB+\f(BIEnd\fB\fR" 4 -.IX Item "+End" -.PD -Define common beginning/end parts for \fIquick arrows\fR which used in -conjunction with the above constructs -.IP "For example, define arrows individually," 4 -.IX Item "For example, define arrows individually," -.Vb 1 -\& \eE[A -.Ve -.Sp -.Vb 1 -\& \eE[B -.Ve -.Sp -.Vb 1 -\& \eE[C -.Ve -.Sp -.Vb 1 -\& \eE[D -.Ve -.IP "or all at once" 4 -.IX Item "or all at once" -.Vb 1 -\& \eE[AZ<>\eE[BZ<>\eE[CZ<>\eE[D -.Ve -.IP "or more compactly (factoring out common parts)" 4 -.IX Item "or more compactly (factoring out common parts)" -.Vb 1 -\& \eE[AZ<>BZ<>CZ<>D -.Ve -.PP - -.IX Xref "menuBarSummary" -.Sh "Command Summary" -.IX Subsection "Command Summary" -A short summary of the most \fIcommon\fR commands: -.IP "[menu:name]" 4 -.IX Item "[menu:name]" -use an existing named menuBar or start a new one -.IP "[menu]" 4 -.IX Item "[menu]" -use the current menuBar -.IP "[title:string]" 4 -.IX Item "[title:string]" -set menuBar title -.IP "[done]" 4 -.IX Item "[done]" -set menu access to readonly and, if reading from a file, signal \s-1EOF\s0 -.IP "[done:name]" 4 -.IX Item "[done:name]" -if reading from a file using [read:file;name] signal \s-1EOF\s0 -.IP "[rm:name]" 4 -.IX Item "[rm:name]" -remove named menuBar(s) -.IP "[rm] [rm:]" 4 -.IX Item "[rm] [rm:]" -remove current menuBar -.IP "[rm*] [rm:*]" 4 -.IX Item "[rm*] [rm:*]" -remove all menuBar(s) -.IP "[swap]" 4 -.IX Item "[swap]" -swap top two menuBars -.IP "[prev]" 4 -.IX Item "[prev]" -access the previous menuBar -.IP "[next]" 4 -.IX Item "[next]" -access the next menuBar -.IP "[show]" 4 -.IX Item "[show]" -map menuBar -.IP "[hide]" 4 -.IX Item "[hide]" -unmap menuBar -.IP "[pixmap;file]" 4 -.IX Item "[pixmap;file]" -.PD 0 -.IP "[pixmap;file;scaling]" 4 -.IX Item "[pixmap;file;scaling]" -.PD -set a background pixmap -.IP "[read:file]" 4 -.IX Item "[read:file]" -.PD 0 -.IP "[read:file;name]" 4 -.IX Item "[read:file;name]" -.PD -read in a menu from a file -.IP "[dump]" 4 -.IX Item "[dump]" -dump out all menuBars to /tmp/rxvt\-PID -.IP "/" 4 -access menuBar top level -.IP "./" 4 -.PD 0 -.IP "../" 4 -.IP "../../" 4 -.PD -access current or parent menu level -.IP "/path/menu" 4 -.IX Item "/path/menu" -add/access menu -.IP "/path/{\-}" 4 -.IX Item "/path/{-}" -add separator -.IP "/path/{item}{rtext} action" 4 -.IX Item "/path/{item}{rtext} action" -add/alter menu item -.IP "\-/*" 4 -remove all menus from the menuBar -.IP "\-/path/menu" 4 -.IX Item "-/path/menu" -remove menu items, separators and submenus from menu -.IP "\-/path/menu" 4 -.IX Item "-/path/menu" -remove menu -.IP "\-/path/{item}" 4 -.IX Item "-/path/{item}" -remove item -.IP "\-/path/{\-}" 4 -.IX Item "-/path/{-}" -remove separator -.IP "BeginRightLeftUpDownEnd" 4 -.IX Item "BeginRightLeftUpDownEnd" -menu quick arrows +.IX Xref "XPM" .SH "XPM" .IX Header "XPM" For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value @@ -2300,11 +2102,11 @@ Write user and tty to lastlog file (used by programs like \&\fIlastlogin\fR) at start of rxvt execution. This option requires \&\-\-enable\-utmp to also be specified. -.IP "\-\-enable\-xpm\-background (default: off)" 4 -.IX Item "--enable-xpm-background (default: off)" +.IP "\-\-enable\-xpm\-background (default: on)" 4 +.IX Item "--enable-xpm-background (default: on)" Add support for \s-1XPM\s0 background pixmaps. -.IP "\-\-enable\-transparency (default: off)" 4 -.IX Item "--enable-transparency (default: off)" +.IP "\-\-enable\-transparency (default: on)" 4 +.IX Item "--enable-transparency (default: on)" Add support for inheriting parent backgrounds thus giving a fake transparency to the term. .IP "\-\-enable\-fading (default: on)" 4 @@ -2313,10 +2115,6 @@ .IP "\-\-enable\-tinting (default: on)" 4 .IX Item "--enable-tinting (default: on)" Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). -.IP "\-\-enable\-menubar (default: off)" 4 -.IX Item "--enable-menubar (default: off)" -Add support for our menu bar system (this interacts badly with -dynamic locale switching currently). .IP "\-\-enable\-rxvt\-scroll (default: on)" 4 .IX Item "--enable-rxvt-scroll (default: on)" Add support for the original rxvt scrollbar. @@ -2349,22 +2147,6 @@ .IP "\-\-disable\-resources" 4 .IX Item "--disable-resources" Removes any support for resource checking. -.IP "\-\-enable\-xgetdefault" 4 -.IX Item "--enable-xgetdefault" -Make resources checking via \fIXGetDefault()\fR instead of our small -version which only checks ~/.Xdefaults, or if that doesn't exist then -~/.Xresources. -.Sp -Please note that nowadays, things like \s-1XIM\s0 will automatically pull in and -use the full X resource manager, so the overhead of using it might be very -small, if nonexistant. -.IP "\-\-enable\-strings (default: off)" 4 -.IX Item "--enable-strings (default: off)" -Add support for our possibly faster \fImemset()\fR function and other -various routines, overriding your system's versions which may -have been hand-crafted in assembly or may require extra libraries -to link in. (this breaks ANSI-C rules and has problems on many -GNU/Linux systems). .IP "\-\-disable\-swapscreen" 4 .IX Item "--disable-swapscreen" Remove support for secondary/swap screen. @@ -2377,20 +2159,24 @@ A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly in combination with other switches) is: .Sp -.Vb 13 +.Vb 17 \& MWM-hints \& EWMH-hints (pid, utf8 names) and protocols (ping) -\& seperate underline colour -\& settable border widths and borderless switch -\& settable extra linespacing +\& seperate underline colour (-underlineColor) +\& settable border widths and borderless switch (-w, -b, -bl) +\& settable extra linespacing /-lsp) \& iso-14755-2 and -3, and visual feedback \& backindex and forwardindex escape sequence \& window op and some xterm/OSC escape sequences -\& tripleclickwords -\& settable insecure mode +\& tripleclickwords (-tcw) +\& settable insecure mode (-insecure) \& keysym remapping support -\& cursor blinking and underline cursor -\& -embed and -pty-fd options +\& cursor blinking and underline cursor (-cb, -uc) +\& XEmbed support (-embed) +\& user-pty (-pty-fd) +\& hold on exit (-hold) +\& skip builtin block graphics (-sbg) +\& sgr modes 90..97 and 100..107 .Ve .IP "\-\-enable\-iso14755 (default: on)" 4 .IX Item "--enable-iso14755 (default: on)" @@ -2434,6 +2220,13 @@ .IP "\-\-enable\-pointer\-blank (default: on)" 4 .IX Item "--enable-pointer-blank (default: on)" Add support to have the pointer disappear when typing or inactive. +.IP "\-\-enable\-perl (default: off)" 4 +.IX Item "--enable-perl (default: off)" +Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR +manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files +in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The +perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment +variable when running configure. .IP "\-\-with\-name=NAME (default: urxvt)" 4 .IX Item "--with-name=NAME (default: urxvt)" Set the basename for the installed binaries, resulting