diff options
Diffstat (limited to 'app/xterm/ctlseqs.ms')
| -rw-r--r-- | app/xterm/ctlseqs.ms | 171 |
1 files changed, 159 insertions, 12 deletions
diff --git a/app/xterm/ctlseqs.ms b/app/xterm/ctlseqs.ms index 6fdd467a9..0ba3a2548 100644 --- a/app/xterm/ctlseqs.ms +++ b/app/xterm/ctlseqs.ms @@ -1,9 +1,9 @@ .\"#! troff -ms $1 -*- Nroff -*- .\" "Xterm Control Sequences" document -.\" $XTermId: ctlseqs.ms,v 1.191 2009/08/03 21:16:54 tom Exp $ +.\" $XTermId: ctlseqs.ms,v 1.211 2010/01/04 09:12:55 tom Exp $ .\" .\" -.\" Copyright 1996-2007,2008 by Thomas E. Dickey +.\" Copyright 1996-2009,2010 by Thomas E. Dickey .\" .\" All Rights Reserved .\" @@ -288,7 +288,7 @@ X Consortium (1994) Thomas Dickey .AI XFree86 Project (1996-2006) -invisible-island.net (2006-2008) +invisible-island.net (2006-2010) .AU . .am BT \" add page numbers after first page @@ -586,6 +586,13 @@ or \*(Dc\*0\*$\*r\*(Pt\*s\*(ST for invalid requests. . +.IP \\*(Dc\\*+\\*p\\*(Pt\\*s\\*(ST +Set Termcap/Terminfo Data (xterm, experimental). +The string following the "p" is a name to use for retrieving data from +the terminal database. The data will be used for the "tcap" keyboard +configuration's function- and special-keys, as well as by the +Request Termcap/Terminfo String control. + .IP \\*(Dc\\*+\\*q\\*(Pt\\*s\\*(ST Request Termcap/Terminfo String (xterm, experimental). The string following the "q" is a list of names @@ -593,6 +600,11 @@ encoded in hexadecimal (2 digits per character) separated by \*; which correspond to termcap or terminfo key names. .br +Two special features are also recognized, which are not key names: +\fICo\fP for termcap colors (or \fIcolors\fP for terminfo colors), +and +\fITN\fP for termcap name (or \fIname\fP for terminfo name). +.br \fIxterm\fP responds with \*(Dc\*1\*+\*r\*(Pt\*s\*(ST for valid requests, adding to \*(Pt an \*=, @@ -682,6 +694,17 @@ Initiate highlight mouse tracking. Parameters are [func;startx;starty;firstrow;lastrow]. See the section \fBMouse Tracking\fP. . +.IP \\*(Cs\\*>\\*(Ps\\*;\\*(Ps\\*s\\*T +Reset one or more features of the title modes to the default value. +Normally, "reset" disables the feature. +It is possible to disable the ability to reset features +by compiling a different default for the title modes into \fIxterm\fP. + \*(Ps = \*0 \(-> Do not set window/icon labels using hexadecimal + \*(Ps = \*1 \(-> Do not query window/icon labels using hexadecimal + \*(Ps = \*2 \(-> Do not set window/icon labels using UTF-8 + \*(Ps = \*3 \(-> Do not query window/icon labels using UTF-8 +(See discussion of "Title Modes") +. .IP \\*(Cs\\*(Ps\\*s\\*(XX Erase \*(Ps Character(s) (default = 1) (ECH) . @@ -1062,6 +1085,14 @@ Valid values for the second parameter: \*(Ps = \*1 \(-> 7-bit controls (always set for VT100) \*(Ps = \*2 \(-> 8-bit controls . +.IP \\*(Cs\\*(Ps\\*s\\*(Sp\\*q +Set cursor style (DECSCUSR, VT520) + \*(Ps = \*0 \(-> blinking block + \*(Ps = \*1 \(-> blinking block (default) + \*(Ps = \*2 \(-> steady block + \*(Ps = \*3 \(-> blinking underline + \*(Ps = \*4 \(-> steady underline +. .IP \\*(Cs\\*(Ps\\*s\\*(c"\\*q Select character protection attribute (DECSCA). Valid values for the parameter: @@ -1093,19 +1124,19 @@ These controls may be disabled using the \fIallowWindowOps\fP resource. Valid values for the first (and any additional parameters) are: \*(Ps = \*1 \(-> De-iconify window. \*(Ps = \*2 \(-> Iconify window. - \*(Ps = \*3 ; \fIx ; y\fP \(-> Move window to [x, y]. - \*(Ps = \*4 ; \fIheight ; width\fP \(-> Resize the \fIxterm\fP window to height and width in pixels. + \*(Ps = \*3\*s\*;\*s\fIx\*s\*;\*sy\fP \(-> Move window to [x, y]. + \*(Ps = \*4\*s\*;\*s\fIheight\*s\*;\*swidth\fP \(-> Resize the \fIxterm\fP window to height and width in pixels. \*(Ps = \*5 \(-> Raise the \fIxterm\fP window to the front of the stacking order. \*(Ps = \*6 \(-> Lower the \fIxterm\fP window to the bottom of the stacking order. \*(Ps = \*7 \(-> Refresh the \fIxterm\fP window. - \*(Ps = \*8 ; \fIheight ; width\fP \(-> Resize the text area to [height;width] in characters. - \*(Ps = \*9 ; \*0 \(-> Restore maximized window. - \*(Ps = \*9 ; \*1 \(-> Maximize window (i.e., resize to screen size). + \*(Ps = \*8\*s\*;\*s\fIheight\*s\*;\*swidth\fP \(-> Resize the text area to [height;width] in characters. + \*(Ps = \*9\*s\*;\*s\*0 \(-> Restore maximized window. + \*(Ps = \*9\*s\*;\*s\*1 \(-> Maximize window (i.e., resize to screen size). \*(Ps = \*1\*1 \(-> Report \fIxterm\fP window state. If the \fIxterm\fP window is open (non-iconified), it returns \*(Cs\*1\*t. If the \fIxterm\fP window is iconified, it returns \*(Cs\*2\*t. \*(Ps = \*1\*3 \(-> Report \fIxterm\fP window position as -\*(Cs\*3\*;\*(Ix\*;\*(Iy\*t +\*(Cs\*3\*;\*(Ix\*s\*;\*(Iy\*s\*t \*(Ps = \*1\*4 \(-> Report \fIxterm\fP window in pixels as \*(Cs\*s\*4\*s\*;\*s\fIheight\fP\*s\*;\*s\fIwidth\fP\*s\*t \*(Ps = \*1\*8 \(-> Report the size of the text area in characters as @@ -1115,7 +1146,13 @@ If the \fIxterm\fP window is iconified, it returns \*(Cs\*2\*t. \*(Ps = \*2\*0 \(-> Report \fIxterm\fP window's icon label as \*(Os\*s\*L\*s\fIlabel\fP\*s\*(ST \*(Ps = \*2\*1 \(-> Report \fIxterm\fP window's title as -\*(Os\*s\*l\*s\fItitle\fP\*s\*(ST +\*(Os\*s\*L\*s\fIlabel\fP\*s\*(ST + \*(Ps = \*2\*2\*s\*;\*s\*0 \(-> Save \fIxterm\fP icon and window title on stack. + \*(Ps = \*2\*2\*s\*;\*s\*1 \(-> Save \fIxterm\fP icon title on stack. + \*(Ps = \*2\*2\*s\*;\*s\*2 \(-> Save \fIxterm\fP window title on stack. + \*(Ps = \*2\*3\*s\*;\*s\*0 \(-> Restore \fIxterm\fP icon and window title from stack. + \*(Ps = \*2\*3\*s\*;\*s\*1 \(-> Restore \fIxterm\fP icon title from stack. + \*(Ps = \*2\*3\*s\*;\*s\*2 \(-> Restore \fIxterm\fP window title from stack. \*(Ps >= \*2\*4 \(-> Resize to \*(Ps lines (DECSLPP) . .IP \\*(Cs\\*(Pt\\*;\\*(Pl\\*;\\*(Pb\\*;\\*(Pr\\*;\\*(Ps\\*$\\*t @@ -1123,9 +1160,30 @@ Reverse Attributes in Rectangular Area (DECRARA). \*(Pt\*;\*(Pl\*;\*(Pb\*;\*(Pr denotes the rectangle. \*(Ps denotes the attributes to reverse. 1, 4, 5, 7 . +.IP \\*(Cs\\*>\\*(Ps\\*;\\*(Ps\\*s\\*t +Set one or more features of the title modes. +Each parameter enables a single feature. + \*(Ps = \*0 \(-> Set window/icon labels using hexadecimal + \*(Ps = \*1 \(-> Query window/icon labels using hexadecimal + \*(Ps = \*2 \(-> Set window/icon labels using UTF-8 + \*(Ps = \*3 \(-> Query window/icon labels using UTF-8 +(See discussion of "Title Modes") +. +.IP \\*(Cs\\*(Ps\\*s\\*(Sp\\*t +Set warning-bell volume (DECSWBV, VT520) + \*(Ps = \*0 or \*1 \(-> off + \*(Ps = \*2, \*3 or \*4 \(-> low + \*(Ps = \*5, \*6, \*7, or \*8 \(-> high +. .IP \\*(Cs\\*u Restore cursor (ANSI.SYS) . +.IP \\*(Cs\\*(Ps\\*s\\*(Sp\\*u +Set margin-bell volume (DECSMBV, VT520) + \*(Ps = \*1 \(-> off + \*(Ps = \*2, \*3 or \*4 \(-> low + \*(Ps = \*0, \*5, \*6, \*7, or \*8 \(-> high +. .IP \\*(Cs\\*(Pt\\*;\\*(Pl\\*;\\*(Pb\\*;\\*(Pr\\*;\\*(Pp\\*;\\*(Pt\\*;\\*(Pl\\*;\\*(Pp\\*$\\*v Copy Rectangular Area (DECCRA) \*(Pt\*;\*(Pl\*;\*(Pb\*;\*(Pr denotes the rectangle. @@ -1280,12 +1338,26 @@ to set the corresponding color. Because more than one pair of color number and specification can be given in one control sequence, \fBxterm\fR can make more than one reply. .sp -The 8 colors which may be set using \*1\*0 through \*1\*7 are + \*(Ps = \*5 ; \fIc ; spec\fP \(-> Change Special Color Number \fIc\fP to +the color specified by \fIspec\fP, +i.e., a name or RGB specification as per \fIXParseColor\fP. +Any number of \fIc name\fP pairs may be given. +The special colors can also be set by adding the maximum number of colors +to these codes in an \*(Os\*4 control: +.sp + \*(Pc = 0 \(-> resource \fBcolorBD\fP (BOLD) + \*(Pc = 1 \(-> resource \fBcolorUL\fP (UNDERLINE) + \*(Pc = 2 \(-> resource \fBcolorBL\fP (BLINK) + \*(Pc = 3 \(-> resource \fBcolorRV\fP (REVERSE) +.sp +The 8 colors (below) which may be set or queried +using \*1\*0 through \*1\*7 are denoted \fIdynamic colors\fR, since the corresponding control sequences were the first means for setting \fBxterm\fR's colors dynamically, i.e., after it was started. They are not the same as the ANSI colors. -One or more parameters is expected for \*(Pt. +These controls may be disabled using the \fIallowColorOps\fP resource. +At least one parameter is expected for \*(Pt. Each successive parameter changes the next color in the list. The value of \*(Ps tells the starting point in the list. The colors are specified by name or RGB specification as per \fIXParseColor\fP. @@ -1310,10 +1382,20 @@ be given in one control sequence, \fBxterm\fR can make more than one reply. compile-time option) .sp \*(Ps = \*5\*0 \(-> Set Font to \*(Pt +These controls may be disabled using the \fIallowFontOps\fP resource. If \*(Pt begins with a "#", index in the font menu, relative (if the next character is a plus or minus sign) or absolute. A number is expected but not required after the sign (the default is the current entry for relative, zero for absolute indexing). +.br +The same rule (plus or minus sign, optional number) is used when +querying the font. The remainder of \*(Pt is ignored. +.br +A font can be specified after a "#" index expression, +by adding a space and then the font specifier. +.br +If the "TrueType Fonts" menu entry is set (the \fBrenderFont\fP resource), +then this control sets/queries the \fBfaceName\fP resource. .sp \*(Ps = \*5\*1 (reserved for Emacs shell) .sp @@ -1343,6 +1425,32 @@ If the second parameter is a \*?, \fIxterm\fP replies to the host with the selection data encoded using the same protocol. .Ed +.sp + \*(Ps = \*1\*0\*4 ; \fIc\fP \(-> Reset Color Number \fIc\fP to +the color specified by the corresponding X resource. +Any number of \fIc\fP parameters may be given. +These parameters correspond to the ANSI colors 0-7, +their bright versions 8-15, +and if supported, the remainder of the 88-color or 256-color table. +If no parameters are given, the entire table will be reset. +.sp + \*(Ps = \*1\*0\*5 ; \fIc\fP \(-> Reset Special Color Number \fIc\fP to +the color specified by the corresponding X resource. +Any number of \fIc\fP parameters may be given. +These parameters correspond to the special colors which can be set +using an \*(Os\*5 control (or by adding the maximum number of colors +using an \*(Os\*4 control). +.sp +The \fIdynamic colors\fR can also be reset to their default (resource) values: + \*(Ps = \*1\*1\*0 \(-> Reset VT100 text foreground color. + \*(Ps = \*1\*1\*1 \(-> Reset VT100 text background color. + \*(Ps = \*1\*1\*2 \(-> Reset text cursor color. + \*(Ps = \*1\*1\*3 \(-> Reset mouse foreground color. + \*(Ps = \*1\*1\*4 \(-> Reset mouse background color. + \*(Ps = \*1\*1\*5 \(-> Reset Tektronix foreground color. + \*(Ps = \*1\*1\*6 \(-> Reset Tektronix background color. + \*(Ps = \*1\*1\*7 \(-> Reset highlight color. + \*(Ps = \*1\*1\*8 \(-> Reset Tektronix cursor color. . .St .LP @@ -1735,6 +1843,7 @@ and alternate screen buffers simply disable the switching. They add other features such as clearing the display for the same reason: to make the details of switching independent of the application that requests the switch. +. .SH Bracketed Paste Mode .ds RH Bracketed Paste Mode @@ -1745,6 +1854,44 @@ so that the program can differentiate pasted text from typed-in text. When bracketed paste mode is set, the program will receive: ESC [ 200 ~, followed by the pasted text, followed by ESC [ 201 ~. +. +.SH +Title Modes +.ds RH Title Modes +.LP +The window- and icon-labels can be set or queried using control sequences. +As a VT220-emulator, \fIxterm\fP "should" limit the character encoding for +the corresponding strings to ISO-8859-1. +Indeed, it used to be the case (and was documented) that +window titles had to be ISO-8859-1. +This is no longer the case. +However, there are many applications which still assume that titles are +set using ISO-8859-1. +So that is the default behavior. +.LP +If \fIxterm\fP is running with UTF-8 encoding, +it is possible to use window- and icon-labels encoded using UTF-8. +That is because the underlying X libraries (and many, but not all) +window managers support this feature. +.LP +The \fButf8Title\fP X resource setting tells \fIxterm\fP to disable +a reconversion of the title string back to ISO-8859-1, +allowing the title strings to be interpreted as UTF-8. +The same feature can be enabled using the title mode control sequence +described in this summary. +.LP +Separate from the ability to set the titles, +\fIxterm\fP provides the ability to query the titles, +returning them either in ISO-8859-1 or UTF-8. +This choice is available only while \fIxterm\fP is using UTF-8 encoding. +.LP +Finally, the characters sent to, or returned by a title control +are less constrained than the rest of the control sequences. +To make them more manageable (and constrained), for use in shell scripts, +\fIxterm\fP has an optional feature which decodes the string from hexadecimal +(for setting titles) or for encoding the title into hexadecimal when querying +the value. +. .SH Mouse Tracking .ds RH Mouse Tracking |