=head1 NAME RXVT TECHNICAL REFERENCE - command sequences and background information =head1 SYNOPSIS # set a new font set printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" # change the locale and tell rxvt-unicode about it export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007" # set window title printf '\33]2;%s\007' "new window title" =head1 DESCRIPTION The rest of this document describes various technical aspects of B. First the description of supported command sequences, followed by menu and pixmap support and last by a description of all features selectable at C time. =head1 RXVT TECHNICAL REFERENCE =head1 Definitions =over 4 =item B<< C >> The literal character c. =item B<< C >> A single (required) character. =item B<< C >> A single (usually optional) numeric parameter, composed of one or more digits. =item B<< C >> A multiple numeric parameter composed of any number of single numeric parameters, separated by C<;> character(s). =item B<< C >> A text parameter composed of printable characters. =back =head1 Values =over 4 =item B<< C >> Enquiry (Ctrl-E) = Send Device Attributes (DA) request attributes from terminal. See B<< C >>. =item B<< C >> Bell (Ctrl-G) =item B<< C >> Backspace (Ctrl-H) =item B<< C >> Horizontal Tab (HT) (Ctrl-I) =item B<< C >> Line Feed or New Line (NL) (Ctrl-J) =item B<< C >> Vertical Tab (Ctrl-K) same as B<< C >> =item B<< C >> Form Feed or New Page (NP) (Ctrl-L) same as B<< C >> =item B<< C >> Carriage Return (Ctrl-M) =item B<< C >> Shift Out (Ctrl-N), invokes the G1 character set. Switch to Alternate Character Set =item B<< C >> Shift In (Ctrl-O), invokes the G0 character set (the default). Switch to Standard Character Set =item B<< C >> Space Character =back =head1 Escape Sequences =over 4 =item B<< C >> DEC Screen Alignment Test (DECALN) =item B<< C >> Save Cursor (SC) =item B<< C >> Restore Cursor =item B<< C >> Application Keypad (SMKX). See also next sequence. =item B<<< C<< ESC >> >>> Normal Keypad (RMKX) B If the numeric keypad is activated, eg, B has been pressed, numbers or control functions are generated by the numeric keypad (see Key Codes). =item B<< C >> Index (IND) =item B<< C >> Next Line (NEL) =item B<< C >> Tab Set (HTS) =item B<< C >> Reverse Index (RI) =item B<< C >> Single Shift Select of G2 Character Set (SS2): affects next character only I =item B<< C >> Single Shift Select of G3 Character Set (SS3): affects next character only I =item B<< C >> Obsolete form of returns: B<< C >> I =item B<< C >> Full reset (RIS) =item B<< C >> Invoke the G2 Character Set (LS2) =item B<< C >> Invoke the G3 Character Set (LS3) =item B<< C ( C> >> Designate G0 Character Set (ISO 2022), see below for values of C. =item B<< C ) C> >> Designate G1 Character Set (ISO 2022), see below for values of C. =item B<< C >> Designate G2 Character Set (ISO 2022), see below for values of C. =item B<< C >> Designate G3 Character Set (ISO 2022), see below for values of C. =item B<< C >> Designate Kanji Character Set Where B<< C >> is one of: =begin table C = C<0> DEC Special Character and Line Drawing Set C = C United Kingdom (UK) C = C United States (USASCII) C = C<< < >> Multinational character set I C = C<5> Finnish character set I C = C Finnish character set I C = C German character set I =end table =back X =head1 CSI (Command Sequence Introducer) Sequences =over 4 =item B<< C >> Insert B<< C >> (Blank) Character(s) [default: 1] (ICH)X =item B<< C >> Cursor Up B<< C >> Times [default: 1] (CUU) =item B<< C >> Cursor Down B<< C >> Times [default: 1] (CUD)X =item B<< C >> Cursor Forward B<< C >> Times [default: 1] (CUF) =item B<< C >> Cursor Backward B<< C >> Times [default: 1] (CUB) =item B<< C >> Cursor Down B<< C >> Times [default: 1] and to first column =item B<< C >> Cursor Up B<< C >> Times [default: 1] and to first columnX =item B<< C >> Cursor to Column B<< C >> (HPA) =item B<< C >> Cursor Position [row;column] [default: 1;1] (CUP) =item B<< C >> Move forward B<< C >> tab stops [default: 1] =item B<< C >> Erase in Display (ED) =begin table B<< C >> Clear Below (default) B<< C >> Clear Above B<< C >> Clear All =end table =item B<< C >> Erase in Line (EL) =begin table B<< C >> Clear to Right (default) B<< C >> Clear to Left B<< C >> Clear All =end table =item B<< C >> Insert B<< C >> Line(s) [default: 1] (IL) =item B<< C >> Delete B<< C >> Line(s) [default: 1] (DL) =item B<< C >> Delete B<< C >> Character(s) [default: 1] (DCH) =item B<< C >> Initiate . I Parameters are [func;startx;starty;firstrow;lastrow]. =item B<< C >> Tabulator functions =begin table B<< C >> Tab Set (HTS) B<< C >> Tab Clear (TBC), Clear Current Column (default) B<< C >> Tab Clear (TBC), Clear All =end table =item B<< C >> Erase B<< C >> Character(s) [default: 1] (ECH) =item B<< C >> Move backward B<< C >> [default: 1] tab stops =item B<< C >> See B<< C >> =item B<< C >> See B<< C >> =item B<< C >> Send Device Attributes (DA) B<< C >> (or omitted): request attributes from terminal returns: B<< C >> (``I am a VT100 with Advanced Video Option'') =item B<< C >> Cursor to Line B<< C >> (VPA) =item B<< C >> See B<< C >> =item B<< C >> Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] =item B<< C >> Tab Clear (TBC) =begin table B<< C >> Clear Current Column (default) B<< C >> Clear All (TBC) =end table =item B<< C >> Set Mode (SM). See B<< C >> sequence for description of C. =item B<< C >> Printing. See also the C resource. =begin table B<< C >> print screen (MC0) B<< C >> disable transparent print mode (MC4) B<< C >> enable transparent print mode (MC5) =end table =item B<< C >> Reset Mode (RM) =over 4 =item B<< C >> =begin table B<< C >> Insert Mode (SMIR) B<< C >> Replace Mode (RMIR) =end table =item B<< C >> (partially implemented) =begin table B<< C >> Automatic Newline (LNM) B<< C >> Normal Linefeed (LNM) =end table =back =item B<< C >> Character Attributes (SGR) =begin table B<< C >> Normal (default) B<< C >> On / Off Bold (bright fg) B<< C >> On / Off Italic B<< C >> On / Off Underline B<< C >> On / Off Slow Blink (bright bg) B<< C >> On / Off Rapid Blink (bright bg) B<< C >> On / Off Inverse B<< C >> On / Off Invisible (NYI) B<< C >> fg/bg Black B<< C >> fg/bg Red B<< C >> fg/bg Green B<< C >> fg/bg Yellow B<< C >> fg/bg Blue B<< C >> fg/bg Magenta B<< C >> fg/bg Cyan B<< C >> set fg/bg to color #m (ISO 8613-6) B<< C >> fg/bg White B<< C >> fg/bg Default B<< C >> fg/bg Bright Black B<< C >> fg/bg Bright Red B<< C >> fg/bg Bright Green B<< C >> fg/bg Bright Yellow B<< C >> fg/bg Bright Blue B<< C >> fg/bg Bright Magenta B<< C >> fg/bg Bright Cyan B<< C >> fg/bg Bright White B<< C >> fg/bg Bright Default =end table =item B<< C >> Device Status Report (DSR) =begin table B<< C >> Status Report B<< C >> (``OK'') B<< C >> Report Cursor Position (CPR) [row;column] as B<< C >> B<< C >> Request Display Name B<< C >> Request Version Number (place in window title) =end table =item B<< C >> Set Scrolling Region [top;bottom] [default: full size of window] (CSR) =item B<< C >> Save Cursor (SC) =item B<< C >> Request Terminal Parameters (DECREQTPARM) =item B<< C >> Restore Cursor =back X =head1 DEC Private Modes =over 4 =item B<< C >> DEC Private Mode Set (DECSET) =item B<< C >> DEC Private Mode Reset (DECRST) =item B<< C >> Restore previously saved DEC Private Mode Values. =item B<< C >> Save DEC Private Mode Values. =item B<< C >> Toggle DEC Private Mode Values (rxvt extension). I =over 4 =item B<< C >> (DECCKM) =begin table B<< C >> Application Cursor Keys B<< C >> Normal Cursor Keys =end table =item B<< C >> (ANSI/VT52 mode) =begin table B<< C >> Enter VT52 mode B<< C >> Enter VT52 mode =end table =item B<< C >> =begin table B<< C >> 132 Column Mode (DECCOLM) B<< C >> 80 Column Mode (DECCOLM) =end table =item B<< C >> =begin table B<< C >> Smooth (Slow) Scroll (DECSCLM) B<< C >> Jump (Fast) Scroll (DECSCLM) =end table =item B<< C >> =begin table B<< C >> Reverse Video (DECSCNM) B<< C >> Normal Video (DECSCNM) =end table =item B<< C >> =begin table B<< C >> Origin Mode (DECOM) B<< C >> Normal Cursor Mode (DECOM) =end table =item B<< C >> =begin table B<< C >> Wraparound Mode (DECAWM) B<< C >> No Wraparound Mode (DECAWM) =end table =item B<< C >> I =begin table B<< C >> Auto-repeat Keys (DECARM) B<< C >> No Auto-repeat Keys (DECARM) =end table =item B<< C >> X10 XTerm =begin table B<< C >> Send Mouse X & Y on button press. B<< C >> No mouse reporting. =end table =item B<< C >> (B) =begin table B<< C >> menuBar visible B<< C >> menuBar invisible =end table =item B<< C >> =begin table B<< C >> Visible cursor {cnorm/cvvis} B<< C >> Invisible cursor {civis} =end table =item B<< C >> =begin table B<< C >> scrollBar visisble B<< C >> scrollBar invisisble =end table =item B<< C >> (B) =begin table B<< C >> Allow XTerm Shift+key sequences B<< C >> Disallow XTerm Shift+key sequences =end table =item B<< C >> I Enter Tektronix Mode (DECTEK) =item B<< C >> =begin table B<< C >> Allow 80/132 Mode B<< C >> Disallow 80/132 Mode =end table =item B<< C >> I =begin table B<< C >> Turn On Margin Bell B<< C >> Turn Off Margin Bell =end table =item B<< C >> I =begin table B<< C >> Reverse-wraparound Mode B<< C >> No Reverse-wraparound Mode =end table =item B<< C >> I =item B<< C >> =begin table B<< C >> Use Alternate Screen Buffer B<< C >> Use Normal Screen Buffer =end table X =item B<< C >> =begin table B<< C >> Application Keypad (DECPAM) == C B<< C >> Normal Keypad (DECPNM) == C<< ESC > >> =end table =item B<< C >> =begin table B<< C >> Backspace key sends B<< C (DECBKM) >> B<< C >> Backspace key sends B<< C >> =end table =item B<< C >> (X11 XTerm) =begin table B<< C >> Send Mouse X & Y on button press and release. B<< C >> No mouse reporting. =end table =item B<< C >> (X11 XTerm) I =begin table B<< C >> Use Hilite Mouse Tracking. B<< C >> No mouse reporting. =end table =item B<< C >> (B) =begin table B<< C >> Don't scroll to bottom on TTY output B<< C >> Scroll to bottom on TTY output =end table =item B<< C >> (B) =begin table B<< C >> Scroll to bottom when a key is pressed B<< C >> Don't scroll to bottom when a key is pressed =end table =item B<< C >> =begin table B<< C >> Use Alternate Screen Buffer B<< C >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it =end table =item B<< C >> =begin table B<< C >> Save cursor position B<< C >> Restore cursor position =end table =item B<< C >> =begin table B<< C >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it B<< C >> Use Normal Screen Buffer =end table =back =back X =head1 XTerm Operating System Commands =over 4 =item B<< C >> Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any B can be escaped by prefixing it with SYN (0x16, ^V). =begin table B<< C >> Change Icon Name and Window Title to B<< C >> B<< C >> Change Icon Name to B<< C >> B<< C >> Change Window Title to B<< C >> B<< C >> If B<< C >> starts with a B<< C >>, query the (STRING) property of the window and return it. If B<< C >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. B<< C >> B<< C >> is a semi-colon separated sequence of one or more semi-colon separated B/B pairs, where B is an index to a colour and B is the name of a colour. Each pair causes the Bed colour to be changed to B. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white B<< C >> Change colour of text foreground to B<< C >> B<(NB: may change in future)> B<< C >> Change colour of text background to B<< C >> B<(NB: may change in future)> B<< C >> Change colour of text cursor foreground to B<< C >> B<< C >> Change colour of mouse foreground to B<< C >> B<< C >> Change colour of highlight characters to B<< C >> B<< C >> Change colour of bold characters to B<< C >> B<< C >> Change colour of underlined characters to B<< C >> B<< C >> Change default background to B<< C >> B<< C >> Change default foreground colour to B<< C >> I B<< C >> Change Log File to B<< C >> I B<< C >> Change default background colour to B<< C >> I B<< C >> Set fontset to B<< C >>, with the following special values of B<< C >> (B) B<< C<#+n> >> change up B<< C >> B<< C<#-n> >> change down B<< C >> if B<< C >> is missing of 0, a value of 1 is used I change to font0 B<< C >> change to font B<< C >> B<< C >> Log all scrollback buffer and all of screen to B<< C >> B<< C >> Change current locale to B<< C >>, or, if B<< C >> is B<< C >>, return the current locale (@@RXVT_NAME@@ extension) B<< C >> Menubar command B<< C >> I (rxvt-unicode extension) B<< C >> Change colour of italic characters to B<< C >> B<< C >> Change background pixmap tint colour to B<< C >> B<< C >> Set normal fontset to B<< C >>. Same as C. B<< C >> Set bold fontset to B<< C >>. Similar to C. B<< C >> Set italic fontset to B<< C >>. Similar to C. B<< C >> Set bold-italic fontset to B<< C >>. Similar to C. =end table =back X =head1 menuBar B<< The exact syntax used is I solidified. >> In the menus, B try to use menuBar commands that add or remove a menuBar. Note that in all of the commands, the B<< I >> I be omitted: use B<./> to specify a menu relative to the current menu. =head2 Overview of menuBar operation For the menuBar XTerm escape sequence C, the syntax of C can be used for a variety of tasks: At the top level is the current menuBar which is a member of a circular linked-list of other such menuBars. The menuBar acts as a parent for the various drop-down menus, which in turn, may have labels, separator lines, menuItems and subMenus. 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. The menuBar syntax is intended to provide a simple yet robust method of constructing and manipulating menus and navigating through the menuBars. The first step is to use the tag B<< [menu:I] >> which creates the menuBar called I and allows access. You may now or menus, subMenus, and menuItems. Finally, use the tag B<[done]> to set the menuBar access as B to prevent accidental corruption of the menus. To re-access the current menuBar for alterations, use the tag B<[menu]>, make the alterations and then use B<[done]> X =head2 Commands =over 4 =item B<< [menu:+I] >> access the named menuBar for creation or alteration. If a new menuBar is created, it is called I (max of 15 chars) and the current menuBar is pushed onto the stack =item B<[menu]> access the current menuBar for alteration =item B<< [title:+I] >> set the current menuBar's title to I, which may contain the following format specifiers: B<%%> : literal B<%> character B<%n> : rxvt name (as per the B<-name> command-line option) B<%v> : rxvt version =item B<[done]> set menuBar access as B. End-of-file tag for B<< [read:+I] >> operations. =item B<< [read:+I] >> read menu commands directly from I (extension ".menu" will be appended if required.) Start reading at a line with B<[menu]> or B<< [menu:+I >> and continuing until B<[done]> is encountered. Blank and comment lines (starting with B<#>) 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!. =item B<< [read:+I;+I] >> The same as B<< [read:+I] >>, but start reading at a line with B<< [menu:+I] >> and continuing until B<< [done:+I] >> or B<[done]> is encountered. =item B<[dump]> dump all menuBars to the file B in a format suitable for later rereading. =item B<[rm:name]> remove the named menuBar =item B<[rm] [rm:]> remove the current menuBar =item B<[rm*] [rm:*]> remove all menuBars =item B<[swap]> swap the top two menuBars =item B<[prev]> access the previous menuBar =item B<[next]> access the next menuBar =item B<[show]> Enable display of the menuBar =item B<[hide]> Disable display of the menuBar =item B<< [pixmap:+I] >> =item B<< [pixmap:+I;I] >> (set the background pixmap globally B<< A Future implementation I make this local to the menubar >>) =item B<< [:+I:] >> ignore the menu readonly status and issue a I to or a menu or menuitem or change the ; a useful shortcut for setting the quick arrows from a menuBar. =back X =head2 Adding and accessing menus The following commands may also be B<+> prefixed. =over 4 =item B access menuBar top level =item B<./+> access current menu level =item B<../+> access parent menu (1 level up) =item B<../../> access parent menu (multiple levels up) =item B<< Imenu >> add/access menu =item B<< Imenu/* >> add/access menu and clear it if it exists =item B<< I{-} >> add separator =item B<< I{item} >> add B as a label =item B<< I{item} action >> add/alter I with an associated I =item B<< I{item}{right-text} >> add/alter I with B as the right-justified text and as the associated I =item B<< I{item}{rtext} action >> add/alter I with an associated I and with B as the right-justified text. =back =over 4 =item Special characters in I must be backslash-escaped: B<\a \b \E \e \n \r \t \octal> =item or in control-character notation: B<^@, ^A .. ^Z .. ^_, ^?> =back To send a string starting with a B (B<^@>) character to the program, start I with a pair of B characters (B<^@^@>), the first of which will be stripped off and the balance directed to the program. Otherwise if I begins with B followed by non-+B characters, the leading B is stripped off and the balance is sent back to rxvt. As a convenience for the many Emacs-type editors, I may start with B (eg, B is equivalent to B<\E$>) and a B will be appended if missed from B commands. As a convenience for issuing XTerm B sequences from a menubar (or quick arrow), a B (B<^G>) will be appended if needed. =over 4 =item For example, B is equivalent to B<\Exapropos\r> =item and B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a> =back The option B<< {I} >> will be right-justified. In the absence of a specified action, this text will be used as the I as well. =over 4 =item For example, B is equivalent to B =back The left label I 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. =over 4 =item For example, B =item or hiding it B =back X =head2 Removing menus =over 4 =item B<< -/*+ >> remove all menus from the menuBar, the same as B<[clear]> =item B<< -+Imenu+ >> remove menu =item B<< -+I{item}+ >> remove item =item B<< -+I{-} >> remove separator) =item B<-/path/menu/*> remove all items, separators and submenus from menu =back X =head2 Quick Arrows The menus also provide a hook for I 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: =over 4 =item B<< +I >> =item B<< +I >> =item B<< +I >> =item B<< +I >> Define actions for the respective arrow buttons =item B<< +I >> =item B<< +I >> Define common beginning/end parts for I which used in conjunction with the above constructs =back =over 4 =item For example, define arrows individually, \E[A \E[B \E[C \E[D =item or all at once \E[AZ<>\E[BZ<>\E[CZ<>\E[D =item or more compactly (factoring out common parts) \E[AZ<>BZ<>CZ<>D =back X =head2 Command Summary A short summary of the most I commands: =over 4 =item [menu:name] use an existing named menuBar or start a new one =item [menu] use the current menuBar =item [title:string] set menuBar title =item [done] set menu access to readonly and, if reading from a file, signal EOF =item [done:name] if reading from a file using [read:file;name] signal EOF =item [rm:name] remove named menuBar(s) =item [rm] [rm:] remove current menuBar =item [rm*] [rm:*] remove all menuBar(s) =item [swap] swap top two menuBars =item [prev] access the previous menuBar =item [next] access the next menuBar =item [show] map menuBar =item [hide] unmap menuBar =item [pixmap;file] =item [pixmap;file;scaling] set a background pixmap =item [read:file] =item [read:file;name] read in a menu from a file =item [dump] dump out all menuBars to /tmp/rxvt-PID =item / access menuBar top level =item ./ =item ../ =item ../../ access current or parent menu level =item /path/menu add/access menu =item /path/{-} add separator =item /path/{item}{rtext} action add/alter menu item =item -/* remove all menus from the menuBar =item -/path/menu remove menu items, separators and submenus from menu =item -/path/menu remove menu =item -/path/{item} remove item =item -/path/{-} remove separator =item BeginRightLeftUpDownEnd menu quick arrows =back X =head1 XPM For the XPM XTerm escape sequence B<< C >> then value of B<< C >> can be the name of the background pixmap followed by a sequence of scaling/positioning commands separated by semi-colons. The scaling/positioning commands are as follows: =over 4 =item query scale/position B =item change scale and position B B (== B) B (same as B) B (same as B) B (same as B) B (same as B) =item change position (absolute) B<=+X+Y> B<=+X> (same as B<=+X+Y>) =item change position (relative) B<+X+Y> B<+X> (same as B<+X+Y>) =item rescale (relative) B -> B B<0xH> -> B =back For example: =over 4 =item B<\E]20;funky\a> load B as a tiled image =item B<\E]20;mona;100\a> load B with a scaling of 100% =item B<\E]20;;200;?\a> rescale the current pixmap to 200% and display the image geometry in the title =back X =head1 Mouse Reporting =over 4 =item B<< C<< ESC [ M >> >> report mouse position =back The lower 2 bits of B<< C<< >> >> indicate the button: =over 4 =item Button = B<< C<< ( - SPACE) & 3 >> >> =begin table 0 Button1 pressed 1 Button2 pressed 2 Button3 pressed 3 button released (X11 mouse report) =end table =back The upper bits of B<< C<< >> >> indicate the modifiers when the button was pressed and are added together (X11 mouse report only): =over 4 =item State = B<< C<< ( - SPACE) & 60 >> >> =begin table 4 Shift 8 Meta 16 Control 32 Double Click I<(Rxvt extension)> =end table Col = B<< C<< - SPACE >> >> Row = B<< C<< - SPACE >> >> =back X =head1 Key Codes Note: B + B-B generates B-B For the keypad, use B to temporarily override Application-Keypad setting use B to toggle Application-Keypad setting if B is off, toggle Application-Keypad setting. Also note that values of B, B, B may have been compiled differently on your system. =begin table B B B B Tab ^I ESC [ Z ^I ESC [ Z BackSpace ^H ^? ^? ^? Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ Insert ESC [ 2 ~ I ESC [ 2 ^ ESC [ 2 @ Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ Prior ESC [ 5 ~ I ESC [ 5 ^ ESC [ 5 @ Next ESC [ 6 ~ I ESC [ 6 ^ ESC [ 6 @ Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @ End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @ Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^ F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^ F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^ F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^ F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^ F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^ F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^ F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^ F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^ F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^ F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @ F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @ F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @ F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @ F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @ F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @ F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @ F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @ F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @ F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @ B Up ESC [ A ESC [ a ESC O a ESC O A Down ESC [ B ESC [ b ESC O b ESC O B Right ESC [ C ESC [ c ESC O c ESC O C Left ESC [ D ESC [ d ESC O d ESC O D KP_Enter ^M ESC O M KP_F1 ESC O P ESC O P KP_F2 ESC O Q ESC O Q KP_F3 ESC O R ESC O R KP_F4 ESC O S ESC O S XK_KP_Multiply * ESC O j XK_KP_Add + ESC O k XK_KP_Separator , ESC O l XK_KP_Subtract - ESC O m XK_KP_Decimal . ESC O n XK_KP_Divide / ESC O o XK_KP_0 0 ESC O p XK_KP_1 1 ESC O q XK_KP_2 2 ESC O r XK_KP_3 3 ESC O s XK_KP_4 4 ESC O t XK_KP_5 5 ESC O u XK_KP_6 6 ESC O v XK_KP_7 7 ESC O w XK_KP_8 8 ESC O x XK_KP_9 9 ESC O y =end table =head1 CONFIGURE OPTIONS General hint: if you get compile errors, then likely your configuration hasn't been tested well. Either try with --enable-everything or use the ./reconf script as a base for experiments. ./reconf is used by myself, so it should generally be a working config. Of course, you should always report when a combination doesn't work, so it can be fixed. Marc Lehmann . =over 4 =item --enable-everything Add support for all non-multichoice options listed in "./configure --help". Note that unlike other enable options this is order dependant. You can specify this and then disable options which this enables by I this with the appropriate commands. =item --enable-xft Add support for Xft (anti-aliases, among others) fonts. Xft fonts are slower and require lots of memory, but as long as you don't use them, you don't pay for them. =item --enable-font-styles Add support for B, I and B<< I >> font styles. The fonts can be set manually or automatically. =item --with-codesets=NAME,... Compile in support for additional codeset (encoding) groups (eu, vn are always compiled in, which includes most 8-bit character sets). These codeset tables are currently only used for driving X11 core fonts, they are not required for Xft fonts. Compiling them in will make your binary bigger (together about 700kB), but it doesn't increase memory usage unless you use an X11 font requiring one of these encodings. =begin table all all available codeset groups cn common chinese encodings cn_ext rarely used but very big chinese encodigs jp common japanese encodings jp_ext rarely used but big japanese encodings kr korean encodings =end table =item --enable-xim Add support for XIM (X Input Method) protocol. This allows using alternative input methods (e.g. kinput2) and will also correctly set up the input for people using dead keys or compose keys. =item --enable-unicode3 Enable direct support for displaying unicode codepoints above 65535 (the basic multilingual page). This increases storage requirements per character from 2 to 4 bytes. X11 fonts do not yet support these extra characters, but Xft does. Please note that rxvt-unicode can store unicode code points >65535 even without this flag, but the number of such characters is limited to a view thousand (shared with combining characters, see next switch), and right now rxvt-unicode cannot display them (input/output and cut&paste still work, though). =item --enable-combining Enable automatic composition of combining characters into composite characters. This is required for proper viewing of text where accents are encoded as seperate unicode characters. This is done by using precomposited characters when available or creating new pseudo-characters when no precomposed form exists. Without --enable-unicode3, the number of additional precomposed characters is rather limited (2048, if this is full, rxvt will use the private use area, extending the number of combinations to 8448). With --enable-unicode3, no practical limit exists. This will also enable storage of characters >65535. The combining table also contains entries for arabic presentation forms, but these are not currently used. Bug me if you want these to be used. =item --enable-fallback(=CLASS) When reading resource settings, also read settings for class CLASS (default: Rxvt). To disable resource fallback use --disable-fallback. =item --with-res-name=NAME Use the given name (default: urxvt) as default application name when reading resources. Specify --with-res-name=rxvt to replace rxvt. =item --with-res-class=CLASS Use the given class (default: URxvt) as default application class when reading resources. Specify --with-res-class=Rxvt to replace rxvt. =item --enable-utmp Write user and tty to utmp file (used by programs like F) at start of rxvt execution and delete information when rxvt exits. =item --enable-wtmp Write user and tty to wtmp file (used by programs like F) at start of rxvt execution and write logout when rxvt exits. This option requires --enable-utmp to also be specified. =item --enable-lastlog Write user and tty to lastlog file (used by programs like F) at start of rxvt execution. This option requires --enable-utmp to also be specified. =item --enable-xpm-background Add support for XPM background pixmaps. =item --enable-transparency Add support for inheriting parent backgrounds thus giving a fake transparency to the term. =item --enable-fading Add support for fading the text when focus is lost. =item --enable-tinting Add support for tinting of transparent backgrounds. =item --enable-menubar Add support for our menu bar system (this interacts badly with dynamic locale switching currently). =item --enable-rxvt-scroll Add support for the original rxvt scrollbar. =item --enable-next-scroll Add support for a NeXT-like scrollbar. =item --enable-xterm-scroll Add support for an Xterm-like scrollbar. =item --enable-plain-scroll Add support for a very unobtrusive, plain-looking scrollbar that is the favourite of the rxvt-unicode author, having used it for many years. =item --enable-half-shadow Make shadows on the scrollbar only half the normal width & height. only applicable to rxvt scrollbars. =item --enable-ttygid Change tty device setting to group "tty" - only use this if your system uses this type of security. =item --disable-backspace-key Disable any handling of the backspace key by us - let the X server do it. =item --disable-delete-key Disable any handling of the delete key by us - let the X server do it. =item --disable-resources Remove all resources checking. =item --enable-xgetdefault Make resources checking via XGetDefault() instead of our small version which only checks ~/.Xdefaults, or if that doesn't exist then ~/.Xresources. =item --enable-strings Add support for our possibly faster memset() 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). =item --disable-swapscreen Remove support for swap screen. =item --enable-frills Add support for many small features that are not essential but nice to have. Normally you want this, but for very small binaries you may want to disable this. =item --enable-iso14755 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or F). Basic support (section 5.1) is enabled by C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with this switch. =item --enable-linespace Add support to provide user specified line spacing between text rows. =item --enable-keepscrolling Add support for continual scrolling of the display when you hold the mouse button down on a scrollbar arrow. =item --enable-mousewheel Add support for scrolling via mouse wheel or buttons 4 & 5. =item --enable-slipwheeling Add support for continual scrolling (using the mouse wheel as an accelerator) while the control key is held down. This option requires --enable-mousewheel to also be specified. =item --disable-new-selection Remove support for mouse selection style like that of xterm. =item --enable-dmalloc Use Gray Watson's malloc - which is good for debugging See http://www.letters.com/dmalloc/ for details If you use either this or the next option, you may need to edit src/Makefile after compiling to point DINCLUDE and DLIB to the right places. You can only use either this option and the following (should you use either) . =item --enable-dlmalloc Use Doug Lea's malloc - which is good for a production version See L for details. =item --enable-smart-resize Add smart growth/shrink behaviour when changing font size via from hot keys. This should keep in a fixed position the rxvt corner which is closest to a corner of the screen. =item --enable-cursor-blink Add support for a blinking cursor. =item --enable-pointer-blank Add support to have the pointer disappear when typing or inactive. =item --with-name=NAME Set the basename for the installed binaries (default: urxvt, resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. =item --with-term=NAME Change the environmental variable for the terminal to NAME (default "rxvt") =item --with-terminfo=PATH Change the environmental variable for the path to the terminfo tree to PATH. =item --with-x Use the X Window System (pretty much default, eh?). =item --with-xpm-includes=DIR Look for the XPM includes in DIR. =item --with-xpm-library=DIR Look for the XPM library in DIR. =item --with-xpm Not needed - define via --enable-xpm-background. =back =head1 AUTHORS Marc Lehmann converted this document to pod and reworked it from the original Rxvt documentation, which was done by Geoff Wing , who in turn used the XTerm documentation and other sources.