RXVT TECHNICAL REFERENCE


Definitions

c >
The literal character c.

C >
A single (required) character.

Ps >
A single (usually optional) numeric parameter, composed of one or more digits.

Pm >
A multiple numeric parameter composed of any number of single numeric parameters, separated by ; character(s).

Pt >
A text parameter composed of printable characters.


Values

ENQ >
Enquiry (Ctrl-E) = Send Device Attributes (DA) request attributes from terminal. See ESC [ Ps c >.

BEL >
Bell (Ctrl-G)

BS >
Backspace (Ctrl-H)

TAB >
Horizontal Tab (HT) (Ctrl-I)

LF >
Line Feed or New Line (NL) (Ctrl-J)

VT >
Vertical Tab (Ctrl-K) same as LF >

FF >
Form Feed or New Page (NP) (Ctrl-L) same as LF >

CR >
Carriage Return (Ctrl-M)

SO >
Shift Out (Ctrl-N), invokes the G1 character set. Switch to Alternate Character Set

SI >
Shift In (Ctrl-O), invokes the G0 character set (the default). Switch to Standard Character Set

SPC >
Space Character


Escape Sequences

ESC # 8 >
DEC Screen Alignment Test (DECALN)

ESC 7 >
Save Cursor (SC)

ESC 8 >
Restore Cursor

ESC = >
Application Keypad (SMKX). See also next sequence.

ESC >>
Normal Keypad (RMKX)

Note: If the numeric keypad is activated, eg, Num_Lock has been pressed, numbers or control functions are generated by the numeric keypad (see Key Codes).

ESC D >
Index (IND)

ESC E >
Next Line (NEL)

ESC H >
Tab Set (HTS)

ESC M >
Reverse Index (RI)

ESC N >
Single Shift Select of G2 Character Set (SS2): affects next character only unimplemented

ESC O >
Single Shift Select of G3 Character Set (SS3): affects next character only unimplemented

ESC Z >
Obsolete form of returns: ESC[?1;2C > rxvt-unicode compile-time option

ESC c >
Full reset (RIS)

ESC n >
Invoke the G2 Character Set (LS2)

ESC o >
Invoke the G3 Character Set (LS3)

ESC(C >
Designate G0 Character Set (ISO 2022), see below for values of C.

ESC)C >
Designate G1 Character Set (ISO 2022), see below for values of C.

ESC * C >
Designate G2 Character Set (ISO 2022), see below for values of C.

ESC + C >
Designate G3 Character Set (ISO 2022), see below for values of C.

ESC $ C >
Designate Kanji Character Set

Where C > is one of:

C = 0 DEC Special Character and Line Drawing Set
C = A United Kingdom (UK)
C = B United States (USASCII)
C = <Multinational character set unimplemented
C = 5 Finnish character set unimplemented
C = C Finnish character set unimplemented
C = K German character set unimplemented


CSI (Code Sequence Introducer) Sequences

ESC [ Ps @ >
Insert Ps > (Blank) Character(s) [default: 1] (ICH)

ESC [ Ps A >
Cursor Up Ps > Times [default: 1] (CUU)

ESC [ Ps B >
Cursor Down Ps > Times [default: 1] (CUD)

ESC [ Ps C >
Cursor Forward Ps > Times [default: 1] (CUF)

ESC [ Ps D >
Cursor Backward Ps > Times [default: 1] (CUB)

ESC [ Ps E >
Cursor Down Ps > Times [default: 1] and to first column

ESC [ Ps F >
Cursor Up Ps > Times [default: 1] and to first column

ESC [ Ps G >
Cursor to Column Ps > (HPA)

ESC [ Ps;Ps H >
Cursor Position [row;column] [default: 1;1] (CUP)

ESC [ Ps I >
Move forward Ps > tab stops [default: 1]

ESC [ Ps J >
Erase in Display (ED)
Ps = 0Clear Below (default)
Ps = 1Clear Above
Ps = 2Clear All

ESC [ Ps K >
Erase in Line (EL)
Ps = 0Clear to Right (default)
Ps = 1Clear to Left
Ps = 2Clear All

ESC [ Ps L >
Insert Ps > Line(s) [default: 1] (IL)

ESC [ Ps M >
Delete Ps > Line(s) [default: 1] (DL)

ESC [ Ps P >
Delete Ps > Character(s) [default: 1] (DCH)

ESC [ Ps;Ps;Ps;Ps;Ps T >
Initiate . unimplemented Parameters are [func;startx;starty;firstrow;lastrow].

ESC [ Ps W >
Tabulator functions
Ps = 0Tab Set (HTS)
Ps = 2Tab Clear (TBC), Clear Current Column (default)
Ps = 5Tab Clear (TBC), Clear All

ESC [ Ps X >
Erase Ps > Character(s) [default: 1] (ECH)

ESC [ Ps Z >
Move backward Ps > [default: 1] tab stops

ESC [ Ps ' >
See ESC [ Ps G >

ESC [ Ps a >
See ESC [ Ps C >

ESC [ Ps c >
Send Device Attributes (DA) Ps = 0 > (or omitted): request attributes from terminal returns: ESC[?1;2c > (``I am a VT100 with Advanced Video Option'')

ESC [ Ps d >
Cursor to Line Ps > (VPA)

ESC [ Ps e >
See ESC [ Ps A >

ESC [ Ps;Ps f >
Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]

ESC [ Ps g >
Tab Clear (TBC)
Ps = 0Clear Current Column (default)
Ps = 3Clear All (TBC)

ESC [ Ps i >
Printing
Ps = 4disable transparent print mode (MC4)
Ps = 5enable transparent print mode (MC5) unimplemented

ESC [ Pm h >
Set Mode (SM). See next sequence for description of Pm.

ESC [ Pm l >
Reset Mode (RM)
Ps = 4 >
hInsert Mode (SMIR)
lReplace Mode (RMIR)
Ps = 20 > unimplemented
hAutomatic Newline (LNM)
hNormal Linefeed (LNM)
ESC [ Pm m >
Character Attributes (SGR)
Ps = 0Normal (default)
Ps = 1 / 22On / Off Bold (bright fg)
Ps = 4 / 24On / Off Underline
Ps = 5 / 25On / Off Blink (bright bg)
Ps = 7 / 27On / Off Inverse
Ps = 30 / 40fg/bg Black
Ps = 31 / 41fg/bg Red
Ps = 32 / 42fg/bg Green
Ps = 33 / 43fg/bg Yellow
Ps = 34 / 44fg/bg Blue
Ps = 35 / 45fg/bg Magenta
Ps = 36 / 46fg/bg Cyan
Ps = 37 / 47fg/bg White
Ps = 39 / 49fg/bg Default

ESC [ Ps n >
Device Status Report (DSR)
Ps = 5Status Report ESC [ 0 n (``OK'')
Ps = 6Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
Ps = 7Request Display Name
Ps = 8Request Version Number (place in window title)

ESC [ Ps;Ps r >
Set Scrolling Region [top;bottom] [default: full size of window] (CSR)

ESC [ s >
Save Cursor (SC)

ESC [ Ps x >
Request Terminal Parameters (DECREQTPARM)

ESC [ u >
Restore Cursor


DEC Private Modes

ESC [ ? Pm h >
DEC Private Mode Set (DECSET)

ESC [ ? Pm l >
DEC Private Mode Reset (DECRST)

ESC [ ? Pm r >
Restore previously saved DEC Private Mode Values.

ESC [ ? Pm s >
Save DEC Private Mode Values.

ESC [ ? Pm t >
Toggle DEC Private Mode Values (rxvt extension). where
Ps = 1 > (DECCKM)
hApplication Cursor Keys
lNormal Cursor Keys
Ps = 2 > (ANSI/VT52 mode)
hEnter VT52 mode
lEnter VT52 mode
Ps = 3 >
h132 Column Mode (DECCOLM)
l80 Column Mode (DECCOLM)
Ps = 4 >
hSmooth (Slow) Scroll (DECSCLM)
lJump (Fast) Scroll (DECSCLM)
Ps = 5 >
hReverse Video (DECSCNM)
lNormal Video (DECSCNM)
Ps = 6 >
hOrigin Mode (DECOM)
lNormal Cursor Mode (DECOM)
Ps = 7 >
hWraparound Mode (DECAWM)
lNo Wraparound Mode (DECAWM)
Ps = 8 > unimplemented
hAuto-repeat Keys (DECARM)
lNo Auto-repeat Keys (DECARM)
Ps = 9 > X10 XTerm
hSend Mouse X & Y on button press.
lNo mouse reporting.

Ps = 10 > (rxvt)
hvisible
linvisible
Ps = 25 >
hVisible cursor {cnorm/cvvis}
lInvisible cursor {civis}
Ps = 30 >
hscrollBar visisble
lscrollBar invisisble
Ps = 35 > (rxvt)
hAllow XTerm Shift+key sequences
lDisallow XTerm Shift+key sequences
Ps = 38 > unimplemented
Enter Tektronix Mode (DECTEK)

Ps = 40 >
hAllow 80/132 Mode
lDisallow 80/132 Mode
Ps = 44 > unimplemented
hTurn On Margin Bell
lTurn Off Margin Bell
Ps = 45 > unimplemented
hReverse-wraparound Mode
lNo Reverse-wraparound Mode
Ps = 46 > unimplemented
Ps = 47 >
hUse Alternate Screen Buffer
lUse Normal Screen Buffer

Ps = 66 >
hApplication Keypad (DECPAM) == ESC =
lNormal Keypad (DECPNM) == ESC >
Ps = 67 >
hBackspace key sends BS (DECBKM)
lBackspace key sends DEL
Ps = 1000 > (X11 XTerm)
hSend Mouse X & Y on button press and release.
lNo mouse reporting.
Ps = 1001 > (X11 XTerm) unimplemented
hUse Hilite Mouse Tracking.
lNo mouse reporting.
Ps = 1010 >
hDon't scroll to bottom on TTY output
lScroll to bottom on TTY output
Ps = 1011 >
hScroll to bottom when a key is pressed
lDon't scroll to bottom when a key is pressed
Ps = 1047 >
hUse Alternate Screen Buffer
lUse Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
Ps = 1048 >
hSave cursor position
lRestore cursor position


XTerm Operating System Commands

ESC ] Ps;Pt ST >
Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any octet can be escaped by prefixing it with SYN (0x16, ^V).
Ps = 0Change Icon Name and Window Title to Pt
Ps = 1Change Icon Name to Pt
Ps = 2Change Window Title to Pt
Ps = 3If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.
Ps = 4Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. 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
Ps = 10Change colour of text foreground to Pt (NB: may change in future)
Ps = 11Change colour of text background to Pt (NB: may change in future)
Ps = 12Change colour of text cursor foreground to Pt
Ps = 13Change colour of mouse foreground to Pt
Ps = 17Change colour of highlight characters to Pt
Ps = 18Change colour of bold characters to Pt
Ps = 19Change colour of underlined characters to Pt
Ps = 20Change default background to Pt
Ps = 39Change default foreground colour to Pt rxvt compile-time option
Ps = 46Change Log File to Pt unimplemented
Ps = 49Change default background colour to Pt rxvt compile-time option
Ps = 50Set 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 = 55Log all scrollback buffer and all of screen to Pt
Ps = 701Change current locale to Pt, or, if Pt is ?, return the current locale (rxvt extension)
Ps = 702find font for character, used for debugging (rxvt extension)
Ps = 703command Pt rxvt compile-time option (rxvt extension)


menuBar

The exact syntax used is almost solidified. > In the menus, DON'T try to use menuBar commands that add or remove a menuBar.

Note that in all of the commands, the /path/ > cannot be omitted: use ./ to specify a menu relative to the current menu.

Overview of menuBar operation

For the menuBar XTerm escape sequence ESC ] 703 ; Pt ST, the syntax of Pt 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 [menu:name] > which creates the menuBar called name and allows access. You may now or menus, subMenus, and menuItems. Finally, use the tag [done] to set the menuBar access as readonly to prevent accidental corruption of the menus. To re-access the current menuBar for alterations, use the tag [menu], make the alterations and then use [done]

Commands

[menu:+name] >
access the named menuBar for creation or alteration. If a new menuBar is created, it is called name (max of 15 chars) and the current menuBar is pushed onto the stack

[menu]
access the current menuBar for alteration

[title:+string] >
set the current menuBar's title to string, which may contain the following format specifiers: %% : literal % character %n : rxvt name (as per the -name command-line option) %v : rxvt version

[done]
set menuBar access as readonly. End-of-file tag for [read:+file] > operations.

[read:+file] >
read menu commands directly from file (extension ``.menu'' will be appended if required.) Start reading at a line with [menu] or < [menu:+name > and continuing until [done] is encountered.

Blank and comment lines (starting with #) 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!.

[read:+file;+name] >
The same as [read:+file] >, but start reading at a line with [menu:+name] > and continuing until [done:+name] > or [done] is encountered.

[dump]
dump all menuBars to the file /tmp/rxvt-PID in a format suitable for later rereading.

[rm:name]
remove the named menuBar

[rm] [rm:]
remove the current menuBar

[rm*] [rm:*]
remove all menuBars

[swap]
swap the top two menuBars

[prev]
access the previous menuBar

[next]
access the next menuBar

[show]
Enable display of the menuBar

[hide]
Disable display of the menuBar

[pixmap:+name] >
[pixmap:+name;scaling] >
(set the background pixmap globally

A Future implementation may make this local to the menubar >)

[:+command:] >
ignore the menu readonly status and issue a command to or a menu or menuitem or change the ; a useful shortcut for setting the quick arrows from a menuBar.

Adding and accessing menus

The following commands may also be + prefixed.

/+
access menuBar top level

./+
access current menu level

../+
access parent menu (1 level up)

../../
access parent menu (multiple levels up)

/path/menu >
add/access menu

/path/menu/* >
add/access menu and clear it if it exists

/path/{-} >
add separator

/path/{item} >
add item as a label

/path/{item} action >
add/alter menuitem with an associated action

/path/{item}{right-text} >
add/alter menuitem with right-text as the right-justified text and as the associated action

/path/{item}{rtext} action >
add/alter menuitem with an associated action and with rtext as the right-justified text.

Special characters in action must be backslash-escaped:
\a \b \E \e \n \r \t \octal

or in control-character notation:
^@, ^A .. ^Z .. ^_, ^?

To send a string starting with a NUL (^@) character to the program, start action with a pair of NUL characters (^@^@), the first of which will be stripped off and the balance directed to the program. Otherwise if action begins with NUL followed by non-+NUL characters, the leading NUL is stripped off and the balance is sent back to rxvt.

As a convenience for the many Emacs-type editors, action may start with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if missed from M-x commands.

As a convenience for issuing XTerm ESC] sequences from a menubar (or quick arrow), a BEL (^G) will be appended if needed.

For example,
M-xapropos is equivalent to \Exapropos\r

and
\E]703;mona;100 is equivalent to \E]703;mona;100\a

The option {right-rtext} > will be right-justified. In the absence of a specified action, this text will be used as the action as well.

For example,
/File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F

The left label is 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.

For example,
/File/{Open}{Open} Open-File-Action

or hiding it
/File/{.anylabel}{Open} Open-File-Action

Removing menus

-/*+ >
remove all menus from the menuBar, the same as [clear]

-+/pathmenu+ >
remove menu

-+/path{item}+ >
remove item

-+/path{-} >
remove separator)

-/path/menu/*
remove all items, separators and submenus from menu

Quick Arrows

The menus also provide a hook for quick arrows 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:

<r+Right >>
<l+Left >>
<u+Up >>
<d+Down >>
Define actions for the respective arrow buttons

<b+Begin >>
<e+End >>
Define common beginning/end parts for quick arrows which used in conjunction with the above <r> <l> <u> <d> constructs

For example, define arrows individually,
 <u>\E[A
 <d>\E[B
 <r>\E[C
 <l>\E[D
or all at once
 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
or more compactly (factoring out common parts)
 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D

Command Summary

A short summary of the most common commands:

[menu:name]
use an existing named menuBar or start a new one

[menu]
use the current menuBar

[title:string]
set menuBar title

[done]
set menu access to readonly and, if reading from a file, signal EOF

[done:name]
if reading from a file using [read:file;name] signal EOF

[rm:name]
remove named menuBar(s)

[rm] [rm:]
remove current menuBar

[rm*] [rm:*]
remove all menuBar(s)

[swap]
swap top two menuBars

[prev]
access the previous menuBar

[next]
access the next menuBar

[show]
map menuBar

[hide]
unmap menuBar

[pixmap;file]
[pixmap;file;scaling]
set a background pixmap

[read:file]
[read:file;name]
read in a menu from a file

[dump]
dump out all menuBars to /tmp/rxvt-PID

/
access menuBar top level

./
../
../../
access current or parent menu level

/path/menu
add/access menu

/path/{-}
add separator

/path/{item}{rtext} action
add/alter menu item

-/*
remove all menus from the menuBar

-/path/menu
remove menu items, separators and submenus from menu

-/path/menu
remove menu

-/path/{item}
remove item

-/path/{-}
remove separator

<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
menu quick arrows


XPM

For the XPM XTerm escape sequence ESC ] 20 ; Pt ST > then value of Pt > 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:

query scale/position
?

change scale and position
WxH+X+Y

WxH+X (== WxH+X+X)

WxH (same as WxH+50+50)

W+X+Y (same as WxW+X+Y)

W+X (same as WxW+X+X)

W (same as WxW+50+50)

change position (absolute)
=+X+Y

=+X (same as =+X+Y)

change position (relative)
+X+Y

+X (same as +X+Y)

rescale (relative)
Wx0 -> W *= (W/100)

0xH -> H *= (H/100)

For example:

\E]20;funky\a
load funky.xpm as a tiled image

\E]20;mona;100\a
load mona.xpm with a scaling of 100%

\E]20;;200;?\a
rescale the current pixmap to 200% and display the image geometry in the title


Mouse Reporting

ESC [ M <b> <x> <y> >
report mouse position

The lower 2 bits of <b> > indicate the button:

Button = (<b> - SPACE) & 3 >
0Button1 pressed
1Button2 pressed
2Button3 pressed
3button released (X11 mouse report)

The upper bits of <b> > indicate the modifiers when the button was pressed and are added together (X11 mouse report only):

State = (<b> - SPACE) & 60 >
4Shift
8Meta
16Control
32Double Click (Rxvt extension)

Col = <x> - SPACE >

Row = <y> - SPACE >


Key Codes

Note: Shift + F1-F10 generates F11-F20

For the keypad, use Shift to temporarily override Application-Keypad setting use Num_Lock to toggle Application-Keypad setting if Num_Lock is off, toggle Application-Keypad setting. Also note that values of Home, End, Delete may have been compiled differently on your system.

NormalShiftControlCtrl+Shift
Tab^IESC [ Z^IESC [ Z
BackSpace^H^?^?^?
FindESC [ 1 ~ESC [ 1 $ESC [ 1 ^ESC [ 1 @
InsertESC [ 2 ~pasteESC [ 2 ^ESC [ 2 @
ExecuteESC [ 3 ~ESC [ 3 $ESC [ 3 ^ESC [ 3 @
SelectESC [ 4 ~ESC [ 4 $ESC [ 4 ^ESC [ 4 @
PriorESC [ 5 ~scroll-upESC [ 5 ^ESC [ 5 @
NextESC [ 6 ~scroll-downESC [ 6 ^ESC [ 6 @
HomeESC [ 7 ~ESC [ 7 $ESC [ 7 ^ESC [ 7 @
EndESC [ 8 ~ESC [ 8 $ESC [ 8 ^ESC [ 8 @
DeleteESC [ 3 ~ESC [ 3 $ESC [ 3 ^ESC [ 3 @
F1ESC [ 11 ~ESC [ 23 ~ESC [ 11 ^ESC [ 23 ^
F2ESC [ 12 ~ESC [ 24 ~ESC [ 12 ^ESC [ 24 ^
F3ESC [ 13 ~ESC [ 25 ~ESC [ 13 ^ESC [ 25 ^
F4ESC [ 14 ~ESC [ 26 ~ESC [ 14 ^ESC [ 26 ^
F5ESC [ 15 ~ESC [ 28 ~ESC [ 15 ^ESC [ 28 ^
F6ESC [ 17 ~ESC [ 29 ~ESC [ 17 ^ESC [ 29 ^
F7ESC [ 18 ~ESC [ 31 ~ESC [ 18 ^ESC [ 31 ^
F8ESC [ 19 ~ESC [ 32 ~ESC [ 19 ^ESC [ 32 ^
F9ESC [ 20 ~ESC [ 33 ~ESC [ 20 ^ESC [ 33 ^
F10ESC [ 21 ~ESC [ 34 ~ESC [ 21 ^ESC [ 34 ^
F11ESC [ 23 ~ESC [ 23 $ESC [ 23 ^ESC [ 23 @
F12ESC [ 24 ~ESC [ 24 $ESC [ 24 ^ESC [ 24 @
F13ESC [ 25 ~ESC [ 25 $ESC [ 25 ^ESC [ 25 @
F14ESC [ 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 @
F17ESC [ 31 ~ESC [ 31 $ESC [ 31 ^ESC [ 31 @
F18ESC [ 32 ~ESC [ 32 $ESC [ 32 ^ESC [ 32 @
F19ESC [ 33 ~ESC [ 33 $ESC [ 33 ^ESC [ 33 @
F20ESC [ 34 ~ESC [ 34 $ESC [ 34 ^ESC [ 34 @
Application
UpESC [ AESC [ aESC O aESC O A
DownESC [ BESC [ bESC O bESC O B
RightESC [ CESC [ cESC O cESC O C
LeftESC [ DESC [ dESC O dESC O D
KP_Enter^MESC O M
KP_F1ESC O PESC O P
KP_F2ESC O QESC O Q
KP_F3ESC O RESC O R
KP_F4ESC O SESC 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_00ESC O p
XK_KP_11ESC O q
XK_KP_22ESC O r
XK_KP_33ESC O s
XK_KP_44ESC O t
XK_KP_55ESC O u
XK_KP_66ESC O v
XK_KP_77ESC O w
XK_KP_88ESC O x
XK_KP_99ESC O y


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 <rxvt@schmorp.de>.

--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 following this with the appropriate commands.

--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.

--with-codesets=NAME,...
Compile in support for additional codeset groups:
allall of the above
cncommon chinese encodings
cn_extrarely used but very big chinese encodigs
jpcommon japanese encodings
jp_extrarely used but big japanese encodings
krkorean encodings

--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.

--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).

--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.

--enable-fallback(=CLASS)
When reading resource settings, also read settings for class CLASS (default: Rxvt). To disable resource fallback use --disable-fallback.

--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.

--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.

--enable-utmp
Write user and tty to utmp file (used by programs like w) at start of rxvt execution and delete information when rxvt exits.

--enable-wtmp
Write user and tty to wtmp file (used by programs like last) at start of rxvt execution and write logout when rxvt exits. This option requires --enable-utmp to also be specified.

--enable-lastlog
Write user and tty to lastlog file (used by programs like lastlogin) at start of rxvt execution. This option requires --enable-utmp to also be specified.

--enable-xpm-background
Add support for XPM background pixmaps.

--enable-transparency
Add support for inheriting parent backgrounds thus giving a fake transparency to the term.

--enable-fading
Add support for fading the text when focus is lost.

--enable-tinting
Add support for tinting of transparent backgrounds.

--enable-menubar
Add support for our menu bar system (this interacts badly with dynamic locale switching currently).

--enable-rxvt-scroll
Add support for the original rxvt scrollbar.

--enable-next-scroll
Add support for a NeXT-like scrollbar.

--enable-xterm-scroll
Add support for an Xterm-like scrollbar.

--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.

--enable-half-shadow
Make shadows on the scrollbar only half the normal width & height. only applicable to rxvt scrollbars.

--enable-ttygid
Change tty device setting to group ``tty'' - only use this if your system uses this type of security.

--disable-backspace-key
Disable any handling of the backspace key by us - let the X server do it.

--disable-delete-key
Disable any handling of the delete key by us - let the X server do it.

--disable-resources
Remove all resources checking.

--enable-xgetdefault
Make resources checking via XGetDefault() instead of our small version which only checks ~/.Xdefaults, or if that doesn't exist then ~/.Xresources.

--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).

--disable-swapscreen
Remove support for swap screen.

--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.

--enable-linespace
Add support to provide user specified line spacing between text rows.

--enable-keepscrolling
Add support for continual scrolling of the display when you hold the mouse button down on a scrollbar arrow.

--enable-mousewheel
Add support for scrolling via mouse wheel or buttons 4 & 5.

--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.

--disable-new-selection
Remove support for mouse selection style like that of xterm.

--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) .

--enable-dlmalloc
Use Doug Lea's malloc - which is good for a production version See http://g.oswego.edu/dl/html/malloc.html for details.

--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.

--enable-256-color
Add support for 256 colours rather than the base 16 colours.

This option will likely go away in the future. Speak up if you don't want this.

--enable-cursor-blink
Add support for a blinking cursor.

--enable-pointer-blank
Add support to have the pointer disappear when typing or inactive.

--with-name=NAME
Set the basename for the installed binaries (default: urxvt, resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.

--with-term=NAME
Change the environmental variable for the terminal to NAME (default ``rxvt'')

--with-terminfo=PATH
Change the environmental variable for the path to the terminfo tree to PATH.

--with-x
Use the X Window System (pretty much default, eh?).

--with-xpm-includes=DIR
Look for the XPM includes in DIR.

--with-xpm-library=DIR
Look for the XPM library in DIR.

--with-xpm
Not needed - define via --enable-xpm-background.


AUTHORS

Marc Lehmann <rxvt@schmorp.de> converted this document to pod and reworked it from the original Rxvt documentation, which was done by Geoff Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other sources.