LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity

make xterm refs conform to man page style

This commit is contained in:
Michael Kerrisk 2008-06-28 05:07:24 +00:00
parent 6387216bb2
commit 511bfbc900
1 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
man4/console_codes.4
View File

@ -38,7 +38,7 @@ If the console is in UTF-8 mode, then the incoming bytes are
first assembled into 16-bit Unicode codes. first assembled into 16-bit Unicode codes.
Otherwise each byte is transformed according to the current mapping table Otherwise each byte is transformed according to the current mapping table
(which translates it to a Unicode value). (which translates it to a Unicode value).
See the \fBCHARACTER SETS\fP section below for discussion. See the \fBCharacter Sets\fP section below for discussion.
.LP .LP
In the normal case, the Unicode value is converted to a font index, In the normal case, the Unicode value is converted to a font index,
and this is stored in video memory, so that the corresponding glyph and this is stored in video memory, so that the corresponding glyph
@ -51,7 +51,7 @@ currently processing an escape sequence, the value will treated
specially. specially.
Instead of being turned into a font index and rendered as Instead of being turned into a font index and rendered as
a glyph, it may trigger cursor movement or other control functions. a glyph, it may trigger cursor movement or other control functions.
See the \fBLINUX CONSOLE CONTROLS\fP section below for discussion. See the \fBLinux Console Controls\fP section below for discussion.
.LP .LP
It is generally not good practice to hard-wire terminal controls into It is generally not good practice to hard-wire terminal controls into
programs. programs.
@ -407,7 +407,8 @@ The bitmap that corresponds to
s is found in the character ROM, and can be changed using s is found in the character ROM, and can be changed using
.BR setfont (8). .BR setfont (8).
.SS "Mouse Tracking" .SS "Mouse Tracking"
The mouse tracking facility is intended to return xterm-compatible The mouse tracking facility is intended to return
.BR (1)xterm (1)-compatible
mouse status reports. mouse status reports.
Because the console driver has no way to know Because the console driver has no way to know
the device or type of the mouse, these reports are returned in the the device or type of the mouse, these reports are returned in the
@ -419,7 +420,7 @@ user-mode application such as the
daemon. daemon.
.PP .PP
The mouse tracking escape sequences generated by The mouse tracking escape sequences generated by
\fIxterm\fP encode numeric parameters in a single character as \fBxterm\fP(1) encode numeric parameters in a single character as
\fIvalue\fP+040. \fIvalue\fP+040.
For example, \(aq!\(aq is 1. For example, \(aq!\(aq is 1.
The screen coordinate system is 1-based. The screen coordinate system is 1-based.
@ -427,7 +428,7 @@ The screen coordinate system is 1-based.
The X10 compatibility mode sends an escape sequence on button press The X10 compatibility mode sends an escape sequence on button press
encoding the location and the mouse button pressed. encoding the location and the mouse button pressed.
It is enabled by sending ESC [ ? 9 h and disabled with ESC [ ? 9 l. It is enabled by sending ESC [ ? 9 h and disabled with ESC [ ? 9 l.
On button press, \fIxterm\fP sends On button press, \fBxterm\fP(1) sends
ESC [ M \fIbxy\fP (6 characters). ESC [ M \fIbxy\fP (6 characters).
Here \fIb\fP is button\-1, Here \fIb\fP is button\-1,
and \fIx\fP and \fIy\fP are the x and y coordinates of the mouse and \fIx\fP and \fIy\fP are the x and y coordinates of the mouse
@ -439,7 +440,7 @@ sequence on both button press and release.
Modifier information is also sent. Modifier information is also sent.
It is enabled by sending ESC [ ? 1000 h and disabled with It is enabled by sending ESC [ ? 1000 h and disabled with
ESC [ 1000 l. ESC [ 1000 l.
On button press or release, \fIxterm\fP sends ESC [ M On button press or release, \fBxterm\fP(1) sends ESC [ M
\fIbxy\fP. \fIbxy\fP.
The low two bits of \fIb\fP encode button information: The low two bits of \fIb\fP encode button information:
0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release. 0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release.
@ -472,7 +473,7 @@ all codes except XOFF and XON.
VT100-like DC1/DC3 processing may be enabled by the tty driver. VT100-like DC1/DC3 processing may be enabled by the tty driver.
.LP .LP
The The
.I xterm .BR xterm (1)
program (in VT100 mode) recognizes the control characters program (in VT100 mode) recognizes the control characters
BEL, BS, HT, LF, VT, FF, CR, SO, SI, ESC. BEL, BS, HT, LF, VT, FF, CR, SO, SI, ESC.
.\" .\"
@ -495,7 +496,7 @@ ESC + ... Designate G3 character set
.TE .TE
.PP .PP
The program The program
.I xterm .BR xterm (1)
(in VT100 mode) recognizes ESC c, ESC # 8, ESC >, ESC =, (in VT100 mode) recognizes ESC c, ESC # 8, ESC >, ESC =,
ESC D, ESC E, ESC H, ESC M, ESC N, ESC O, ESC P ... ESC \, ESC D, ESC E, ESC H, ESC M, ESC N, ESC O, ESC P ... ESC \,
ESC Z (it answers ESC [ ? 1 ; 2 c, "I am a VT100 with ESC Z (it answers ESC [ ? 1 ; 2 c, "I am a VT100 with
@ -505,14 +506,14 @@ It accepts ESC (, ESC ), ESC *, ESC + followed by 0, A, B for
the DEC special character and line drawing set, UK, and US-ASCII, the DEC special character and line drawing set, UK, and US-ASCII,
respectively. respectively.
.PP .PP
The user can configure \fIxterm\fP to respond to VT220-specific The user can configure \fBxterm\fP(1) to respond to VT220-specific
control sequences, and it will identify itself as a VT52, VT100, and control sequences, and it will identify itself as a VT52, VT100, and
up depending on the way it is configured and initialized. up depending on the way it is configured and initialized.
.PP .PP
It accepts ESC ] (OSC) for the setting of certain resources. It accepts ESC ] (OSC) for the setting of certain resources.
In addition to the ECMA-48 string terminator (ST), In addition to the ECMA-48 string terminator (ST),
\fIxterm\fP accepts a BEL to terminate an OSC string. \fBxterm\fP(1) accepts a BEL to terminate an OSC string.
These are a few of the OSC control sequences recognized by \fIxterm\fP: These are a few of the OSC control sequences recognized by \fBxterm\fP(1):
.TS .TS
l l. l l.
ESC ] 0 ; \fItxt\fP ST Set icon name and window title to \fItxt\fP. ESC ] 0 ; \fItxt\fP ST Set icon name and window title to \fItxt\fP.
@ -537,7 +538,7 @@ It also recognizes
.TS .TS
l l l. l l l.
ESC F Cursor to lower left corner of screen (if enabled by ESC F Cursor to lower left corner of screen (if enabled by
\fIxterm\fP's \fBhpLowerleftBugCompat\fP resource) \fBxterm\fP(1)'s \fBhpLowerleftBugCompat\fP resource)
ESC l Memory lock (per HP terminals). ESC l Memory lock (per HP terminals).
Locks memory above the cursor. Locks memory above the cursor.
ESC m Memory unlock (per HP terminals). ESC m Memory unlock (per HP terminals).
@ -554,7 +555,7 @@ implementation than Linux console.
.PP .PP
.B CSI Sequences .B CSI Sequences
.sp .sp
Old versions of \fIxterm\fP, for example, from X11R5, Old versions of \fBxterm\fP(1), for example, from X11R5,
interpret the blink SGR as a bold SGR. interpret the blink SGR as a bold SGR.
Later versions which implemented ANSI colors, for example, Later versions which implemented ANSI colors, for example,
XFree86 3.1.2A in 1995, improved this by allowing XFree86 3.1.2A in 1995, improved this by allowing
@ -565,13 +566,13 @@ Stock X11R6 versions did not recognize the color-setting SGRs until
the X11R6.8 release, which incorporated XFree86 xterm. the X11R6.8 release, which incorporated XFree86 xterm.
All ECMA-48 CSI sequences recognized by Linux are also recognized by All ECMA-48 CSI sequences recognized by Linux are also recognized by
.IR xterm , .IR xterm ,
however \fIxterm\fP implements several ECMA-48 and DEC control sequences however \fBxterm\fP(1) implements several ECMA-48 and DEC control sequences
not recognized by Linux. not recognized by Linux.
.PP .PP
The \fIxterm\fP The \fBxterm\fP(1)
program recognizes all of the DEC Private Mode sequences listed program recognizes all of the DEC Private Mode sequences listed
above, but none of the Linux private-mode sequences. above, but none of the Linux private-mode sequences.
For discussion of \fIxterm\fP's For discussion of \fBxterm\fP(1)'s
own private-mode sequences, refer to the own private-mode sequences, refer to the
\fIXterm Control Sequences\fP \fIXterm Control Sequences\fP
document by document by
@ -595,7 +596,7 @@ http://invisible-island.net/vttest/
.in .in
.PP .PP
demonstrates many of these control sequences. demonstrates many of these control sequences.
The \fIxterm\fP source distribution also contains sample The \fBxterm\fP(1) source distribution also contains sample
scripts which exercise other features. scripts which exercise other features.
.SH NOTES .SH NOTES
ESC 8 (DECRC) is not able to restore the character set changed with ESC 8 (DECRC) is not able to restore the character set changed with
@ -618,15 +619,15 @@ for private mode control sequences.
In particular, those ending with ] do not use a standard terminating In particular, those ending with ] do not use a standard terminating
character. character.
The OSC (set palette) sequence is a greater problem, The OSC (set palette) sequence is a greater problem,
since \fIxterm\fP may interpret this as a control sequence since \fBxterm\fP(1) may interpret this as a control sequence
which requires a string terminator (ST). which requires a string terminator (ST).
Unlike the \fIsetterm\fP sequences which will be ignored (since Unlike the \fBsetterm\fP(1) sequences which will be ignored (since
they are invalid control sequences), the palette sequence will make they are invalid control sequences), the palette sequence will make
\fIxterm\fP appear to hang (though pressing the return-key \fBxterm\fP(1) appear to hang (though pressing the return-key
will fix that). will fix that).
To accommodate applications which have been hardcoded to use Linux To accommodate applications which have been hardcoded to use Linux
control sequences, control sequences,
set the \fIxterm\fP resource \fBbrokenLinuxOSC\fP to true. set the \fBxterm\fP(1) resource \fBbrokenLinuxOSC\fP to true.
.PP .PP
An older version of this document implied that Linux recognizes the An older version of this document implied that Linux recognizes the
ECMA-48 control sequence for invisible text. ECMA-48 control sequence for invisible text.