.YODLTAGSTART. documenttype article .YODLTAGEND.
Reworked from XTerm documentation and other sources
.YODLTAGSTART. label rxvtRef-definitions.yo .YODLTAGEND.
.YODLTAGSTART. label Definitions .YODLTAGEND.
c
C
Ps
Pm
Pt
.YODLTAGSTART. label rxvtRef-values.yo .YODLTAGEND.
.YODLTAGSTART. label Values .YODLTAGEND.
ENQ
BEL
BS
TAB
LF
VT
LF
FF
LF
CR
SO
SI
SPC
.YODLTAGSTART. label rxvtRef-sequences.yo .YODLTAGEND.
.YODLTAGSTART. label Sequences .YODLTAGEND.
ESC # 8
ESC 7
ESC 8
.YODLTAGSTART. label ESCequals .YODLTAGEND.
ESC =
ESC >
ESC[?66h
ESC[?66l
ESC D
ESC E
ESC H
ESC M
ESC N
ESC O
ESC Z
ESC[c
ESC[?1;2C
rxvt compile-time optionESC c
ESC n
ESC o
ESC
( C
ESC
) C
ESC * C
ESC + C
ESC $ C
C
is 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 |
.YODLTAGSTART. label rxvtRef-csi.yo .YODLTAGEND.
.YODLTAGSTART. label CSI .YODLTAGEND.
ESC [ Ps @
Ps
(Blank) Character(s) [default: 1] (ICH).YODLTAGSTART. label ESCOBPsA .YODLTAGEND.
ESC [ Ps A
Ps
Times [default: 1] (CUU)ESC [ Ps B
Ps
Times [default: 1] (CUD)ESC [ Ps C
Ps
Times [default: 1] (CUF)ESC [ Ps D
Ps
Times [default: 1] (CUB)ESC [ Ps E
Ps
Times [default: 1] and to first columnESC [ Ps F
Ps
Times [default: 1] and to first column.YODLTAGSTART. label ESCOBPsG .YODLTAGEND.
ESC [ Ps G
Ps
(HPA)ESC [ Ps;Ps H
ESC [ Ps I
Ps
tab stops [default: 1]ESC [ Ps J
Ps = 0 |
Clear Below (default) |
Ps = 1 |
Clear Above |
Ps = 2 |
Clear All |
ESC [ Ps K
Ps = 0 |
Clear to Right (default) |
Ps = 1 |
Clear to Left |
Ps = 2 |
Clear All |
ESC [ Ps L
Ps
Line(s) [default: 1] (IL)ESC [ Ps M
Ps
Line(s) [default: 1] (DL)ESC [ Ps P
Ps
Character(s) [default: 1] (DCH)ESC [ Ps;Ps;Ps;Ps;Ps T
ESC [ Ps W
Ps = 0 |
Tab Set (HTS) |
Ps = 2 |
Tab Clear (TBC), Clear Current Column (default) |
Ps = 5 |
Tab Clear (TBC), Clear All |
ESC [ Ps X
Ps
Character(s) [default: 1] (ECH)ESC [ Ps Z
Ps
[default: 1] tab stopsESC [ Ps '
ESC [ Ps G
ESC [ Ps a
ESC [ Ps C
.YODLTAGSTART. label ESCOBPsc .YODLTAGEND.
ESC [ Ps c
Ps = 0
(or omitted) : request attributes from terminal ESC[?1;2c
(``I am a VT100 with Advanced Video
Option'')ESC [ Ps d
Ps
(VPA)ESC [ Ps e
ESC [ Ps;Ps f
ESC [ Ps g
Ps = 0 |
Clear Current Column (default) |
Ps = 3 |
Clear All (TBC) |
ESC [ Ps i
Ps = 4 |
disable transparent print mode (MC4) |
Ps = 5 |
enable transparent print mode (MC5) unimplemented |
ESC [ Pm h
ESC [ Pm l
Ps = 4
h |
Insert Mode (SMIR) |
l |
Replace Mode (RMIR) |
Ps = 20
unimplemented h |
Automatic Newline (LNM) |
h |
Normal Linefeed (LNM) |
ESC [ Pm m
Ps = 0 |
Normal (default) |
Ps = 1 / 22 |
On / Off Bold (bright fg) |
Ps = 4 / 24 |
On / Off Underline |
Ps = 5 / 25 |
On / Off Blink (bright bg) |
Ps = 7 / 27 |
On / Off Inverse |
Ps = 30 / 40 |
fg/bg Black |
Ps = 31 / 41 |
fg/bg Red |
Ps = 32 / 42 |
fg/bg Green |
Ps = 33 / 43 |
fg/bg Yellow |
Ps = 34 / 44 |
fg/bg Blue |
Ps = 35 / 45 |
fg/bg Magenta |
Ps = 36 / 46 |
fg/bg Cyan |
Ps = 37 / 47 |
fg/bg White |
Ps = 39 / 49 |
fg/bg Default |
ESC [ Ps n
Ps = 5 |
Status Report ESC [ 0 n (``OK'') |
Ps = 6 |
Report Cursor Position (CPR) [row;column] as ESC [ r ; c R |
Ps = 7 |
Request Display Name |
Ps = 8 |
Request Version Number (place in window title) |
ESC [ Ps;Ps r
ESC [ Ps x
.YODLTAGSTART. label rxvtRef-privatemodes.yo .YODLTAGEND.
.YODLTAGSTART. label PrivateModes .YODLTAGEND.
ESC [ ? Pm h
ESC [ ? Pm l
ESC [ ? Pm r
ESC [ ? Pm s
ESC [ ? Pm t
Ps = 1
(DECCKM) h |
Application Cursor Keys |
l |
Normal Cursor Keys |
Ps = 2
unimplemented h |
Designate USASCII for character sets G0-G3. |
Ps = 3
h |
132 Column Mode (DECCOLM) |
l |
80 Column Mode (DECCOLM) |
Ps = 4
unimplemented h |
Smooth (Slow) Scroll (DECSCLM) |
l |
Jump (Fast) Scroll (DECSCLM) |
Ps = 5
h |
Reverse Video (DECSCNM) |
l |
Normal Video (DECSCNM) |
Ps = 6
h |
Origin Mode (DECOM) |
l |
Normal Cursor Mode (DECOM) |
Ps = 7
h |
Wraparound Mode (DECAWM) |
l |
No Wraparound Mode (DECAWM) |
Ps = 8
unimplemented h |
Auto-repeat Keys (DECARM) |
l |
No Auto-repeat Keys (DECARM) |
Ps = 9
X10 XTerm mouse reporting h |
Send Mouse X & Y on button press. |
l |
No mouse reporting. |
Ps = 10
(rxvt) h |
menuBar visible |
l |
menuBar invisible |
Ps = 25
h |
Visible cursor {cnorm/cvvis} |
l |
Invisible cursor {civis} |
Ps = 30
h |
scrollBar visisble |
l |
scrollBar invisisble |
Ps = 35
(rxvt) h |
Allow XTerm Shift+key sequences |
l |
Disallow XTerm Shift+key sequences |
Ps = 38
unimplementedPs = 40
h |
Allow 80/132 Mode |
l |
Disallow 80/132 Mode |
Ps = 44
unimplemented h |
Turn On Margin Bell |
l |
Turn Off Margin Bell |
Ps = 45
unimplemented h |
Reverse-wraparound Mode |
l |
No Reverse-wraparound Mode |
Ps = 46
unimplementedPs = 47
unimplemented h |
Use Alternate Screen Buffer |
l |
Use Normal Screen Buffer |
Ps = 66
h |
Application Keypad (DECPAM) == ESC = |
l |
Normal Keypad (DECPNM) == ESC > |
Ps = 67
h |
Backspace key sends BS (DECBKM) |
l |
Backspace key sends DEL |
Ps = 1000
(X11 XTerm mouse reporting) h |
Send Mouse X & Y on button press and release. |
l |
No mouse reporting. |
Ps = 1001
(X11 XTerm mouse tracking) unimplemented h |
Use Hilite Mouse Tracking. |
l |
No mouse reporting. |
Ps = 1010
h |
Don't scroll to bottom on TTY output |
l |
Scroll to bottom on TTY output |
Ps = 1011
h |
Scroll to bottom when a key is pressed |
l |
Don't scroll to bottom when a key is pressed |
.YODLTAGSTART. label rxvtRef-xterm.yo .YODLTAGEND.
.YODLTAGSTART. label XTerm .YODLTAGEND.
ESC ] Ps;Pt BEL
Ps = 0 |
Change Icon Name and Window Title to Pt |
Ps = 1 |
Change Icon Name to Pt |
Ps = 2 |
Change Window Title to Pt |
Ps = 10 |
menuBar command Pt rxvt compile-time option |
Ps = 20 |
Change default background pixmap to Pt |
Ps = 39 |
Change default foreground colour to Pt rxvt compile-time option |
Ps = 46 |
Change Log File to Pt unimplemented |
Ps = 49 |
Change default background colour to Pt rxvt compile-time option |
Ps = 50 |
Set Font to Pt , with the following special values of Pt (rxvt) #+n change up n font(s) #-n change down n font(s) if n is missing of 0, a value of 1 is used empty change to font0 n change to font n |
.YODLTAGSTART. label rxvtRef-menubar.yo .YODLTAGEND.
.YODLTAGSTART. label menuBar .YODLTAGEND.
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.
For the menuBar XTerm escape sequence ESC ] 10; Pt BEL
, 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 add or remove 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]
.YODLTAGSTART. label menuBarCommands .YODLTAGEND.
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!.
A Future implementation may make this local to the menubar
.YODLTAGSTART. label menuBarAdd .YODLTAGEND.
The following commands may also be + prefixed.
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.
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.
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.
.YODLTAGSTART. label menuBarRemove .YODLTAGEND.
.YODLTAGSTART. label menuBarArrows .YODLTAGEND.
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:
.YODLTAGSTART. label menuBarSummary .YODLTAGEND.
A short summary of the most common commands:
.YODLTAGSTART. label rxvtRef-xpm.yo .YODLTAGEND.
.YODLTAGSTART. label background image .YODLTAGEND.
For the background image XTerm escape sequence ESC ] 20; Pt BEL
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:
Note:
when width is 1, the pixmap is not tiled across and if x is also -0 it
is centred. Similarly, for height and y.
For example:
.YODLTAGSTART. label rxvtRef-mouse.yo .YODLTAGEND.
.YODLTAGSTART. label Mouse .YODLTAGEND.
ESC [ M <b> <x> <y>
<b>
indicate the button:
(<b> - SPACE) & 3
The upper bits of <b>
indicate the modifiers when the button was
pressed and are added together (X11 mouse report only):
(<b> - SPACE) & 60
<x> - SPACE
<y> - SPACE
.YODLTAGSTART. label rxvtRef-graphics.yo .YODLTAGEND.
.YODLTAGSTART. label Graphics .YODLTAGEND.
Add more documentation here, if anyone actually cares.
ESC G Q
ESC G 0
no graphics available ESC G 1
graphics available (colour only)ESC G W <;x>;<y>;<w>;<h>:
ESC G C <id>
ESC G G <it>:
ESC G <id> <x> <y> <w> <h> <fw> <fh> <nw> <nh>
ESC G L <id>
ESC G P <id>
ESC G F <id>
;<x>;<y>
ESC G T <id>;<x>;<y>;<mode>;<len>:<text>
.YODLTAGSTART. label rxvtRef-keycodes.yo .YODLTAGEND.
.YODLTAGSTART. label KeyCodes .YODLTAGEND.
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, escape sequences toggle Application-Keypad setting.
Also note that values of Home, End, Delete may have been compiled
differently on your system.
Normal | Shift | Control | Ctrl+Shift |
|
Tab | ^I | ESC [ Z | ^I | ESC [ Z |
BackSpace | ^H | ^? | ^? | ^? |
Find | ESC [ 1 ~ | ESC [ 1 $ | ESC [ 1 ^ | ESC [ 1 @ |
Insert | ESC [ 2 ~ | paste | 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 ~ | scroll-up | ESC [ 5 ^ | ESC [ 5 @ |
Next | ESC [ 6 ~ | scroll-down | 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 @ |
Application |
||||
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 |