1XTERM(1) X Window System XTERM(1)
2
6 xterm - terminal emulator for X
7
9 xterm [-toolkitoption ...] [-option ...] [shell]
10
12 The xterm program is a terminal emulator for the X Window System. It
13 provides DEC VT102/VT220 and selected features from higher-level
14 terminals such as VT320/VT420/VT520 (VTxxx). It also provides
15 Tektronix 4014 emulation for programs that cannot use the window system
16 directly. If the underlying operating system supports terminal
17 resizing capabilities (for example, the SIGWINCH signal in systems
18 derived from 4.3BSD), xterm will use the facilities to notify programs
19 running in the window whenever it is resized.
20 The VTxxx and Tektronix 4014 terminals each have their own window so
22 that you can edit text in one and look at graphics in the other at the
23 same time. To maintain the correct aspect ratio (height/width),
24 Tektronix graphics will be restricted to the largest box with a 4014's
25 aspect ratio that will fit in the window. This box is located in the
26 upper left area of the window.
27 Although both windows may be displayed at the same time, one of them is
29 considered the “active” window for receiving keyboard input and
30 terminal output. This is the window that contains the text cursor.
31 The active window can be chosen through escape sequences, the VT
32 Options menu in the VTxxx window, and the Tek Options menu in the 4014
33 window.
34
36 Xterm provides usable emulations of related DEC terminals:
37 · VT52 emulation is complete.
39 · VT102 emulation is fairly complete, but does not support autorepeat
41 (because that would affect the keyboard used by other X clients).
42 Double-size characters are displayed properly if your font server
44 supports scalable fonts.
45 · VT220 emulation does not support soft fonts, it is otherwise
47 complete.
48 · VT420 emulation (the default) supports controls for manipulating
50 rectangles of characters as well as left/right margins.
51 Xterm does not support some other features which are not suitable
53 for emulation, e.g., two-sessions.
54 Terminal database (terminfo (5) or termcap (5)) entries that work with
56 xterm include
57 an optional platform-specific entry (“xterm”),
59 “xterm”,
60 “vt102”,
61 “vt100”,
62 “ansi” and
63 “dumb”
64 Xterm automatically searches the terminal database in this order for
66 these entries and then sets the “TERM” variable (and the “TERMCAP”
67 environment variable on a few older systems). The alternatives after
68 “xterm” are very old, from the late 1980s.
69 VT100 and VT102 emulations are commonly equated, though they actually
71 differ. The VT102 provided controls for inserting and deleting lines.
72 Similarly, “ansi” and “vt100” are often equated. These are not really
74 the same. For instance, they use different controls for scrolling (but
75 xterm supports both). These features differ in an “ansi” terminal
76 description from xterm:
77 acsc
79 Pseudo-graphics (line-drawing) uses a different mapping.
80 xenl
82 Xterm wraps text at the right margin using the VT100 “newline
83 glitch” behavior.
84 Because of the wrapping behavior, you would occasionally have to
86 repaint the screen when using a text editor with the “ansi”
87 description.
88 You may also use descriptions corresponding to the various supported
90 emulations such as “vt220” or “vt420”, but should set the terminal
91 emulation level with the decTerminalID resource.
92 On most systems, xterm will use the terminfo database. Some older
94 systems use termcap. (The “TERMCAP” environment variable is not set if
95 xterm is linked against a terminfo library, since the requisite
96 information is not provided by the termcap emulation of terminfo
97 libraries).
98 Many of the special xterm features may be modified under program
100 control through a set of escape sequences different from the standard
101 VTxxx escape sequences (see Xterm Control Sequences).
102 The Tektronix 4014 emulation is also fairly good. It supports 12-bit
104 graphics addressing, scaled to the window size. Four different font
105 sizes and five different lines types are supported. There is no write-
106 through or defocused mode support. The Tektronix text and graphics
107 commands are recorded internally by xterm and may be written to a file
108 by sending the COPY escape sequence (or through the Tektronix menu; see
109 below). The name of the file will be
110 “COPYyyyy-MM-dd.hh:mm:ss”
112 where yyyy, MM, dd, hh, mm and ss are the year, month, day, hour,
114 minute and second when the COPY was performed (the file is created in
115 the directory xterm is started in, or the home directory for a login
116 xterm).
117 Not all of the features described in this manual are necessarily
119 available in this version of xterm. Some (e.g., the non-VT220
120 extensions) are available only if they were compiled in, though the
121 most commonly-used are in the default configuration.
122
124 Xterm automatically highlights the text cursor when the pointer enters
125 the window (selected) and unhighlights it when the pointer leaves the
126 window (unselected). If the window is the focus window, then the text
127 cursor is highlighted no matter where the pointer is.
128 In VTxxx mode, there are escape sequences to activate and deactivate an
130 alternate screen buffer, which is the same size as the display area of
131 the window. When activated, the current screen is saved and replaced
132 with the alternate screen. Saving of lines scrolled off the top of the
133 window is disabled until the normal screen is restored. The usual
134 terminal description for xterm allows the visual editor vi(1) to switch
135 to the alternate screen for editing and to restore the screen on exit.
136 A popup menu entry makes it simple to switch between the normal and
137 alternate screens for cut and paste.
138 In either VTxxx or Tektronix mode, there are escape sequences to change
140 the name of the windows. Additionally, in VTxxx mode, xterm implements
141 the window-manipulation control sequences from dtterm, such as resizing
142 the window, setting its location on the screen.
143 Xterm allows character-based applications to receive mouse events
145 (currently button-press and release events, and button-motion events)
146 as keyboard control sequences. See Xterm Control Sequences for
147 details.
148
150 Because xterm uses the X Toolkit library, it accepts the standard X
151 Toolkit command line options. Xterm also accepts many application-
152 specific options.
153 By convention, if an option begins with a “+” instead of a “-”, the
155 option is restored to its default value.
156 Most of the xterm options are actually parsed by the X Toolkit, which
158 sets resource values, and overrides corresponding resource-settings in
159 your X resource files. Xterm provides the X Toolkit with a table of
160 options. A few of these are marked, telling the X Toolkit to ignore
161 them (-help, -version, -class, -e, and -into). After the X Toolkit has
162 parsed the command-line parameters, it removes those which it handles,
163 leaving the specially-marked parameters for xterm to handle.
164 These options do not set a resource value, and are handled specially:
166 -version
168 This causes xterm to print a version number to the standard
169 output, and then exit.
170 -help This causes xterm to print out a verbose message describing its
172 options, one per line. The message is written to the standard
173 output. After printing the message, xterm exits. Xterm
174 generates this message, sorting it and noting whether a
175 “-option” or a “+option” turns the feature on or off, since
176 some features historically have been one or the other. Xterm
177 generates a concise help message (multiple options per line)
178 when an unknown option is used, e.g.,
179 xterm -z
181 If the logic for a particular option such as logging is not
183 compiled into xterm, the help text for that option also is not
184 displayed by the -help option.
185 The -version and -help options are interpreted even if xterm cannot
187 open the display, and are useful for testing and configuration scripts.
188 Along with -class, they are checked before other options. To do this,
189 xterm has its own (much simpler) argument parser, along with a table of
190 the X Toolkit's built-in list of options.
191 Relying upon the X Toolkit to parse the options and associated values
193 has the advantages of simplicity and good integration with the X
194 resource mechanism. There are a few drawbacks
195 · Xterm cannot tell easily whether a resource value was set by one of
197 the external resource- or application-defaults files, whether it
198 was set using xrdb(1), or if it was set through the -xrm option or
199 via some directly relevant command-line option. Xterm sees only
200 the end-result: a value supplied when creating its widgets.
201 · Xterm does not know the order in which particular options and items
203 in resource files are evaluated. Rather, it sees all of the values
204 for a given widget at the same time. In the design of these
205 options, some are deemed more important, and can override other
206 options.
207 The X Toolkit uses patterns (constants and wildcards) to match
209 resources. Once a particular pattern has been used, it will not
210 modify it. To override a given setting, a more-specific pattern
211 must be used, e.g., replacing “*” with “.”. Some poorly-designed
212 resource files are too specific to allow the command-line options
213 to affect the relevant widget values.
214 · In a few cases, the X Toolkit combines its standard options in ways
216 which do not work well with xterm. This happens with the color
217 (-fg, -bg) and reverse (-rv) options. Xterm makes a special case
218 of these and adjusts its sense of “reverse” to lessen user
219 surprise.
220 One parameter (after all options) may be given. That overrides xterm's
222 built-in choice of shell program:
223 · If the parameter is not a relative path, i.e., beginning with “./”
225 or “../”, xterm looks for the file in the user's PATH. In either
226 case, this check fails if xterm cannot construct an absolute path.
227 · If that check fails (or if no such parameter is given), xterm next
229 checks the “SHELL” variable. If that specifies an executable file,
230 xterm will attempt to start that. However, xterm additionally
231 checks if it is a valid shell, and will unset “SHELL” if it is not.
232 · If “SHELL” is not set to an executable file, xterm tries to use the
234 shell program specified in the user's password file entry. As
235 before, xterm verifies if this is a valid shell.
236 · Finally, if the password file entry does not specify a valid shell,
238 xterm uses /bin/sh.
239 The -e option cannot be used with this parameter since it uses all
241 parameters following the option.
242 Xterm validates shell programs by finding their pathname in the text
244 file /etc/shells. It treats the environment variable “SHELL” specially
245 because (like “TERM”), xterm both reads and updates the variable, and
246 because the program started by xterm is not necessarily a shell.
247 The other options are used to control the appearance and behavior. Not
249 all options are necessarily configured into your copy of xterm:
250 -132 Normally, the VT102 DECCOLM escape sequence that switches
252 between 80 and 132 column mode is ignored. This option causes
253 the DECCOLM escape sequence to be recognized, and the xterm
254 window will resize appropriately.
255 -ah This option indicates that xterm should always highlight the
257 text cursor. By default, xterm will display a hollow text
258 cursor whenever the focus is lost or the pointer leaves the
259 window.
260 +ah This option indicates that xterm should do text cursor
262 highlighting based on focus.
263 -ai This option disables active icon support if that feature was
265 compiled into xterm. This is equivalent to setting the vt100
266 resource activeIcon to “false”.
267 +ai This option enables active icon support if that feature was
269 compiled into xterm. This is equivalent to setting the vt100
270 resource activeIcon to “true”.
271 -aw This option indicates that auto-wraparound should be allowed,
273 and is equivalent to setting the vt100 resource autoWrap to
274 “false”.
275 Auto-wraparound allows the cursor to automatically wrap to the
277 beginning of the next line when it is at the rightmost position
278 of a line and text is output.
279 +aw This option indicates that auto-wraparound should not be
281 allowed, and is equivalent to setting the vt100 resource
282 autoWrap to “false”.
283 -b number
285 This option specifies the size of the inner border (the
286 distance between the outer edge of the characters and the
287 window border) in pixels. That is the vt100 internalBorder
288 resource. The default is “2”.
289 -baudrate number
291 Set the line-speed, used to test the behavior of applications
292 that use the line-speed when optimizing their output to the
293 screen. The default is “38400”.
294 +bc turn off text cursor blinking. This overrides the cursorBlink
296 resource.
297 -bc turn on text cursor blinking. This overrides the cursorBlink
299 resource.
300 -bcf milliseconds
302 set the amount of time text cursor is off when blinking via the
303 cursorOffTime resource.
304 -bcn milliseconds
306 set the amount of time text cursor is on when blinking via the
307 cursorOnTime resource.
308 -bdc Set the vt100 resource colorBDMode to “false”, disabling the
310 display of characters with bold attribute as color.
311 +bdc Set the vt100 resource colorBDMode to “true”, enabling the
313 display of characters with bold attribute as color rather than
314 bold.
315 -cb Set the vt100 resource cutToBeginningOfLine to “false”.
317 +cb Set the vt100 resource cutToBeginningOfLine to “true”.
319 -cc characterclassrange:value[, ...]
321 This sets classes indicated by the given ranges for using in
322 selecting by words (see CHARACTER CLASSES and the charClass
323 resource).
324 -cjk_width
326 Set the cjkWidth resource to “true”. When turned on,
327 characters with East Asian Ambiguous (A) category in UTR 11
328 have a column width of 2. Otherwise, they have a column width
329 of 1. This may be useful for some legacy CJK text terminal-
330 based programs assuming box drawings and others to have a
331 column width of 2. It also should be turned on when you
332 specify a TrueType CJK double-width (bi-width/monospace) font
333 either with -fa at the command line or faceName resource. The
334 default is “false”
335 +cjk_width
337 Reset the cjkWidth resource.
338 -class string
340 This option allows you to override xterm's resource class.
341 Normally it is “XTerm”, but can be set to another class such as
342 “UXTerm” to override selected resources.
343 -cm This option disables recognition of ANSI color-change escape
345 sequences. It sets the colorMode resource to “false”.
346 +cm This option enables recognition of ANSI color-change escape
348 sequences. This is the same as the vt100 resource colorMode.
349 -cn This option indicates that newlines should not be cut in line-
351 mode selections. It sets the cutNewline resource to “false”.
352 +cn This option indicates that newlines should be cut in line-mode
354 selections. It sets the cutNewline resource to “true”.
355 -cr color
357 This option specifies the color to use for text cursor. The
358 default is to use the same foreground color that is used for
359 text. It sets the cursorColor resource according to the
360 parameter.
361 -cu This option indicates that xterm should work around a bug in
363 the more(1) program that causes it to incorrectly display lines
364 that are exactly the width of the window and are followed by a
365 line beginning with a tab (the leading tabs are not displayed).
366 This option is so named because it was originally thought to be
367 a bug in the curses(3x) cursor motion package.
368 +cu This option indicates that xterm should not work around the
370 more(1) bug mentioned above.
371 -dc This option disables the escape sequence to change dynamic
373 colors: the vt100 foreground and background colors, its text
374 cursor color, the pointer cursor foreground and background
375 colors, the Tektronix emulator foreground and background
376 colors, its text cursor color and highlight color. The option
377 sets the dynamicColors option to “false”.
378 +dc This option enables the escape sequence to change dynamic
380 colors. The option sets the dynamicColors option to “true”.
381 -e program [ arguments ... ]
383 This option specifies the program (and its command line
384 arguments) to be run in the xterm window. It also sets the
385 window title and icon name to be the basename of the program
386 being executed if neither -T nor -n are given on the command
387 line.
388 NOTE: This must be the last option on the command line.
390 -en encoding
392 This option determines the encoding on which xterm runs. It
393 sets the locale resource. Encodings other than UTF-8 are
394 supported by using luit. The -lc option should be used instead
395 of -en for systems with locale support.
396 -fb font
398 This option specifies a font to be used when displaying bold
399 text. It sets the boldFont resource.
400 This font must be the same height and width as the normal font,
402 otherwise it is ignored. If only one of the normal or bold
403 fonts is specified, it will be used as the normal font and the
404 bold font will be produced by overstriking this font.
405 See also the discussion of boldMode and alwaysBoldMode
407 resources.
408 -fa pattern
410 This option sets the pattern for fonts selected from the
411 FreeType library if support for that library was compiled into
412 xterm. This corresponds to the faceName resource. When a CJK
413 double-width font is specified, you also need to turn on the
414 cjkWidth resource.
415 If you specify both -fa and the X Toolkit option -fn, the -fa
417 setting overrides the latter.
418 See also the renderFont resource, which combines with this to
420 determine whether FreeType fonts are initially active.
421 -fbb This option indicates that xterm should compare normal and bold
423 fonts bounding boxes to ensure they are compatible. It sets
424 the freeBoldBox resource to “false”.
425 +fbb This option indicates that xterm should not compare normal and
427 bold fonts bounding boxes to ensure they are compatible. It
428 sets the freeBoldBox resource to “true”.
429 -fbx This option indicates that xterm should not assume that the
431 normal and bold fonts have VT100 line-drawing characters. If
432 any are missing, xterm will draw the characters directly. It
433 sets the forceBoxChars resource to “false”.
434 +fbx This option indicates that xterm should assume that the normal
436 and bold fonts have VT100 line-drawing characters. It sets the
437 forceBoxChars resource to “true”.
438 -fd pattern
440 This option sets the pattern for double-width fonts selected
441 from the FreeType library if support for that library was
442 compiled into xterm. This corresponds to the
443 faceNameDoublesize resource.
444 -fi font
446 This option sets the font for active icons if that feature was
447 compiled into xterm.
448 See also the discussion of the iconFont resource.
450 -fs size
452 This option sets the pointsize for fonts selected from the
453 FreeType library if support for that library was compiled into
454 xterm. This corresponds to the faceSize resource.
455 -fullscreen
457 This option indicates that xterm should ask the window manager
458 to let it use the full-screen for display, e.g., without window
459 decorations. It sets the fullscreen resource to “true”.
460 +fullscreen
462 This option indicates that xterm should not ask the window
463 manager to let it use the full-screen for display. It sets the
464 fullscreen resource to “false”.
465 -fw font
467 This option specifies the font to be used for displaying wide
468 text. By default, it will attempt to use a font twice as wide
469 as the font that will be used to draw normal text. If no
470 double-width font is found, it will improvise, by stretching
471 the normal font. This corresponds to the wideFont resource.
472 -fwb font
474 This option specifies the font to be used for displaying bold
475 wide text. By default, it will attempt to use a font twice as
476 wide as the font that will be used to draw bold text. If no
477 double-width font is found, it will improvise, by stretching
478 the bold font. This corresponds to the wideBoldFont resource.
479 -fx font
481 This option specifies the font to be used for displaying the
482 preedit string in the “OverTheSpot” input method.
483 See also the discussion of the ximFont resource.
485 -hc color
487 (see -selbg).
488 -hf This option indicates that HP function key escape codes should
490 be generated for function keys. It sets the hpFunctionKeys
491 resource to “true”.
492 +hf This option indicates that HP function key escape codes should
494 not be generated for function keys. It sets the hpFunctionKeys
495 resource to “false”.
496 -hm Tells xterm to use highlightTextColor and highlightColor to
498 override the reversed foreground/background colors in a
499 selection. It sets the highlightColorMode resource to “true”.
500 +hm Tells xterm not to use highlightTextColor and highlightColor to
502 override the reversed foreground/background colors in a
503 selection. It sets the highlightColorMode resource to “false”.
504 -hold Turn on the hold resource, i.e., xterm will not immediately
506 destroy its window when the shell command completes. It will
507 wait until you use the window manager to destroy/kill the
508 window, or if you use the menu entries that send a signal,
509 e.g., HUP or KILL.
510 +hold Turn off the hold resource, i.e., xterm will immediately
512 destroy its window when the shell command completes.
513 -ie Turn on the ptyInitialErase resource, i.e., use the pseudo-
515 terminal's sense of the stty erase value.
516 +ie Turn off the ptyInitialErase resource, i.e., set the stty erase
518 value using the kb string from the termcap entry as a
519 reference, if available.
520 -im Turn on the useInsertMode resource, which forces use of insert
522 mode by adding appropriate entries to the TERMCAP environment
523 variable. (This option is ignored on most systems, because
524 TERMCAP is not used).
525 +im Turn off the useInsertMode resource.
527 -into windowId
529 Given an X window identifier (an integer, which can be
530 hexadecimal, octal or decimal according to whether it begins
531 with "0x", "0" or neither), xterm will reparent its top-level
532 shell widget to that window. This is used to embed xterm
533 within other applications.
534 For instance, there are scripts for Tcl/Tk and Gtk which can be
536 used to demonstrate the feature. When using Gtk, there is a
537 limitation of that toolkit which requires that xterm's
538 allowSendEvents resource is enabled.
539 -itc Set the vt100 resource colorITMode to “false”, disabling the
541 display of characters with italic attribute as color.
542 +itc Set the vt100 resource colorITMode to “true”, enabling the
544 display of characters with italic attribute as color rather
545 than italic.
546 -j This option indicates that xterm should do jump scrolling. It
548 corresponds to the jumpScroll resource. Normally, text is
549 scrolled one line at a time; this option allows xterm to move
550 multiple lines at a time so that it does not fall as far
551 behind. Its use is strongly recommended since it makes xterm
552 much faster when scanning through large amounts of text. The
553 VT100 escape sequences for enabling and disabling smooth scroll
554 as well as the VT Options menu can be used to turn this feature
555 on or off.
556 +j This option indicates that xterm should not do jump scrolling.
558 -k8 This option sets the allowC1Printable resource. When
560 allowC1Printable is set, xterm overrides the mapping of C1
561 control characters (code 128–159) to treat them as printable.
562 +k8 This option resets the allowC1Printable resource.
564 -kt keyboardtype
566 This option sets the keyboardType resource. Possible values
567 include: “unknown”, “default”, “legacy”, “hp”, “sco”, “sun”,
568 “tcap” and “vt220”.
569 The value “unknown”, causes the corresponding resource to be
571 ignored.
572 The value “default”, suppresses the associated resources
574 hpFunctionKeys,
576 scoFunctionKeys,
577 sunFunctionKeys,
578 tcapFunctionKeys,
579 oldXtermFKeys and
580 sunKeyboard,
581 using the Sun/PC keyboard layout.
583 -l Turn logging on, unless disabled by the logInhibit resource.
585 Some versions of xterm may have logging enabled. However,
587 normally logging is not supported, due to security concerns in
588 the early 1990s. That was a problem in X11R4 xterm (1989)
589 which was addressed by a patch to X11R5 late in 1993. X11R6
590 included these fixes. The older version (when running with
591 root privilege) would create the log-file using root privilege.
592 The reason why xterm ran with root privileges was to open
593 pseudo-terminals. Those privileges are now needed only on very
594 old systems: Unix98 pseudo-terminals made the BSD scheme
595 unnecessary.
596 Unless overridden by the -lf option or the logFile resource:
598 · If the filename is “-”, then logging is sent to the
600 standard output.
601 · Otherwise a filename is generated, and the logfile is
603 written to the directory from which xterm is invoked.
604 · The generated filename is of the form
606 XtermLog.XXXXXX
608 or
610 Xterm.log.hostname.yyyy.mm.dd.hh.mm.ss.XXXXXX
612 depending on how xterm was built.
614 +l Turn logging off.
616 -lc Turn on support of various encodings according to the users'
618 locale setting, i.e., LC_ALL, LC_CTYPE, or LANG environment
619 variables. This is achieved by turning on UTF-8 mode and by
620 invoking luit for conversion between locale encodings and
621 UTF-8. (luit is not invoked in UTF-8 locales.) This
622 corresponds to the locale resource.
623 The actual list of encodings which are supported is determined
625 by luit. Consult the luit manual page for further details.
626 See also the discussion of the -u8 option which supports UTF-8
628 locales.
629 +lc Turn off support of automatic selection of locale encodings.
631 Conventional 8bit mode or, in UTF-8 locales or with -u8 option,
632 UTF-8 mode will be used.
633 -lcc path
635 File name for the encoding converter from/to locale encodings
636 and UTF-8 which is used with -lc option or locale resource.
637 This corresponds to the localeFilter resource.
638 -leftbar
640 Force scrollbar to the left side of VT100 screen. This is the
641 default, unless you have set the rightScrollBar resource.
642 -lf filename
644 Specify the log-filename. This sets the logFile resource. If
645 set to “-”, xterm writes its log to the standard output. See
646 the -l option.
647 -ls This option indicates that the shell that is started in the
649 xterm window will be a login shell (i.e., the first character
650 of argv[0] will be a dash, indicating to the shell that it
651 should read the user's .login or .profile).
652 The -ls flag and the loginShell resource are ignored if -e is
654 also given, because xterm does not know how to make the shell
655 start the given command after whatever it does when it is a
656 login shell - the user's shell of choice need not be a Bourne
657 shell after all. Also, xterm -e is supposed to provide a
658 consistent functionality for other applications that need to
659 start text-mode programs in a window, and if loginShell were
660 not ignored, the result of ~/.profile might interfere with
661 that.
662 If you do want the effect of -ls and -e simultaneously, you may
664 get away with something like
665 xterm -e /bin/bash -l -c "my command here"
667 Finally, -ls is not completely ignored, because xterm -ls -e
669 does write a /etc/wtmp entry (if configured to do so), whereas
670 xterm -e does not.
671 -maximized
673 This option indicates that xterm should ask the window manager
674 to maximize its layout on startup. This corresponds to the
675 maximized resource.
676 Maximizing is not the reverse of iconifying; it is possible to
678 do both with certain window managers.
679 +maximized
681 This option indicates that xterm should ask the window manager
682 to not maximize its layout on startup.
683 +ls This option indicates that the shell that is started should not
685 be a login shell (i.e., it will be a normal “subshell”).
686 -mb This option indicates that xterm should ring a margin bell when
688 the user types near the right end of a line.
689 +mb This option indicates that margin bell should not be rung.
691 -mc milliseconds
693 This option specifies the maximum time between multi-click
694 selections.
695 -mesg Turn off the messages resource, i.e., disallow write access to
697 the terminal.
698 +mesg Turn on the messages resource, i.e., allow write access to the
700 terminal.
701 -mk_width
703 Set the mkWidth resource to “true”. This makes xterm use a
704 built-in version of the wide-character width calculation. The
705 default is “false”
706 +mk_width
708 Reset the mkWidth resource.
709 -ms color
711 This option specifies the color to be used for the pointer
712 cursor. The default is to use the foreground color. This sets
713 the pointerColor resource.
714 -nb number
716 This option specifies the number of characters from the right
717 end of a line at which the margin bell, if enabled, will ring.
718 The default is “10”.
719 -nul This option disables the display of underlining.
721 +nul This option enables the display of underlining.
723 -pc This option enables the PC-style use of bold colors (see
725 boldColors resource).
726 +pc This option disables the PC-style use of bold colors.
728 -pob This option indicates that the window should be raised whenever
730 a Control-G is received.
731 +pob This option indicates that the window should not be raised
733 whenever a Control-G is received.
734 -report-charclass
736 Print a report to the standard output showing information about
737 the character-classes which can be altered using the charClass
738 resource.
739 -report-colors
741 Print a report to the standard output showing information about
742 colors as xterm allocates them. This corresponds to the
743 reportColors resource.
744 -report-fonts
746 Print a report to the standard output showing information about
747 fonts which are loaded. This corresponds to the reportFonts
748 resource.
749 -report-icons
751 Print a report to the standard output showing information about
752 pixmap-icons which are loaded. This corresponds to the
753 reportIcons resource.
754 -rightbar
756 Force scrollbar to the right side of VT100 screen.
757 -rvc This option disables the display of characters with reverse
759 attribute as color.
760 +rvc This option enables the display of characters with reverse
762 attribute as color.
763 -rw This option indicates that reverse-wraparound should be
765 allowed. This allows the cursor to back up from the leftmost
766 column of one line to the rightmost column of the previous
767 line. This is very useful for editing long shell command lines
768 and is encouraged. This option can be turned on and off from
769 the VT Options menu.
770 +rw This option indicates that reverse-wraparound should not be
772 allowed.
773 -s This option indicates that xterm may scroll asynchronously,
775 meaning that the screen does not have to be kept completely up
776 to date while scrolling. This allows xterm to run faster when
777 network latencies are very high and is typically useful when
778 running across a very large internet or many gateways.
779 +s This option indicates that xterm should scroll synchronously.
781 -samename
783 Does not send title and icon name change requests when the
784 request would have no effect: the name is not changed. This
785 has the advantage of preventing flicker and the disadvantage of
786 requiring an extra round trip to the server to find out the
787 previous value. In practice this should never be a problem.
788 +samename
790 Always send title and icon name change requests.
791 -sb This option indicates that some number of lines that are
793 scrolled off the top of the window should be saved and that a
794 scrollbar should be displayed so that those lines can be
795 viewed. This option may be turned on and off from the VT
796 Options menu.
797 +sb This option indicates that a scrollbar should not be displayed.
799 -selbg color
801 This option specifies the color to use for the background of
802 selected text. If not specified, reverse video is used. See
803 the discussion of the highlightColor resource.
804 -selfg color
806 This option specifies the color to use for selected text. If
807 not specified, reverse video is used. See the discussion of
808 the highlightTextColor resource.
809 -sf This option indicates that Sun function key escape codes should
811 be generated for function keys.
812 +sf This option indicates that the standard escape codes should be
814 generated for function keys.
815 -sh number
817 scale line-height values by the given number. See the
818 discussion of the scaleHeight resource.
819 -si This option indicates that output to a window should not
821 automatically reposition the screen to the bottom of the
822 scrolling region. This option can be turned on and off from
823 the VT Options menu.
824 +si This option indicates that output to a window should cause it
826 to scroll to the bottom.
827 -sk This option indicates that pressing a key while using the
829 scrollbar to review previous lines of text should cause the
830 window to be repositioned automatically in the normal position
831 at the bottom of the scroll region.
832 +sk This option indicates that pressing a key while using the
834 scrollbar should not cause the window to be repositioned.
835 -sl number
837 This option specifies the number of lines to save that have
838 been scrolled off the top of the screen. This corresponds to
839 the saveLines resource. The default is “64”.
840 -sm This option, corresponding to the sessionMgt resource,
842 indicates that xterm should set up session manager callbacks.
843 +sm This option indicates that xterm should not set up session
845 manager callbacks.
846 -sp This option indicates that Sun/PC keyboard should be assumed,
848 providing mapping for keypad “+” to “,”, and CTRL-F1 to F13,
849 CTRL-F2 to F14, etc.
850 +sp This option indicates that the standard escape codes should be
852 generated for keypad and function keys.
853 -t This option indicates that xterm should start in Tektronix
855 mode, rather than in VTxxx mode. Switching between the two
856 windows is done using the “Options” menus.
857 Terminal database (terminfo (5) or termcap (5)) entries that
859 work with xterm are:
860 “tek4014”,
862 “tek4015”,
863 “tek4012”,
864 “tek4013”,
865 “tek4010”, and
866 “dumb”.
867 xterm automatically searches the terminal database in this
869 order for these entries and then sets the “TERM” variable (and
870 the “TERMCAP” environment variable, if relevant).
871 +t This option indicates that xterm should start in VTxxx mode.
873 -tb This option, corresponding to the toolBar resource, indicates
875 that xterm should display a toolbar (or menubar) at the top of
876 its window. The buttons in the toolbar correspond to the popup
877 menus, e.g., control/left/mouse for Main Options.
878 +tb This option indicates that xterm should not set up a toolbar.
880 -ti term_id
882 Specify the name used by xterm to select the correct response
883 to terminal ID queries. It also specifies the emulation level,
884 used to determine the type of response to a DA control
885 sequence. Valid values include vt52, vt100, vt101, vt102,
886 vt220, and vt240 (the “vt” is optional). The default is
887 “vt420”. The term_id argument specifies the terminal ID to
888 use. (This is the same as the decTerminalID resource).
889 -tm string
891 This option specifies a series of terminal setting keywords
892 followed by the characters that should be bound to those
893 functions, similar to the stty program. The keywords and their
894 values are described in detail in the ttyModes resource.
895 -tn name
897 This option specifies the name of the terminal type to be set
898 in the TERM environment variable. It corresponds to the
899 termName resource. This terminal type must exist in the
900 terminal database (termcap or terminfo, depending on how xterm
901 is built) and should have li# and co# entries. If the terminal
902 type is not found, xterm uses the built-in list “xterm”,
903 “vt102”, etc.
904 -u8 This option sets the utf8 resource. When utf8 is set, xterm
906 interprets incoming data as UTF-8. This sets the wideChars
907 resource as a side-effect, but the UTF-8 mode set by this
908 option prevents it from being turned off. If you must turn
909 UTF-8 encoding on and off, use the -wc option or the
910 corresponding wideChars resource, rather than the -u8 option.
911 This option and the utf8 resource are overridden by the -lc and
913 -en options and locale resource. That is, if xterm has been
914 compiled to support luit, and the locale resource is not
915 “false” this option is ignored. We recommend using the -lc
916 option or the “locale: true” resource in UTF-8 locales when
917 your operating system supports locale, or -en UTF-8 option or
918 the “locale: UTF-8” resource when your operating system does
919 not support locale.
920 +u8 This option resets the utf8 resource.
922 -uc This option makes the cursor underlined instead of a box.
924 +uc This option makes the cursor a box instead of underlined.
926 -ulc This option disables the display of characters with underline
928 attribute as color rather than with underlining.
929 +ulc This option enables the display of characters with underline
931 attribute as color rather than with underlining.
932 -ulit This option, corresponding to the italicULMode resource,
934 disables the display of characters with underline attribute as
935 italics rather than with underlining.
936 +ulit This option, corresponding to the italicULMode resource,
938 enables the display of characters with underline attribute as
939 italics rather than with underlining.
940 -ut This option indicates that xterm should not write a record into
942 the system utmp log file.
943 +ut This option indicates that xterm should write a record into the
945 system utmp log file.
946 -vb This option indicates that a visual bell is preferred over an
948 audible one. Instead of ringing the terminal bell whenever a
949 Control-G is received, the window will be flashed.
950 +vb This option indicates that a visual bell should not be used.
952 -wc This option sets the wideChars resource.
954 When wideChars is set, xterm maintains internal structures for
956 16-bit characters. If xterm is not started in UTF-8 mode (or
957 if this resource is not set), initially it maintains those
958 structures to support 8-bit characters. Xterm can later be
959 switched, using a menu entry or control sequence, causing it to
960 reallocate those structures to support 16-bit characters.
961 The default is “false”.
963 +wc This option resets the wideChars resource.
965 -wf This option indicates that xterm should wait for the window to
967 be mapped the first time before starting the subprocess so that
968 the initial terminal size settings and environment variables
969 are correct. It is the application's responsibility to catch
970 subsequent terminal size changes.
971 +wf This option indicates that xterm should not wait before
973 starting the subprocess.
974 -ziconbeep percent
976 Same as zIconBeep resource. If percent is non-zero, xterms
977 that produce output while iconified will cause an XBell sound
978 at the given volume and have “***” prepended to their icon
979 titles. Most window managers will detect this change
980 immediately, showing you which window has the output. (A
981 similar feature was in x10 xterm.)
982 -C This option indicates that this window should receive console
984 output. This is not supported on all systems. To obtain
985 console output, you must be the owner of the console device,
986 and you must have read and write permission for it. If you are
987 running X under xdm on the console screen you may need to have
988 the session startup and reset programs explicitly change the
989 ownership of the console device in order to get this option to
990 work.
991 -Sccn This option allows xterm to be used as an input and output
993 channel for an existing program and is sometimes used in
994 specialized applications. The option value specifies the last
995 few letters of the name of a pseudo-terminal to use in slave
996 mode, plus the number of the inherited file descriptor. If the
997 option contains a “/” character, that delimits the characters
998 used for the pseudo-terminal name from the file descriptor.
999 Otherwise, exactly two characters are used from the option for
1000 the pseudo-terminal name, the remainder is the file descriptor.
1001 Examples (the first two are equivalent since the descriptor
1002 follows the last “/”):
1003 -S/dev/pts/123/45
1005 -S123/45
1006 -Sab34
1007 Note that xterm does not close any file descriptor which it did
1009 not open for its own use. It is possible (though probably not
1010 portable) to have an application which passes an open file
1011 descriptor down to xterm past the initialization or the -S
1012 option to a process running in the xterm.
1013 Old Options
1015 The following command line arguments are provided for compatibility
1016 with older versions. They may not be supported in the next release as
1017 the X Toolkit provides standard options that accomplish the same task.
1018 %geom This option specifies the preferred size and position of the
1020 Tektronix window. It is shorthand for specifying the
1021 “tekGeometry” resource.
1022 #geom This option specifies the preferred position of the icon
1024 window. It is shorthand for specifying the “iconGeometry”
1025 resource.
1026 -T string
1028 This option specifies the title for xterm's windows. It is
1029 equivalent to -title.
1030 -n string
1032 This option specifies the icon name for xterm's windows. It is
1033 shorthand for specifying the “iconName” resource. Note that
1034 this is not the same as the toolkit option -name. The default
1035 icon name is the application name.
1036 If no suitable icon is found, xterm provides a compiled-in
1038 pixmap.
1039 -r This option indicates that reverse video should be simulated by
1041 swapping the foreground and background colors. It is
1042 equivalent to -rv.
1043 -w number
1045 This option specifies the width in pixels of the border
1046 surrounding the window. It is equivalent to -borderwidth or
1047 -bw.
1048 X Toolkit Options
1050 The following standard X Toolkit command line arguments are commonly
1051 used with xterm:
1052 -bd color
1054 This option specifies the color to use for the border of the
1055 window. The corresponding resource name is borderColor. Xterm
1056 uses the X Toolkit default, which is “XtDefaultForeground”.
1057 Xterm's VT100 window has two borders: the inner border
1059 internalBorder and the outer border borderWidth, managed by the
1060 X Toolkit. At startup, if the borderColor matches the
1061 foreground color, xterm will use the actual background color
1062 for the inner border.
1063 -bg color
1065 This option specifies the color to use for the background of
1066 the window. The corresponding resource name is background.
1067 The default is “XtDefaultBackground”.
1068 -bw number
1070 This option specifies the width in pixels of the border
1071 surrounding the window.
1072 This appears to be a legacy of older X releases. It sets the
1074 borderWidth resource of the shell widget, and may provide
1075 advice to your window manager to set the thickness of the
1076 window frame. Most window managers do not use this
1077 information. See the -b option, which controls the inner
1078 border of the xterm window.
1079 -display display
1081 This option specifies the X server to contact; see X(7).
1082 -fg color
1084 This option specifies the color to use for displaying text.
1085 The corresponding resource name is foreground. The default is
1086 “XtDefaultForeground”.
1087 -fn font
1089 This option specifies the font to be used for displaying normal
1090 text. The corresponding resource name is font. The resource
1091 value default is fixed.
1092 -font font
1094 This is the same as -fn.
1095 -geometry geometry
1097 This option specifies the preferred size and position of the
1098 VTxxx window; see X(7).
1099 The normal geometry specification can be suffixed with @
1101 followed by a Xinerama screen specification; it can be either g
1102 for the global screen (default), c for the current screen or a
1103 screen number.
1104 -iconic
1106 This option indicates that xterm should ask the window manager
1107 to start it as an icon rather than as the normal window. The
1108 corresponding resource name is iconic.
1109 -name name
1111 This option specifies the application name under which
1112 resources are to be obtained, rather than the default
1113 executable file name. Name should not contain “.” or “*”
1114 characters.
1115 -rv This option indicates that reverse video should be simulated by
1117 swapping the foreground and background colors. The
1118 corresponding resource name is reverseVideo.
1119 +rv Disable the simulation of reverse video by swapping foreground
1121 and background colors.
1122 -title string
1124 This option specifies the window title string, which may be
1125 displayed by window managers if the user so chooses. The
1126 default title is the command line specified after the -e
1127 option, if any, otherwise the application name.
1128 -xrm resourcestring
1130 This option specifies a resource string to be used. This is
1131 especially useful for setting resources that do not have
1132 separate command line options.
1133 X Toolkit accepts alternate names for a few of these options, e.g.,
1135 · “-background” for “-bg”
1137 · “-font” for “-fn”
1139 · “-foreground” for “-fg”
1141 Abbreviated options also are supported, e.g., “-v” for “-verbose.”
1143
1145 Xterm understands all of the core X Toolkit resource names and classes.
1146 Application specific resources (e.g., “XTerm.NAME”) follow:
1147 Application Resources
1149 backarrowKeyIsErase (class BackarrowKeyIsErase)
1150 Tie the VTxxx backarrowKey and ptyInitialErase resources
1151 together by setting the DECBKM state according to whether the
1152 initial erase character is a backspace (8) or delete (127)
1153 character. A “false” value disables this feature. The default
1154 is “False”.
1155 Here are tables showing how the initial settings for
1157 · backarrowKeyIsErase (BKIE),
1159 · backarrowKey (BK), and
1161 · ptyInitialErase (PIE), along with the
1163 · stty erase character (^H for backspace, ^? for delete)
1165 will affect DECBKM. First, xterm obtains the initial erase
1167 character:
1168 · xterm's internal value is ^H
1170 · xterm asks the operating system for the value which stty
1172 shows
1173 · the ttyModes resource may override erase
1175 · if ptyInitialErase is false, xterm will look in the
1177 terminal database
1178 Summarizing that as a table:
1180 PIE stty termcap erase
1182 ───────────────────────────────
1183 false ^H ^H ^H
1184 false ^H ^? ^?
1185 false ^? ^H ^H
1186 false ^? ^? ^?
1187 true ^H ^H ^H
1188 true ^H ^? ^H
1189 true ^? ^H ^?
1190 true ^? ^? ^?
1191 Using that erase character, xterm allows further choices:
1193 · if backarrowKeyIsErase is true, xterm uses the erase
1195 character for the initial state of DECBKM
1196 · if backarrowKeyIsErase is false, xterm sets DECBKM to 2
1198 (internal). This ties together backarrowKey and the
1199 control sequence for DECBKM.
1200 · applications can send a control sequence to set/reset
1202 DECBKM control set
1203 · the “Backarrow Key (BS/DEL)” menu entry toggles DECBKM
1205 Summarizing the initialization details:
1207 erase BKIE BK DECBKM result
1209 ────────────────────────────────────────
1210 ^? false false 2 ^H
1211 ^? false true 2 ^?
1212 ^? true false 0 ^?
1213 ^? true true 1 ^?
1214 ^H false false 2 ^H
1215 ^H false true 2 ^?
1216 ^H true false 0 ^H
1217 ^H true true 1 ^H
1218 fullscreen (class Fullscreen)
1220 Specifies whether or not xterm should ask the window manager to
1221 use a fullscreen layout on startup. Xterm accepts either a
1222 keyword (ignoring case) or the number shown in parentheses:
1223 false (0)
1225 Fullscreen layout is not used initially, but may be later
1226 via menu-selection or control sequence.
1227 true (1)
1229 Fullscreen layout is used initially, but may be disabled
1230 later via menu-selection or control sequence.
1231 always (2)
1233 Fullscreen layout is used initially, and cannot be disabled
1234 later via menu-selection or control sequence.
1235 never (3)
1237 Fullscreen layout is not used, and cannot be enabled later
1238 via menu-selection or control sequence.
1239 The default is “false”.
1241 hold (class Hold)
1243 If true, xterm will not immediately destroy its window when the
1244 shell command completes. It will wait until you use the window
1245 manager to destroy/kill the window, or if you use the menu
1246 entries that send a signal, e.g., HUP or KILL. You may scroll
1247 back, select text, etc., to perform most graphical operations.
1248 Resizing the display will lose data, however, since this
1249 involves interaction with the shell which is no longer running.
1250 hpFunctionKeys (class HpFunctionKeys)
1252 Specifies whether or not HP function key escape codes should be
1253 generated for function keys. The default is “false”, i.e.,
1254 this feature is disabled.
1255 The keyboardType resource is the preferred mechanism for
1257 selecting this mode.
1258 iconGeometry (class IconGeometry)
1260 Specifies the preferred size and position of the application
1261 when iconified. It is not necessarily obeyed by all window
1262 managers.
1263 iconHint (class IconHint)
1265 Specifies an icon which will be added to the window manager
1266 hints. Xterm provides no default value.
1267 Set this resource to “none” to omit the hint entirely, using
1269 whatever the window manager may decide.
1270 If the iconHint resource is given (or is set via the -n option)
1272 xterm searches for a pixmap file with that name, in the current
1273 directory as well as in /usr/share/pixmaps. if the resource
1274 does not specify an absolute pathname. In each case, xterm
1275 adds “_48x48” and/or “.xpm” to the filename after trying
1276 without those suffixes. If it is able to load the file, xterm
1277 sets the window manager hint for the icon-pixmap. These
1278 pixmaps are distributed with xterm, and can optionally be
1279 compiled-in:
1280 · mini.xterm_16x16, mini.xterm_32x32, mini.xterm_48x48
1282 · filled-xterm_16x16, filled-xterm_32x32, filled-xterm_48x48
1284 · xterm_16x16, xterm_32x32, xterm_48x48
1286 · xterm-color_16x16, xterm-color_32x32, xterm-color_48x48
1288 In either case, xterm allows for adding a “_48x48” to specify
1290 the largest of the pixmaps as a default. That is, “mini.xterm”
1291 is the same as “mini.xterm_48x48”.
1292 If no explicit iconHint resource is given (or if none of the
1294 compiled-in names matches), xterm uses “mini.xterm” (which is
1295 always compiled-in).
1296 The iconHint resource has no effect on “desktop” files,
1298 including “panel” and “menu”. Those are typically set via a
1299 “.desktop” file; xterm provides samples for itself (and the
1300 uxterm script). The more capable desktop systems allow
1301 changing the icon on a per-user basis.
1302 iconName (class IconName)
1304 Specifies a label for xterm when iconified. Xterm provides no
1305 default value; some window managers may assume the application
1306 name, e.g., “xterm”.
1307 Setting the iconName resource sets the icon label unless
1309 overridden by zIconBeep or the control sequences which change
1310 the window and icon labels.
1311 keyboardType (class KeyboardType)
1313 Enables one (or none) of the various keyboard-type resources:
1314 hpFunctionKeys, scoFunctionKeys, sunFunctionKeys,
1315 tcapFunctionKeys, oldXtermFKeys and sunKeyboard.
1316 The resource's value should be one of the corresponding strings
1318 “hp”, “sco”, “sun”, “tcap”, “legacy” or “vt220”, respectively.
1319 The individual resources are provided for legacy support; this
1321 resource is simpler to use. Xterm will use only one keyboard-
1322 type, but if multiple resources are set, it warns and uses the
1323 last one it checks.
1324 The default is “unknown”, i.e., none of the associated
1326 resources are set via this resource.
1327 maxBufSize (class MaxBufSize)
1329 Specify the maximum size of the input buffer. The default is
1330 “32768”. You cannot set this to a value less than the
1331 minBufSize resource. It will be increased as needed to make
1332 that value evenly divide this one.
1333 On some systems you may want to increase one or both of the
1335 maxBufSize and minBufSize resource values to achieve better
1336 performance if the operating system prefers larger buffer
1337 sizes.
1338 maximized (class Maximized)
1340 Specifies whether or not xterm should ask the window manager to
1341 maximize its layout on startup. The default is “false”.
1342 menuHeight (class MenuHeight)
1344 Specifies the height of the toolbar, which may be increased by
1345 the X toolkit layout widget depending upon the fontsize used.
1346 The default is “25”.
1347 messages (class Messages)
1349 Specifies whether write access to the terminal is allowed
1350 initially. See mesg(1). The default is “true”.
1351 menuLocale (class MenuLocale)
1353 Specify the locale used for character-set computations when
1354 loading the popup menus. Use this to improve initialization
1355 performance of the Athena popup menus, which may load
1356 unnecessary (and very large) fonts, e.g., in a locale having
1357 UTF-8 encoding. The default is “C” (POSIX).
1358 To use the current locale (only useful if you have localized
1360 the resource settings for the menu entries), set the resource
1361 to an empty string.
1362 minBufSize (class MinBufSize)
1364 Specify the minimum size of the input buffer, i.e., the amount
1365 of data that xterm requests on each read. The default is
1366 “4096”. You cannot set this to a value less than 64.
1367 omitTranslation (class OmitTranslation)
1369 Selectively omit one or more parts of xterm's default
1370 translations at startup. The resource value is a comma-
1371 separated list of keywords, which may be abbreviated:
1372 “fullscreen”, “scroll-lock”, “shift-fonts” or “wheel-mouse”.
1373 Xterm also recognizes “default”, but omitting that will make
1374 the program unusable unless you provide a similar definition in
1375 your resource settings.
1376 ptyHandshake (class PtyHandshake)
1378 If “true”, xterm will perform handshaking during initialization
1379 to ensure that the parent and child processes update the utmp
1380 and stty state.
1381 See also waitForMap which waits for the pseudo-terminal's
1383 notion of the screen size, and ptySttySize which resets the
1384 screen size after other terminal initialization is complete.
1385 The default is “true”.
1386 ptyInitialErase (class PtyInitialErase)
1388 If “true”, xterm will use the pseudo-terminal's sense of the
1389 stty erase value. If “false”, xterm will set the stty erase
1390 value to match its own configuration, using the kb string from
1391 the termcap entry as a reference, if available.
1392 In either case, the result is applied to the TERMCAP variable
1394 which xterm sets, if the system uses TERMCAP.
1395 See also the ttyModes resource, which may override this. The
1397 default is “False”.
1398 ptySttySize (class PtySttySize)
1400 If “true”, xterm will reset the screen size after terminal
1401 initialization is complete. This is needed for some systems
1402 whose pseudo-terminals cannot propagate terminal
1403 characteristics. Where it is not needed, it can interfere with
1404 other methods for setting the initial screen size, e.g., via
1405 window manager interaction.
1406 See also waitForMap which waits for a handshake-message giving
1408 the pseudo-terminal's notion of the screen size. The default
1409 is “false” on Linux and OS X systems, “true” otherwise.
1410 reportColors (class ReportColors)
1412 If true, xterm will print to the standard output a summary of
1413 colors as it allocates them. The default is “false”.
1414 reportFonts (class ReportFonts)
1416 If true, xterm will print to the standard output a summary of
1417 each font's metrics (size, number of glyphs, etc.), as it loads
1418 them. The default is “false”.
1419 reportIcons (class ReportIcons)
1421 If true, xterm will print to the standard output a summary of
1422 each pixmap icon as it loads them. The default is “false”.
1423 sameName (class SameName)
1425 If the value of this resource is “true”, xterm does not send
1426 title and icon name change requests when the request would have
1427 no effect: the name is not changed. This has the advantage of
1428 preventing flicker and the disadvantage of requiring an extra
1429 round trip to the server to find out the previous value. In
1430 practice this should never be a problem. The default is
1431 “true”.
1432 scaleHeight (class ScaleHeight)
1434 Scale line-height values by the resource value, which is
1435 limited to “0.9” to “1.5”. The default value is “1.0”,
1436 While this resource applies to either bitmap or TrueType fonts,
1438 its main purpose is to help work around incompatible changes in
1439 the Xft library's font metrics. Xterm checks the font metrics
1440 to find what the library claims are the bounding boxes for each
1441 glyph (character). However, some of Xft's features (such as
1442 the autohinter) can cause the glyphs to be scaled larger than
1443 the bounding boxes, and be partly overwritten by the next row.
1444 See useClipping for a related resource.
1446 scoFunctionKeys (class ScoFunctionKeys)
1448 Specifies whether or not SCO function key escape codes should
1449 be generated for function keys. The default is “false”, i.e.,
1450 this feature is disabled.
1451 The keyboardType resource is the preferred mechanism for
1453 selecting this mode.
1454 sessionMgt (class SessionMgt)
1456 If the value of this resource is “true”, xterm sets up session
1457 manager callbacks for XtNdieCallback and XtNsaveCallback. The
1458 default is “true”.
1459 sunFunctionKeys (class SunFunctionKeys)
1461 Specifies whether or not Sun function key escape codes should
1462 be generated for function keys. The default is “false”, i.e.,
1463 this feature is disabled.
1464 The keyboardType resource is the preferred mechanism for
1466 selecting this mode.
1467 sunKeyboard (class SunKeyboard)
1469 Xterm translates certain key symbols based on its assumptions
1470 about your keyboard. This resource specifies whether or not
1471 Sun/PC keyboard layout (i.e., the PC keyboard's numeric keypad
1472 together with 12 function keys) should be assumed rather than
1473 DEC VT220. This causes the keypad “+” to be mapped to “,”.
1474 and CTRL F1-F10 to F11-F20, depending on the setting of the
1475 ctrlFKeys resource, so xterm emulates a DEC VT220 more
1476 accurately. Otherwise (the default, with sunKeyboard set to
1477 “false”), xterm uses PC-style bindings for the function keys
1478 and keypad.
1479 PC-style bindings use the Shift, Alt, Control and Meta keys as
1481 modifiers for function-keys and keypad (see Xterm Control
1482 Sequences for details). The PC-style bindings are analogous to
1483 PCTerm, but not the same thing. Normally these bindings do not
1484 conflict with the use of the Meta key as described for the
1485 eightBitInput resource. If they do, note that the PC-style
1486 bindings are evaluated first.
1487 See also the keyboardType resource.
1489 tcapFunctionKeys (class TcapFunctionKeys)
1491 Specifies whether or not function key escape codes read from
1492 the termcap/terminfo entry corresponding to the TERM
1493 environment variable should be generated for function keys
1494 instead of those configured using sunKeyboard and keyboardType.
1495 The default is “false”, i.e., this feature is disabled.
1496 The keyboardType resource is the preferred mechanism for
1498 selecting this mode.
1499 termName (class TermName)
1501 Specifies the terminal type name to be set in the TERM
1502 environment variable.
1503 title (class Title)
1505 Specifies a string that may be used by the window manager when
1506 displaying this application.
1507 toolBar (class ToolBar)
1509 Specifies whether or not the toolbar should be displayed. The
1510 default is “true”.
1511 ttyModes (class TtyModes)
1513 Specifies a string containing terminal setting keywords and the
1514 characters to which they may be bound. Allowable keywords
1515 include: brk, dsusp, eof, eol, eol2, erase, erase2, flush,
1516 intr, kill, lnext, quit, rprnt, start, status, stop, susp,
1517 swtch and weras. Control characters may be specified as ^char
1518 (e.g., ^c or ^u) and ^? may be used to indicate delete (127).
1519 Use ^- to denote undef. Use \034 to represent ^\, since a
1520 literal backslash in an X resource escapes the next character.
1521 This is very useful for overriding the default terminal
1523 settings without having to do an stty every time an xterm is
1524 started. Note, however, that the stty program on a given host
1525 may use different keywords; xterm's table is built in.
1526 If the ttyModes resource specifies a value for erase, that
1528 overrides the ptyInitialErase resource setting, i.e., xterm
1529 initializes the terminal to match that value.
1530 useInsertMode (class UseInsertMode)
1532 Force use of insert mode by adding appropriate entries to the
1533 TERMCAP environment variable. This is useful if the system
1534 termcap is broken. (This resource is ignored on most systems,
1535 because TERMCAP is not used). The default is “false”.
1536 utmpDisplayId (class UtmpDisplayId)
1538 Specifies whether or not xterm should try to record the display
1539 identifier (display number and screen number) as well as the
1540 hostname in the system utmp log file. The default is “true”.
1541 utmpInhibit (class UtmpInhibit)
1543 Specifies whether or not xterm should try to record the user's
1544 terminal in the system utmp log file. If true, xterm will not
1545 try. The default is “false”.
1546 validShells (class ValidShells)
1548 Augment (add to) the system's /etc/shells, when determining
1549 whether to set the “SHELL” environment variable when running a
1550 given program.
1551 The resource value is a list of lines (separated by newlines).
1553 Each line holds one pathname. Xterm ignores any line beginning
1554 with “#” after trimming leading/trailing whitespace from each
1555 line.
1556 The default is an empty string.
1558 waitForMap (class WaitForMap)
1560 Specifies whether or not xterm should wait for the initial
1561 window map before starting the subprocess. This is part of the
1562 ptyHandshake logic. When xterm is directed to wait in this
1563 fashion, it passes the terminal size from the display end of
1564 the pseudo-terminal to the terminal I/O connection, e.g., using
1565 the size according to the window manager. Otherwise, it uses
1566 the size as given in resource values or command-line option
1567 -geometry. The default is “false”.
1568 zIconBeep (class ZIconBeep)
1570 Same as -ziconbeep command line argument. If the value of this
1571 resource is non-zero, xterms that produce output while
1572 iconified will cause an XBell sound at the given volume and
1573 have “*** ” prepended to their icon titles. Most window
1574 managers will detect this change immediately, showing you which
1575 window has the output. (A similar feature was in x10 xterm.)
1576 The default is “false”.
1577 zIconTitleFormat (class ZIconTitleFormat)
1579 Allow customization of the string used in the zIconBeep
1580 feature. The default value is “*** %s”.
1581 If the resource value contains a “%s”, then xterm inserts the
1583 icon title at that point rather than prepending the string to
1584 the icon title. (Only the first “%s” is used).
1585 VT100 Widget Resources
1587 The following resources are specified as part of the vt100 widget
1588 (class VT100). They are specified by patterns such as
1589 “XTerm.vt100.NAME”.
1590 If your xterm is configured to support the “toolbar”, then those
1592 patterns need an extra level for the form-widget which holds the
1593 toolbar and vt100 widget. A wildcard between the top-level “XTerm” and
1594 the “vt100” widget makes the resource settings work for either, e.g.,
1595 “XTerm*vt100.NAME”.
1596 activeIcon (class ActiveIcon)
1598 Specifies whether or not active icon windows are to be used
1599 when the xterm window is iconified, if this feature is compiled
1600 into xterm. The active icon is a miniature representation of
1601 the content of the window and will update as the content
1602 changes. Not all window managers necessarily support
1603 application icon windows. Some window managers will allow you
1604 to enter keystrokes into the active icon window. The default
1605 is “default”.
1606 Xterm accepts either a keyword (ignoring case) or the number
1608 shown in parentheses:
1609 false (0)
1611 No active icon is shown.
1612 true (1)
1614 The active icon is shown. If you are using twm, use
1615 this setting to enable active-icons.
1616 default (2)
1618 Xterm checks at startup, and shows an active icon only
1619 for window managers which it can identify and which are
1620 known to support the feature. These are fvwm (full
1621 support), and window maker (limited). A few other
1622 windows managers (such as twm and ctwm) support active
1623 icons, but do not support the extensions which allow
1624 xterm to identify the window manager.
1625 allowBoldFonts (class AllowBoldFonts)
1627 When set to “false”, xterm will not use bold fonts. This
1628 overrides both the alwaysBoldMode and the boldMode resources.
1629 allowC1Printable (class AllowC1Printable)
1631 If true, overrides the mapping of C1 controls (codes 128–159)
1632 to make them be treated as if they were printable characters.
1633 Although this corresponds to no particular standard, some users
1634 insist it is a VT100. The default is “false”.
1635 allowColorOps (class AllowColorOps)
1637 Specifies whether control sequences that set/query the dynamic
1638 colors should be allowed. ANSI colors are unaffected by this
1639 resource setting. The default is “true”.
1640 allowFontOps (class AllowFontOps)
1642 Specifies whether control sequences that set/query the font
1643 should be allowed. The default is “true”.
1644 allowMouseOps (class AllowMouseOps)
1646 Specifies whether control sequences that enable xterm to send
1647 escape sequences to the host on mouse-clicks and movement. The
1648 default is “true”.
1649 allowPasteControls (class AllowPasteControls)
1651 If true, allow control characters such as BEL and CAN to be
1652 pasted. Formatting characters (tab, newline) are always
1653 allowed. Other C0 control characters are suppressed unless
1654 this resource is enabled. The exact set of control characters
1655 (C0 and C1) depends upon whether UTF-8 encoding is used, as
1656 well as the allowC1Printable resource. The default is “false”.
1657 allowScrollLock (class AllowScrollLock)
1659 Specifies whether control sequences that set/query the Scroll
1660 Lock key should be allowed, as well as whether the Scroll Lock
1661 key responds to user's keypress. The default is “false”.
1662 When this feature is enabled, xterm will sense the state of the
1664 Scroll Lock key each time it acquires focus. Pressing the
1665 Scroll Lock key toggles xterm's internal state, as well as
1666 toggling the associated LED. While the Scroll Lock is active,
1667 xterm attempts to keep a viewport on the same set of lines. If
1668 the current viewport is scrolled past the limit set by the
1669 saveLines resource, then Scroll Lock has no further effect.
1670 The reason for setting the default to “false” is to avoid user
1672 surprise. This key is generally unused in keyboard
1673 configurations, and has not acquired a standard meaning even
1674 when it is used in that manner. Consequently, users have
1675 assigned it for ad hoc purposes.
1676 allowSendEvents (class AllowSendEvents)
1678 Specifies whether or not synthetic key and button events
1679 (generated using the X protocol SendEvent request) should be
1680 interpreted or discarded. The default is “false” meaning they
1681 are discarded. Note that allowing such events would create a
1682 very large security hole, therefore enabling this resource
1683 forcefully disables the allowXXXOps resources. The default is
1684 “false”.
1685 allowTcapOps (class AllowTcapOps)
1687 Specifies whether control sequences that query the terminal's
1688 notion of its function-key strings, as termcap or terminfo
1689 capabilities should be allowed. The default is “true”.
1690 A few programs, e.g., vim, use this feature to get an accurate
1692 description of the terminal's capabilities, independent of the
1693 termcap/terminfo setting:
1694 · Xterm can tell the querying program how many colors it
1696 supports. This is a constant, depending on how it is
1697 compiled, typically 16. It does not change if you alter
1698 resource settings, e.g., the boldColors resource.
1699 · Xterm can tell the querying program what strings are sent
1701 by modified (shift-, control-, alt-) function- and keypad-
1702 keys. Reporting control- and alt-modifiers is a feature
1703 that relies on the ncurses extended naming.
1704 allowTitleOps (class AllowTitleOps)
1706 Specifies whether control sequences that modify the window
1707 title or icon name should be allowed. The default is “true”.
1708 allowWindowOps (class AllowWindowOps)
1710 Specifies whether extended window control sequences (as used in
1711 dtterm) should be allowed. These include several control
1712 sequences which manipulate the window size or position, as well
1713 as reporting these values and the title or icon name. Each of
1714 these can be abused in a script; curiously enough most terminal
1715 emulators that implement these restrict only a small part of
1716 the repertoire. For fine-tuning, see disallowedWindowOps. The
1717 default is “false”.
1718 altIsNotMeta (class AltIsNotMeta)
1720 If “true”, treat the Alt-key as if it were the Meta-key. Your
1721 keyboard may happen to be configured so they are the same. But
1722 if they are not, this allows you to use the same prefix- and
1723 shifting operations with the Alt-key as with the Meta-key. See
1724 altSendsEscape and metaSendsEscape. The default is “false”.
1725 altSendsEscape (class AltSendsEscape)
1727 This is an additional keyboard operation that may be processed
1728 after the logic for metaSendsEscape. It is only available if
1729 the altIsNotMeta resource is set.
1730 · If “true”, Alt characters (a character combined with the
1732 modifier associated with left/right Alt-keys) are converted
1733 into a two-character sequence with the character itself
1734 preceded by ESC. This applies as well to function key
1735 control sequences, unless xterm sees that Alt is used in
1736 your key translations.
1737 · If “false”, Alt characters input from the keyboard cause a
1739 shift to 8-bit characters (just like metaSendsEscape). By
1740 combining the Alt- and Meta-modifiers, you can create
1741 corresponding combinations of ESC-prefix and 8-bit
1742 characters.
1743 The default is “False”. Xterm provides a menu option for
1745 toggling this resource.
1746 alternateScroll (class ScrollCond)
1748 If “true”, the scroll-back and scroll-forw actions send
1749 cursor-up and -down keys when xterm is displaying the alternate
1750 screen. The default is “false”.
1751 The alternateScroll state can also be set using a control
1753 sequence.
1754 alwaysBoldMode (class AlwaysBoldMode)
1756 Specifies whether xterm should check if the normal and bold
1757 fonts are distinct before deciding whether to use overstriking
1758 to simulate bold fonts. If this resource is true, xterm does
1759 not make the check for distinct fonts when deciding how to
1760 handle the boldMode resource. The default is “false”.
1761 boldMode alwaysBoldMode Comparison Action
1763 ────────────────────────────────────────────────────
1764 false false ignored use font
1765 false true ignored use font
1766 true false same overstrike
1767 true false different use font
1768 true true ignored overstrike
1769 This resource is used only for bitmap fonts:
1771 · When using bitmap fonts, it is possible that the font
1773 server will approximate the bold font by rescaling it from
1774 a different font size than expected. The alwaysBoldMode
1775 resource allows the user to override the (sometimes poor)
1776 resulting bold font with overstriking (which is at least
1777 consistent).
1778 · The problem does not occur with TrueType fonts (though
1780 there can be other unnecessary issues such as different
1781 coverage of the normal and bold fonts).
1782 As an alternative, setting the allowBoldFonts resource to false
1784 overrides both the alwaysBoldMode and the boldMode resources.
1785 alwaysHighlight (class AlwaysHighlight)
1787 Specifies whether or not xterm should always display a
1788 highlighted text cursor. By default (if this resource is
1789 false), a hollow text cursor is displayed whenever the pointer
1790 moves out of the window or the window loses the input focus.
1791 The default is “false”.
1792 alwaysUseMods (class AlwaysUseMods)
1794 Override the numLock resource, telling xterm to use the Alt and
1795 Meta modifiers to construct parameters for function key
1796 sequences even if those modifiers appear in the translations
1797 resource. Normally xterm checks if Alt or Meta is used in a
1798 translation that would conflict with function key modifiers,
1799 and will ignore these modifiers in that special case. The
1800 default is “false”.
1801 answerbackString (class AnswerbackString)
1803 Specifies the string that xterm sends in response to an ENQ
1804 (control/E) character from the host. The default is a blank
1805 string, i.e., “”. A hardware VT100 implements this feature as
1806 a setup option.
1807 appcursorDefault (class AppcursorDefault)
1809 If “true”, the cursor keys are initially in application mode.
1810 This is the same as the VT102 private DECCKM mode, The default
1811 is “false”.
1812 appkeypadDefault (class AppkeypadDefault)
1814 If “true”, the keypad keys are initially in application mode.
1815 The default is “false”.
1816 assumeAllChars (class AssumeAllChars)
1818 If “true”, this enables a special case in bitmap fonts to allow
1819 the font server to choose how to display missing glyphs. The
1820 default is “true”.
1821 The reason for this resource is to help with certain quasi-
1823 automatically generated fonts (such as the ISO-10646-1 encoding
1824 of Terminus) which have incorrect font-metrics.
1825 autoWrap (class AutoWrap)
1827 Specifies whether or not auto-wraparound should be enabled.
1828 This is the same as the VT102 DECAWM. The default is “true”.
1829 awaitInput (class AwaitInput)
1831 Specifies whether or not xterm uses a 50 millisecond timeout to
1832 await input (i.e., to support the Xaw3d arrow scrollbar). The
1833 default is “false”.
1834 backarrowKey (class BackarrowKey)
1836 Specifies whether the backarrow key transmits a backspace (8)
1837 or delete (127) character. This corresponds to the DECBKM
1838 control sequence. A “true” value specifies backspace. The
1839 default is “False”. Pressing the control key toggles this
1840 behavior.
1841 background (class Background)
1843 Specifies the color to use for the background of the window.
1844 The default is “XtDefaultBackground”.
1845 bellIsUrgent (class BellIsUrgent)
1847 Specifies whether to set the Urgency hint for the window
1848 manager when making a bell sound. The default is “false”.
1849 bellOnReset (class BellOnReset)
1851 Specifies whether to sound a bell when doing a hard reset. The
1852 default is “true”.
1853 bellSuppressTime (class BellSuppressTime)
1855 Number of milliseconds after a bell command is sent during
1856 which additional bells will be suppressed. Default is 200. If
1857 set non-zero, additional bells will also be suppressed until
1858 the server reports that processing of the first bell has been
1859 completed; this feature is most useful with the visible bell.
1860 boldColors (class ColorMode)
1862 Specifies whether to combine bold attribute with colors like
1863 the IBM PC, i.e., map colors 0 through 7 to colors 8 through
1864 15. These normally are the brighter versions of the first 8
1865 colors, hence bold. The default is “true”.
1866 boldFont (class BoldFont)
1868 Specifies the name of the bold font to use instead of
1869 overstriking. There is no default for this resource.
1870 This font must be the same height and width as the normal font,
1872 otherwise it is ignored. If only one of the normal or bold
1873 fonts is specified, it will be used as the normal font and the
1874 bold font will be produced by overstriking this font.
1875 See also the discussion of boldMode and alwaysBoldMode
1877 resources.
1878 boldMode (class BoldMode)
1880 This specifies whether or not text with the bold attribute
1881 should be overstruck to simulate bold fonts if the resolved
1882 bold font is the same as the normal font. It may be desirable
1883 to disable bold fonts when color is being used for the bold
1884 attribute.
1885 Note that xterm has one bold font which you may set explicitly.
1887 Xterm attempts to derive a bold font for the other font
1888 selections (font1 through font6). If it cannot find a bold
1889 font, it will use the normal font. In each case (whether the
1890 explicit resource or the derived font), if the normal and bold
1891 fonts are distinct, this resource has no effect. The default
1892 is “true”.
1893 See the alwaysBoldMode resource which can modify the behavior
1895 of this resource.
1896 Although xterm attempts to derive a bold font for other font
1898 selections, the font server may not cooperate. Since X11R6,
1899 bitmap fonts have been scaled. The font server claims to
1900 provide the bold font that xterm requests, but the result is
1901 not always readable. XFree86 introduced a feature which can be
1902 used to suppress the scaling. In the X server's configuration
1903 file (e.g., “/etc/X11/xorg.conf”), you can add “:unscaled” to
1904 the end of the directory specification for the “misc” fonts,
1905 which comprise the fixed-pitch fonts that are used by xterm.
1906 For example
1907 FontPath "/usr/share/X11/fonts/misc/"
1909 would become
1911 FontPath "/usr/share/X11/fonts/misc/:unscaled"
1913 Depending on your configuration, the font server may have its
1915 own configuration file. The same “:unscaled” can be added to
1916 its configuration file at the end of the directory
1917 specification for “misc”.
1918 The bitmap scaling feature is also used by xterm to implement
1920 VT102 double-width and double-height characters.
1921 brokenLinuxOSC (class BrokenLinuxOSC)
1923 If true, xterm applies a workaround to ignore malformed control
1924 sequences that a Linux script might send. Compare the palette
1925 control sequences documented in console_codes with ECMA-48.
1926 The default is “true”.
1927 brokenSelections (class BrokenSelections)
1929 If true, xterm in 8-bit mode will interpret STRING selections
1930 as carrying text in the current locale's encoding. Normally
1931 STRING selections carry ISO-8859-1 encoded text. Setting this
1932 resource to “true” violates the ICCCM; it may, however, be
1933 useful for interacting with some broken X clients. The default
1934 is “false”.
1935 brokenStringTerm (class BrokenStringTerm)
1937 provides a work-around for some ISDN routers which start an
1938 application control string without completing it. Set this to
1939 “true” if xterm appears to freeze when connecting. The default
1940 is “false”.
1941 Xterm's state parser recognizes several types of control
1943 strings which can contain text, e.g.,
1944 APC (Application Program Command),
1946 DCS (Device Control String),
1947 OSC (Operating System Command),
1948 PM (Privacy Message), and
1949 SOS (Start of String),
1950 Each should end with a string-terminator (a special character
1952 which cannot appear in these strings). Ordinary control
1953 characters found within the string are not ignored; they are
1954 processed without interfering with the process of accumulating
1955 the control string's content. Xterm recognizes these controls
1956 in all modes, although some of the functions may be suppressed
1957 after parsing the control.
1958 When enabled, this feature allows the user to exit from an
1960 unterminated control string when any of these ordinary control
1961 characters are found:
1962 control/D (used as an end of file in many shells),
1964 control/H (backspace),
1965 control/I (tab-feed),
1966 control/J (line feed aka newline),
1967 control/K (vertical tab),
1968 control/L (form feed),
1969 control/M (carriage return),
1970 control/N (shift-out),
1971 control/O (shift-in),
1972 control/Q (XOFF),
1973 control/X (cancel)
1974 c132 (class C132)
1976 Specifies whether or not the VT102 DECCOLM escape sequence,
1977 used to switch between 80 and 132 columns, should be honored.
1978 The default is “false”.
1979 cacheDoublesize (class CacheDoublesize)
1981 Tells whether to cache double-sized fonts by xterm. Set this
1982 to zero to disable double-sized fonts altogether.
1983 cdXtraScroll (class CdXtraScroll)
1985 Specifies whether xterm should scroll to a new page when
1986 clearing the whole screen. Like tiXtraScroll, the intent of
1987 this option is to provide a picture of the full-screen
1988 application's display on the scrollback before wiping out the
1989 text. The default for this resource is “false”.
1990 charClass (class CharClass)
1992 Specifies comma-separated lists of character class bindings of
1993 the form
1994 low[-high][:value].
1996 These are used in determining which sets of characters should
1998 be treated the same when doing cut and paste. See the
1999 CHARACTER CLASSES section.
2000 cjkWidth (class CjkWidth)
2002 Specifies whether xterm should follow the traditional East
2003 Asian width convention. When turned on, characters with East
2004 Asian Ambiguous (A) category in UTR 11 have a column width of
2005 2. You may have to set this option to “true” if you have some
2006 old East Asian terminal based programs that assume that line-
2007 drawing characters have a column width of 2. If this resource
2008 is false, the mkWidth resource controls the choice between the
2009 system's wcwidth and xterm's built-in tables. The default is
2010 “false”.
2011 color0 (class Color0)
2013 color1 (class Color1)
2015 color2 (class Color2)
2017 color3 (class Color3)
2019 color4 (class Color4)
2021 color5 (class Color5)
2023 color6 (class Color6)
2025 color7 (class Color7)
2027 These specify the colors for the ISO-6429 extension. The
2028 defaults are, respectively, black, red3, green3, yellow3, a
2029 customizable dark blue, magenta3, cyan3, and gray90. The
2030 default shades of color are chosen to allow the colors 8–15 to
2031 be used as brighter versions.
2032 color8 (class Color8)
2034 color9 (class Color9)
2036 color10 (class Color10)
2038 color11 (class Color11)
2040 color12 (class Color12)
2042 color13 (class Color13)
2044 color14 (class Color14)
2046 color15 (class Color15)
2048 These specify the colors for the ISO-6429 extension if the bold
2049 attribute is also enabled. The default resource values are
2050 respectively, gray30, red, green, yellow, a customizable light
2051 blue, magenta, cyan, and white.
2052 color16 (class Color16)
2054 through
2056 color255 (class Color255)
2058 These specify the colors for the 256-color extension. The
2059 default resource values are for colors 16 through 231 to make a
2060 6x6x6 color cube, and colors 232 through 255 to make a
2061 grayscale ramp.
2062 Resources past color15 are available as a compile-time option.
2064 Due to a hardcoded limit in the X libraries on the total number
2065 of resources (to 400), the resources for 256-colors are omitted
2066 when wide-character support and luit are enabled. Besides
2067 inconsistent behavior if only part of the resources were
2068 allowed, determining the exact cutoff is difficult, and the X
2069 libraries tend to crash if the number of resources exceeds the
2070 limit. The color palette is still initialized to the same
2071 default values, and can be modified via control sequences.
2072 On the other hand, the resource limit does permit including the
2074 entire range for 88-colors.
2075 colorAttrMode (class ColorAttrMode)
2077 Specifies whether colorBD, colorBL, colorRV, and colorUL should
2078 override ANSI colors. If not, these are displayed only when no
2079 ANSI colors have been set for the corresponding position. The
2080 default is “false”.
2081 colorBD (class ColorBD)
2083 This specifies the color to use to display bold characters if
2084 the “colorBDMode” resource is enabled. The default is
2085 “XtDefaultForeground”.
2086 See also the veryBoldColors resource which allows combining
2088 bold and color.
2089 colorBDMode (class ColorAttrMode)
2091 Specifies whether characters with the bold attribute should be
2092 displayed in color or as bold characters. Note that setting
2093 colorMode off disables all colors, including bold. The default
2094 is “false”.
2095 colorBL (class ColorBL)
2097 This specifies the color to use to display blink characters if
2098 the “colorBLMode” resource is enabled. The default is
2099 “XtDefaultForeground”.
2100 See also the veryBoldColors resource which allows combining
2102 underline and color.
2103 colorBLMode (class ColorAttrMode)
2105 Specifies whether characters with the blink attribute should be
2106 displayed in color. Note that setting colorMode off disables
2107 all colors, including this. The default is “false”.
2108 colorIT (class ColorIT)
2110 This specifies the color to use to display italic characters if
2111 the “colorITMode” resource is enabled. The default is
2112 “XtDefaultForeground”.
2113 See also the veryBoldColors resource which allows combining
2115 attributes and color.
2116 colorITMode (class ColorAttrMode)
2118 Specifies whether characters with the italic attribute should
2119 be displayed in color or as italic characters. The default is
2120 “false”.
2121 Note that:
2123 · Setting colorMode off disables all colors, including
2125 italic.
2126 · The italicULMode resource overrides colorITMode.
2128 colorMode (class ColorMode)
2130 Specifies whether or not recognition of ANSI (ISO-6429) color
2131 change escape sequences should be enabled. The default is
2132 “true”.
2133 colorRV (class ColorRV)
2135 This specifies the color to use to display reverse characters
2136 if the “colorRVMode” resource is enabled. The default is
2137 “XtDefaultForeground”.
2138 See also the veryBoldColors resource which allows combining
2140 reverse and color.
2141 colorRVMode (class ColorAttrMode)
2143 Specifies whether characters with the reverse attribute should
2144 be displayed in color. Note that setting colorMode off
2145 disables all colors, including this. The default is “false”.
2146 colorUL (class ColorUL)
2148 This specifies the color to use to display underlined
2149 characters if the “colorULMode” resource is enabled. The
2150 default is “XtDefaultForeground”.
2151 See also the veryBoldColors resource which allows combining
2153 underline and color.
2154 colorULMode (class ColorAttrMode)
2156 Specifies whether characters with the underline attribute
2157 should be displayed in color or as underlined characters. Note
2158 that setting colorMode off disables all colors, including
2159 underlining. The default is “false”.
2160 combiningChars (class CombiningChars)
2162 Specifies the number of wide-characters which can be stored in
2163 a cell to overstrike (combine) with the base character of the
2164 cell. This can be set to values in the range 0 to 5. The
2165 default is “2”.
2166 ctrlFKeys (class CtrlFKeys)
2168 In VT220 keyboard mode (see sunKeyboard resource), specifies
2169 the amount by which to shift F1-F12 given a control modifier
2170 (CTRL). This allows you to generate key symbols for F10-F20 on
2171 a Sun/PC keyboard. The default is “10”, which means that CTRL
2172 F1 generates the key symbol for F11.
2173 curses (class Curses)
2175 Specifies whether or not the last column bug in more(1) should
2176 be worked around. See the -cu option for details. The default
2177 is “false”.
2178 cursorBlink (class CursorBlink)
2180 Specifies whether to make the cursor blink. Xterm accepts
2181 either a keyword (ignoring case) or the number shown in
2182 parentheses:
2183 false (0)
2185 The cursor will not blink, but may be combined with escape
2186 sequences according to the cursorBlinkXOR resource.
2187 true (1)
2189 The cursor will blink, but may be combined with escape
2190 sequences according to the cursorBlinkXOR resource.
2191 always (2)
2193 The cursor will always blink, ignoring escape sequences.
2194 The menu entry will be disabled.
2195 never (3)
2197 The cursor will never blink, ignoring escape sequences. The
2198 menu entry will be disabled.
2199 The default is “false”.
2201 cursorBlinkXOR (class CursorBlinkXOR)
2203 Xterm uses two inputs to determine whether the cursor blinks:
2204 · The cursorBlink resource (which can be altered with a menu
2206 entry).
2207 · Control sequences (private mode 12 and DECSCUSR).
2209 The cursorBlinkXOR resource determines how those inputs are
2211 combined:
2212 false
2214 Xterm uses the logical-OR of the two variables. If either
2215 is set, xterm makes the cursor blink.
2216 true
2218 Xterm uses the logical-XOR of the two variables. If only
2219 one is set, xterm makes the cursor blink.
2220 The default is “true”.
2222 cursorColor (class CursorColor)
2224 Specifies the color to use for the text cursor. The default is
2225 “XtDefaultForeground”. By default, xterm attempts to keep this
2226 color from being the same as the background color, since it
2227 draws the cursor by filling the background of a text cell. The
2228 same restriction applies to control sequences which may change
2229 this color.
2230 Setting this resource overrides most of xterm's adjustments to
2232 cursor color. It will still use reverse-video to disallow some
2233 cases, such as a black cursor on a black background.
2234 cursorOffTime (class CursorOffTime)
2236 Specifies the duration of the “off” part of the cursor blink
2237 cycle-time in milliseconds. The same timer is used for text
2238 blinking. The default is “300”.
2239 cursorOnTime (class CursorOnTime)
2241 Specifies the duration of the “on” part of the cursor blink
2242 cycle-time, in milliseconds. The same timer is used for text
2243 blinking. The default is “600”.
2244 cursorUnderLine (class CursorUnderLine)
2246 Specifies whether to make the cursor underlined or a box. The
2247 default is “false”.
2248 cutNewline (class CutNewline)
2250 If “false”, triple clicking to select a line does not include
2251 the newline at the end of the line. If “true”, the Newline is
2252 selected. The default is “true”.
2253 cutToBeginningOfLine (class CutToBeginningOfLine)
2255 If “false”, triple clicking to select a line selects only from
2256 the current word forward. If “true”, the entire line is
2257 selected. The default is “true”.
2258 decTerminalID (class DecTerminalID)
2260 Specifies the emulation level (100=VT100, 220=VT220, etc.),
2261 used to determine the type of response to a DA control
2262 sequence. Leading non-digit characters are ignored, e.g.,
2263 “vt100” and “100” are the same. The default is “420”.
2264 defaultString (class DefaultString)
2266 Specify the character (or string) which xterm will substitute
2267 when pasted text includes a character which cannot be
2268 represented in the current encoding. For instance, pasting
2269 UTF-8 text into a display of ISO-8859-1 characters will only be
2270 able to display codes 0–255, while UTF-8 text can include
2271 Unicode values above 255. The default is “#” (a single pound
2272 sign).
2273 If the undisplayable text would be double-width, xterm will add
2275 a space after the “#” character, to give roughly the same
2276 layout on the screen as the original text.
2277 deleteIsDEL (class DeleteIsDEL)
2279 Specifies whether the Delete key on the editing keypad should
2280 send DEL (127) or the VT220-style Remove escape sequence. A
2281 “false” value enables the latter. The default is “Maybe”.
2282 directColor (class DirectColor)
2284 Specifies whether to handle direct-color control sequences
2285 using the X server's available colors, or to approximate those
2286 using a color map with 256 entries. A “true” value enables the
2287 former. The default is “true”.
2288 disallowedColorOps (class DisallowedColorOps)
2290 Specify which features will be disabled if allowColorOps is
2291 false. This is a comma-separated list of names. The default
2292 value is
2293 SetColor,GetColor,GetAnsiColor
2294 The names are listed below. Xterm ignores capitalization, but
2296 they are shown in mixed-case for clarity.
2297 SetColor
2299 Set a specific dynamic color.
2300 GetColor
2302 Report the current setting of a given dynamic color.
2303 GetAnsiColor
2305 Report the current setting of a given ANSI color (actually
2306 any of the colors set via ANSI-style controls).
2307 disallowedFontOps (class DisallowedFontOps)
2309 Specify which features will be disabled if allowFontOps is
2310 false. This is a comma-separated list of names. The default
2311 value is
2312 SetFont,GetFont
2314 The names are listed below. Xterm ignores capitalization, but
2316 they are shown in mixed-case for clarity.
2317 SetFont
2319 Set the specified font.
2320 GetFont
2322 Report the specified font.
2323 disallowedMouseOps (class DisallowedMouseOps)
2325 Specify which features will be disabled if allowMouseOps is
2326 false. This is a comma-separated list of names. The default
2327 value is “*” which matches all names. The names are listed
2328 below. Xterm ignores capitalization, but they are shown in
2329 mixed-case for clarity.
2330 X10 The original X10 mouse protocol.
2332 Locator
2334 DEC locator mode
2335 VT200Click
2337 X11 mouse-clicks only.
2338 VT200Hilite
2340 X11 mouse-clicks and highlighting.
2341 AnyButton
2343 XFree86 xterm any-button mode sends button-clicks as well
2344 as motion events while the button is pressed.
2345 AnyEvent
2347 XFree86 xterm any-event mode sends button-clicks as well
2348 as motion events whether or not a button is pressed.
2349 FocusEvent
2351 Send FocusIn/FocusOut events.
2352 Extended
2354 The first extension beyond X11 mouse protocol, this
2355 encodes the coordinates in UTF-8. It is deprecated in
2356 favor of SGR, but provided for compatibility.
2357 SGR This is the recommended extension for mouse-coordinates
2359 URXVT
2361 Like Extended, this is provided for compatibility.
2362 AlternateScroll
2364 This overrides the alternateScroll resource.
2365 disallowedPasteControls (class DisallowedPasteControls)
2367 The allowPasteControls resource is normally used to prevent
2368 pasting C1 controls, as well as non-formatting C0 controls such
2369 as the ASCII escape character. Those characters are simply
2370 ignored. This resource further extends the set of control
2371 characters which cannot be pasted, converting each into a
2372 space.
2373 The resource value is a comma-separated list of names. Xterm
2375 ignores capitalization. The default value is
2376 BS,HT,DEL
2378 The names are listed below:
2380 C0 all ASCII control characters.
2382 BS ASCII backspace
2384 CR ASCII carriage-return
2386 DEL ASCII delete
2388 HT ASCII tab
2390 NL ASCII line-feed, i.e., “newline”.
2392 disallowedTcapOps (class DisallowedTcapOps)
2394 Specify which features will be disabled if allowTcapOps is
2395 false. This is a comma-separated list of names. The default
2396 value is
2397 SetTcap,GetTcap
2399 The names are listed below. Xterm ignores capitalization, but
2401 they are shown in mixed-case for clarity.
2402 SetTcap
2404 (not implemented)
2405 GetTcap
2407 Report specified function- and other special keys.
2408 disallowedWindowOps (class DisallowedWindowOps)
2410 Specify which features will be disabled if allowWindowOps is
2411 false. This is a comma-separated list of names, or (for the
2412 controls adapted from dtterm the operation number). The
2413 default value is
2414 20,21,SetXprop,SetSelection
2416 (i.e. no operations are allowed).
2417 The names are listed below. Xterm ignores capitalization, but
2419 they are shown in mixed-case for clarity. Where a number can
2420 be used as an alternative, it is given in parentheses after the
2421 name.
2422 GetChecksum
2424 Report checksum of characters in a rectangular region.
2425 GetIconTitle (20)
2427 Report xterm window's icon label as a string.
2428 GetScreenSizeChars (19)
2430 Report the size of the screen in characters as numbers.
2431 GetSelection
2433 Report selection data as a base64 string.
2434 GetWinPosition (13)
2436 Report xterm window position as numbers.
2437 GetWinSizeChars (18)
2439 Report the size of the text area in characters as numbers.
2440 GetWinSizePixels (14)
2442 Report xterm window in pixels as numbers.
2443 GetWinState (11)
2445 Report xterm window state as a number.
2446 GetWinTitle (21)
2448 Report xterm window's title as a string.
2449 LowerWin (6)
2451 Lower the xterm window to the bottom of the stacking
2452 order.
2453 MaximizeWin (9)
2455 Maximize window (i.e., resize to screen size).
2456 FullscreenWin (10)
2458 Use full screen (i.e., resize to screen size, without
2459 window decorations).
2460 MinimizeWin (2)
2462 Iconify window.
2463 PopTitle (23)
2465 Pop title from internal stack.
2466 PushTitle (22)
2468 Push title to internal stack.
2469 RaiseWin (5)
2471 Raise the xterm window to the front of the stacking order.
2472 RefreshWin (7)
2474 Refresh the xterm window.
2475 RestoreWin (1)
2477 De-iconify window.
2478 SetSelection
2480 Set selection data.
2481 SetWinLines
2483 Resize to a given number of lines, at least 24.
2484 SetWinPosition (3)
2486 Move window to given coordinates.
2487 SetWinSizeChars (8)
2489 Resize the text area to given size in characters.
2490 SetWinSizePixels (4)
2492 Resize the xterm window to given size in pixels.
2493 SetXprop
2495 Set X property on top-level window.
2496 dynamicColors (class DynamicColors)
2498 Specifies whether or not escape sequences to change colors
2499 assigned to different attributes are recognized.
2500 eightBitControl (class EightBitControl)
2502 Specifies whether or not control sequences sent by the terminal
2503 should be eight-bit characters or escape sequences. The
2504 default is “false”.
2505 eightBitInput (class EightBitInput)
2507 If “true”, Meta characters (a single-byte character combined
2508 with the Meta modifier key) input from the keyboard are
2509 presented as a single character, modified according to the
2510 eightBitMeta resource. If “false”, Meta characters are
2511 converted into a two-character sequence with the character
2512 itself preceded by ESC. The default is “true”.
2513 The metaSendsEscape and altSendsEscape resources may override
2515 this feature. Generally keyboards do not have a key labeled
2516 “Meta”, but “Alt” keys are common, and they are conventionally
2517 used for “Meta”. If they were synonymous, it would have been
2518 reasonable to name this resource “altSendsEscape”, reversing
2519 its sense. For more background on this, see the meta(3x)
2520 function in curses.
2521 Note that the Alt key is not necessarily the same as the Meta
2523 modifier. The xmodmap utility lists your key modifiers. X
2524 defines modifiers for shift, (caps) lock and control, as well
2525 as 5 additional modifiers which are generally used to configure
2526 key modifiers. Xterm inspects the same information to find the
2527 modifier associated with either Meta key (left or right), and
2528 uses that key as the Meta modifier. It also looks for the
2529 NumLock key, to recognize the modifier which is associated with
2530 that.
2531 If your xmodmap configuration uses the same keycodes for Alt-
2533 and Meta-keys, xterm will only see the Alt-key definitions,
2534 since those are tested before Meta-keys. NumLock is tested
2535 first. It is important to keep these keys distinct; otherwise
2536 some of xterm's functionality is not available.
2537 The eightBitInput resource is tested at startup time. If
2539 “true”, the xterm tries to put the terminal into 8-bit mode.
2540 If “false”, on startup, xterm tries to put the terminal into
2541 7-bit mode. For some configurations this is unsuccessful;
2542 failure is ignored. After startup, xterm does not change the
2543 terminal between 8-bit and 7-bit mode.
2544 As originally implemented in X11, the resource value did not
2546 change after startup. However (since patch #216 in 2006) xterm
2547 can modify eightBitInput after startup via a control sequence.
2548 The corresponding terminfo capabilities smm (set meta mode) and
2549 rmm (reset meta mode) have been recognized by bash for some
2550 time. Interestingly enough, bash's notion of “meta mode”
2551 differs from the standard definition (in the terminfo manual),
2552 which describes the change to the eighth bit of a character.
2553 It happens that bash views “meta mode” as the ESC character
2554 that xterm puts before a character when a special meta key is
2555 pressed. bash's early documentation talks about the ESC
2556 character and ignores the eighth bit.
2557 eightBitMeta (class EightBitMeta)
2559 This controls the way xterm modifies the eighth bit of a
2560 single-byte key when the eightBitInput resource is set. The
2561 default is “locale”.
2562 The resource value is a string, evaluated as a boolean after
2564 startup.
2565 false
2567 The key is sent unmodified.
2568 locale
2570 The key is modified only if the locale uses eight-bit
2571 encoding.
2572 true The key is sent modified.
2574 never
2576 The key is always sent unmodified.
2577 Except for the never choice, xterm honors the terminfo
2579 capabilities smm (set meta mode) and rmm (reset meta mode),
2580 allowing the feature to be turned on or off dynamically.
2581 If eightBitMeta is enabled when the locale uses UTF-8, xterm
2583 encodes the value as UTF-8 (since patch #183 in 2003).
2584 eightBitOutput (class EightBitOutput)
2586 Specifies whether or not eight-bit characters sent from the
2587 host should be accepted as is or stripped when printed. The
2588 default is “true”, which means that they are accepted as is.
2589 eightBitSelectTypes (class EightBitSelectTypes)
2591 Override xterm's default selection target list (see
2592 SELECT/PASTE) for selections in normal (ISO-8859-1) mode. The
2593 default is an empty string, i.e., “”, which does not override
2594 anything.
2595 eraseSavedLines (class EraseSavedLines)
2597 Specifies whether or not to allow xterm extended ED/DECSED
2598 control sequences to erase the saved-line buffer. The default
2599 is “true”.
2600 faceName (class FaceName)
2602 Specify the pattern for scalable fonts selected from the
2603 FreeType library if support for that library was compiled into
2604 xterm. There is no default value.
2605 One or more fonts can be specified, separated by commas. If
2607 prefixed with “x:” or “x11:” the specification applies to the
2608 XLFD font resource. A “xft:” prefix is accepted but
2609 unnecessary since a missing prefix for faceName means that it
2610 will be used for TrueType. For example,
2611 XTerm*faceName: x:fixed,xft:Bitstream Vera Sans Mono
2613 If no faceName resource is specified, or if there is no match
2615 for both TrueType normal and bold fonts, xterm uses the XLFD
2616 (bitmap) font and related resources.
2617 It is possible to select suitable bitmap fonts using a script
2619 such as this:
2620 #!/bin/sh
2622 FONT=`xfontsel -print`
2623 test -n "$FONT" && xfd -fn "$FONT"
2624 However (even though xfd accepts a “-fa” option to denote
2626 FreeType fonts), xfontsel has not been similarly extended. As
2627 a workaround, you may try
2628 fc-list :scalable=true:spacing=mono: family
2630 to find a list of scalable fixed-pitch fonts which may be used
2632 for the faceName resource value.
2633 faceNameDoublesize (class FaceNameDoublesize)
2635 Specify a double-width scalable font for cases where an
2636 application requires this, e.g., in CJK applications. There is
2637 no default value.
2638 Like the faceName resource, this allows one or more comma-
2640 separated font specifications to be applied to the wide
2641 TrueType or XLFD fonts.
2642 If the application uses double-wide characters and this
2644 resource is not given, xterm will use a scaled version of the
2645 font given by faceName.
2646 faceSize (class FaceSize)
2648 Specify the pointsize for fonts selected from the FreeType
2649 library if support for that library was compiled into xterm.
2650 The default is “14.0” On the VT Fonts menu, this corresponds to
2651 the Default entry.
2652 Although the default is “14.0”, this may not be the same as the
2654 pointsize for the default bitmap font, i.e., that assigned with
2655 the -fn option, or the font resource. For example, the “fixed”
2656 font usually has a pointsize of “8.0”. If you set faceSize to
2657 match the size of the bitmap font, then switching between
2658 bitmap and TrueType fonts via the font menu will give
2659 comparable sizes for the window.
2660 You can specify the pointsize for TrueType fonts selected with
2662 the other size-related menu entries such as Medium, Huge, etc.,
2663 by using one of the following resource values. If you do not
2664 specify a value, they default to “0.0”, which causes xterm to
2665 use the ratio of font sizes from the corresponding bitmap font
2666 resources to obtain a TrueType pointsize.
2667 If all of the faceSize resources are set, then xterm will use
2669 this information to determine the next smaller/larger TrueType
2670 font for the larger-vt-font() and smaller-vt-font() actions.
2671 If any are not set, xterm will use only the areas of the bitmap
2672 fonts.
2673 faceSize1 (class FaceSize1)
2675 Specifies the pointsize of the first alternative font.
2676 faceSize2 (class FaceSize2)
2678 Specifies the pointsize of the second alternative font.
2679 faceSize3 (class FaceSize3)
2681 Specifies the pointsize of the third alternative font.
2682 faceSize4 (class FaceSize4)
2684 Specifies the pointsize of the fourth alternative font.
2685 faceSize5 (class FaceSize5)
2687 Specifies the pointsize of the fifth alternative font.
2688 faceSize6 (class FaceSize6)
2690 Specifies the pointsize of the sixth alternative font.
2691 font (class Font)
2693 Specifies the name of the normal font. The default is “fixed”.
2694 See the discussion of the locale resource, which describes how
2696 this font may be overridden.
2697 NOTE: some resource files use patterns such as
2699 *font: fixed
2701 which are overly broad, affecting both
2703 xterm.vt100.font
2705 and
2707 xterm.vt100.utf8Fonts.font
2709 which is probably not what you intended.
2711 fastScroll (class FastScroll)
2713 Modifies the effect of jump scroll (jumpScroll) by suppressing
2714 screen refreshes for the special case when output to the screen
2715 has completely shifted the contents off-screen. For instance,
2716 cat'ing a large file to the screen does this.
2717 font1 (class Font1)
2719 Specifies the name of the first alternative font, corresponding
2720 to “Unreadable” in the standard menu.
2721 font2 (class Font2)
2723 Specifies the name of the second alternative font,
2724 corresponding to “Tiny” in the standard menu.
2725 font3 (class Font3)
2727 Specifies the name of the third alternative font, corresponding
2728 to “Small” in the standard menu.
2729 font4 (class Font4)
2731 Specifies the name of the fourth alternative font,
2732 corresponding to “Medium” in the standard menu.
2733 font5 (class Font5)
2735 Specifies the name of the fifth alternative font, corresponding
2736 to “Large” in the standard menu.
2737 font6 (class Font6)
2739 Specifies the name of the sixth alternative font, corresponding
2740 to “Huge” in the standard menu.
2741 fontDoublesize (class FontDoublesize)
2743 Specifies whether xterm should attempt to use font scaling to
2744 draw double-sized characters. Some older font servers cannot
2745 do this properly, will return misleading font metrics. The
2746 default is “true”. If disabled, xterm will simulate double-
2747 sized characters by drawing normal characters with spaces
2748 between them.
2749 fontWarnings (class FontWarnings)
2751 Specify whether xterm should report an error if it fails to
2752 load a font:
2753 0 Never report an error (though the X libraries may).
2755 1 Report an error if the font name was given as a resource
2757 setting.
2758 2 Always report an error on failure to load a font.
2760 The default is “1”.
2762 forceBoxChars (class ForceBoxChars)
2764 Specifies whether xterm should assume the normal and bold fonts
2765 have VT100 line-drawing characters:
2766 · The fixed-pitch ISO-8859-*-encoded fonts used by xterm
2768 normally have the VT100 line-drawing glyphs in cells 1–31.
2769 Other fixed-pitch fonts may be more attractive, but lack
2770 these glyphs.
2771 · When using an ISO-10646-1 font and the wideChars resource
2773 is true, xterm uses the Unicode glyphs which match the
2774 VT100 line-drawing glyphs.
2775 If “false”, xterm checks for missing glyphs in the font and
2777 makes line-drawing characters directly as needed. If “true”,
2778 xterm assumes the font does not contain the line-drawing
2779 characters, and draws them directly. The default is “false”.
2780 forcePackedFont (class ForcePackedFont)
2782 Specifies whether xterm should use the maximum or minimum glyph
2783 width when displaying using a bitmap font. Use the maximum
2784 width to help with proportional fonts. The default is “true”,
2785 denoting the minimum width.
2786 foreground (class Foreground)
2788 Specifies the color to use for displaying text in the window.
2789 Setting the class name instead of the instance name is an easy
2790 way to have everything that would normally appear in the text
2791 color change color. The default is “XtDefaultForeground”.
2792 formatOtherKeys (class FormatOtherKeys)
2794 Overrides the format of the escape sequence used to report
2795 modified keys with the modifyOtherKeys resource.
2796 0 send modified keys as parameters for function-key 27
2798 (default).
2799 1 send modified keys as parameters for CSI u.
2801 freeBoldBox (class FreeBoldBox)
2803 Specifies whether xterm should assume the bounding boxes for
2804 normal and bold fonts are compatible. If “false”, xterm
2805 compares them and will reject choices of bold fonts that do not
2806 match the size of the normal font. The default is “false”,
2807 which means that the comparison is performed.
2808 geometry (class Geometry)
2810 Specifies the preferred size and position of the VTxxx window.
2811 There is no default for this resource.
2812 highlightColor (class HighlightColor)
2814 Specifies the color to use for the background of selected
2815 (highlighted) text. If not specified (i.e., matching the
2816 default foreground), reverse video is used. The default is
2817 “XtDefaultForeground”.
2818 highlightColorMode (class HighlightColorMode)
2820 Specifies whether xterm should use highlightTextColor and
2821 highlightColor to override the reversed foreground/background
2822 colors in a selection. The default is unspecified: at startup,
2823 xterm checks if those resources are set to something other than
2824 the default foreground and background colors. Setting this
2825 resource disables the check.
2826 The following table shows the interaction of the highlighting
2828 resources, abbreviated as shown to fit in this page:
2829 HCM
2831 highlightColorMode
2832 HR highlightReverse
2834 HBG
2836 highlightColor
2837 HFG
2839 highlightTextColor
2840 HCM HR HBG HFG Highlight
2842 ────────────────────────────────────────────────
2843 false false default default bg/fg
2844 false false default set bg/fg
2845 false false set default fg/HBG
2846 false false set set fg/HBG
2847 ────────────────────────────────────────────────
2848 false true default default bg/fg
2849 false true default set bg/fg
2850 false true set default fg/HBG
2851 false true set set fg/HBG
2852 ────────────────────────────────────────────────
2853 true false default default bg/fg
2854 true false default set HFG/fg
2855 true false set default bg/HBG
2856 true false set set HFG/HBG
2857 ────────────────────────────────────────────────
2858 true true default default bg/fg
2859 true true default set HFG/fg
2860 true true set default fg/HBG
2861 true true set set HFG/HBG
2862 ────────────────────────────────────────────────
2863 default false default default bg/fg
2864 default false default set bg/fg
2865 default false set default fg/HBG
2866 default false set set HFG/HBG
2867 ────────────────────────────────────────────────
2868 default true default default bg/fg
2869 default true default set bg/fg
2870 default true set default fg/HBG
2871 default true set set HFG/HBG
2872 ────────────────────────────────────────────────
2873 highlightReverse (class HighlightReverse)
2875 Specifies whether xterm should reverse the selection foreground
2876 and background colors when selecting text with reverse-video
2877 attribute. This applies only to the highlightColor and
2878 highlightTextColor resources, e.g., to match the color scheme
2879 of xwsh. If “true”, xterm reverses the colors, If “false”,
2880 xterm does not reverse colors, The default is “true”.
2881 highlightSelection (class HighlightSelection)
2883 Tells xterm whether to highlight all of the selected positions,
2884 or only the selected text:
2885 · If “false”, selecting with the mouse highlights all
2887 positions on the screen between the beginning of the
2888 selection and the current position.
2889 · If “true”, xterm highlights only the positions that contain
2891 text that can be selected.
2892 The default is “false”.
2894 Depending on the way your applications write to the screen,
2896 there may be trailing blanks on a line. Xterm stores data as
2897 it is shown on the screen. Erasing the display changes the
2898 internal state of each cell so it is not considered a blank for
2899 the purpose of selection. Blanks written since the last erase
2900 are selectable. If you do not wish to have trailing blanks in
2901 a selection, use the trimSelection resource.
2902 highlightTextColor (class HighlightTextColor)
2904 Specifies the color to use for the foreground of selected
2905 (highlighted) text. If not specified (i.e., matching the
2906 default background), reverse video is used. The default is
2907 “XtDefaultBackground”.
2908 hpLowerleftBugCompat (class HpLowerleftBugCompat)
2910 Specifies whether to work around a bug in HP's xdb, which
2911 ignores termcap and always sends ESC F to move to the lower
2912 left corner. “true” causes xterm to interpret ESC F as a
2913 request to move to the lower left corner of the screen. The
2914 default is “false”.
2915 i18nSelections (class I18nSelections)
2917 If false, xterm will not request the targets COMPOUND_TEXT or
2918 TEXT. The default is “true”. It may be set to false in order
2919 to work around ICCCM violations by other X clients.
2920 iconBorderColor (class BorderColor)
2922 Specifies the border color for the active icon window if this
2923 feature is compiled into xterm. Not all window managers will
2924 make the icon border visible.
2925 iconBorderWidth (class BorderWidth)
2927 Specifies the border width for the active icon window if this
2928 feature is compiled into xterm. The default is “2”. Not all
2929 window managers will make the border visible.
2930 iconFont (class IconFont)
2932 Specifies the font for the miniature active icon window, if
2933 this feature is compiled into xterm. The default is “nil2”.
2934 initialFont (class InitialFont)
2936 Specifies which of the VT100 fonts to use initially. Values
2937 are the same as for the set-vt-font action. The default is
2938 “d”, i.e., “default”.
2939 inputMethod (class InputMethod)
2941 Tells xterm which type of input method to use. There is no
2942 default method.
2943 internalBorder (class BorderWidth)
2945 Specifies the number of pixels between the characters and the
2946 window border. The default is “2”.
2947 italicULMode (class ColorAttrMode)
2949 Specifies whether characters with the underline attribute
2950 should be displayed in an italic font or as underlined
2951 characters. It is implemented only for TrueType fonts.
2952 jumpScroll (class JumpScroll)
2954 Specifies whether or not jump scroll should be used. This
2955 corresponds to the VT102 DECSCLM private mode. The default is
2956 “true”. See fastScroll for a variation.
2957 keepClipboard (class KeepClipboard)
2959 Specifies whether xterm will reuse the selection data which it
2960 copied to the keyboard rather than asking the clipboard for its
2961 current contents when told to provide the selection. The
2962 default is “false”.
2963 keepSelection (class KeepSelection)
2965 Specifies whether xterm will keep the selection even after the
2966 selected area was touched by some output to the terminal. The
2967 default is “true”.
2968 keyboardDialect (class KeyboardDialect)
2970 Specifies the initial keyboard dialect, as well as the default
2971 value when the terminal is reset. The value given is the same
2972 as the final character in the control sequences which change
2973 character sets. The default is “B”, which corresponds to US
2974 ASCII.
2975 nameKeymap (class NameKeymap)
2977 See the discussion of the keymap() action.
2978 limitResize (class LimitResize)
2980 Limits resizing of the screen via control sequence to a given
2981 multiple of the display dimensions. The default is “1”.
2982 locale (class Locale)
2984 Specifies how to use luit, an encoding converter between UTF-8
2985 and locale encodings. The resource value (ignoring case) may
2986 be:
2987 true
2989 Xterm will use the encoding specified by the users'
2990 LC_CTYPE locale (i.e., LC_ALL, LC_CTYPE, or LANG variables)
2991 as far as possible. This is realized by always enabling
2992 UTF-8 mode and invoking luit in non-UTF-8 locales.
2993 medium
2995 Xterm will follow users' LC_CTYPE locale only for UTF-8,
2996 east Asian, and Thai locales, where the encodings were not
2997 supported by conventional 8bit mode with changing fonts.
2998 For other locales, xterm will use conventional 8bit mode.
2999 checkfont
3001 If mini-luit is compiled-in, xterm will check if a Unicode
3002 font has been specified. If so, it checks if the character
3003 encoding for the current locale is POSIX, Latin-1 or
3004 Latin-9, uses the appropriate mapping to support those with
3005 the Unicode font. For other encodings, xterm assumes that
3006 UTF-8 encoding is required.
3007 false
3009 Xterm will use conventional 8bit mode or UTF-8 mode
3010 according to utf8 resource or -u8 option.
3011 Any other value, e.g., “UTF-8” or “ISO8859-2”, is assumed to be
3013 an encoding name; luit will be invoked to support the encoding.
3014 The actual list of supported encodings depends on luit. The
3015 default is “medium”.
3016 Regardless of your locale and encoding, you need an ISO-10646-1
3018 font to display the result. Your configuration may not include
3019 this font, or locale-support by xterm may not be needed.
3020 At startup, xterm uses a mechanism equivalent to the load-vt-
3022 fonts(utf8Fonts, Utf8Fonts) action to load font name
3023 subresources of the VT100 widget. That is, resource patterns
3024 such as “*vt100.utf8Fonts.font” will be loaded, and (if this
3025 resource is enabled), override the normal fonts. If no
3026 subresources are found, the normal fonts such as “*vt100.font”,
3027 etc., are used.
3028 For instance, you could have this in your resource file:
3030 *VT100.font: 12x24
3032 *VT100.utf8Fonts.font:9x15
3033 When started with a UTF-8 locale, xterm would use 9x15, but
3035 allow you to switch to the 12x24 font using the menu entry
3036 “UTF-8 Fonts”.
3037 The resource files distributed with xterm use ISO-10646-1
3039 fonts, but do not rely on them unless you are using the locale
3040 mechanism.
3041 localeFilter (class LocaleFilter)
3043 Specifies the file name for the encoding converter from/to
3044 locale encodings and UTF-8 which is used with the -lc option or
3045 locale resource. The help message shown by “xterm -help” lists
3046 the default value, which depends on your system configuration.
3047 If the encoding converter requires command-line parameters, you
3049 can add those after the command, e.g.,
3050 *localeFilter: xterm-filter -p
3052 Alternatively, you may put those parameter within a shell
3054 script to execute the converter, and set this resource to point
3055 to the shell script.
3056 When using a locale-filter, e.g., with the -e option, or the
3058 shell, xterm first tries passing control via that filter. If
3059 it fails, xterm will retry without the locale-filter. Xterm
3060 warns about the failure before retrying.
3061 loginShell (class LoginShell)
3063 Specifies whether or not the shell to be run in the window
3064 should be started as a login shell. The default is “false”.
3065 logFile (class Logfile)
3067 Specify the name for xterm's log-file. If no name is
3068 specified, xterm will generate a name when logging is enabled,
3069 as described in the -l option.
3070 logInhibit (class LogInhibit)
3072 If “true”, prevent the logging feature from being enabled,
3073 whether by the command-line option -l, or the menu entry Log to
3074 File. The default is “false”.
3075 logging (class Logging)
3077 If “true”, (and if logInhibit is not set) enable the logging
3078 feature. This resource is set/updated by the -l option and the
3079 menu entry Log to File. The default is “false”.
3080 marginBell (class MarginBell)
3082 Specifies whether or not the bell should be rung when the user
3083 types near the right margin. The default is “false”.
3084 maxGraphicSize (class MaxGraphicSize)
3086 If xterm is configured to support ReGIS or SIXEL graphics, this
3087 resource controls the maximum size of a graph which can be
3088 displayed.
3089 The default is “1000x1000” (given as width by height).
3091 If the resource is “auto” then xterm will use the decTerminalID
3093 resource:
3094 Result decTerminalID
3096 ────────────────────────
3097 768x400 125
3098 800x460 240
3100 800x460 241
3101 800x480 330
3102 800x480 340
3103 860x750 382
3104 800x480 other
3105 metaSendsEscape (class MetaSendsEscape)
3107 Tells xterm what to do with input-characters modified by Meta:
3108 · If “true”, Meta characters (a character combined with the
3110 Meta modifier key) are converted into a two-character
3111 sequence with the character itself preceded by ESC. This
3112 applies as well to function key control sequences, unless
3113 xterm sees that Meta is used in your key translations.
3114 · If “false”, Meta characters input from the keyboard are
3116 handled according to the eightBitInput resource.
3117 The default is “True”.
3119 mkSamplePass (class MkSamplePass)
3121 If mkSampleSize is nonzero, and mkWidth (and cjkWidth) are
3122 false, on startup xterm compares its built-in tables to the
3123 system's wide character width data to decide if it will use the
3124 system's data. It tests the first mkSampleSize character
3125 values, and allows up to mkSamplePass mismatches before the
3126 test fails. The default (for the allowed number of mismatches)
3127 is 655 (one percent of the default value for mkSampleSize).
3128 mkSampleSize (class MkSampleSize)
3130 With mkSamplePass, this specifies a startup test used for
3131 initializing wide character width calculations. The default
3132 (number of characters to check) is 65536.
3133 mkWidth (class MkWidth)
3135 Specifies whether xterm should use a built-in version of the
3136 wide character width calculation. See also the cjkWidth
3137 resource which can override this. The default is “false”.
3138 Here is a summary of the resources which control the choice of
3140 wide character width calculation:
3141 cjkWidth mkWidth Action
3143 ───────────────────────────────────────────────────────────────
3144 false false use system tables subject to mkSamplePass
3145 false true use built-in tables
3146 true false use built-in CJK tables
3147 true true use built-in CJK tables
3148 modifyCursorKeys (class ModifyCursorKeys)
3150 Tells how to handle the special case where Control-, Shift-,
3151 Alt- or Meta-modifiers are used to add a parameter to the
3152 escape sequence returned by a cursor-key. The default is “2”:
3153 -1 disables the feature.
3155 0 uses the old/obsolete behavior, i.e., the modifier is the
3157 first parameter.
3158 1 prefixes modified sequences with CSI.
3160 2 forces the modifier to be the second parameter if it would
3162 otherwise be the first.
3163 3 marks the sequence with a “>” to hint that it is private.
3165 modifyFunctionKeys (class ModifyFunctionKeys)
3167 Tells how to handle the special case where Control-, Shift-,
3168 Alt- or Meta-modifiers are used to add a parameter to the
3169 escape sequence returned by a (numbered) function-key. The
3170 default is “2”. The resource values are similar to
3171 modifyCursorKeys:
3172 -1 permits the user to use shift- and control-modifiers to
3174 construct function-key strings using the normal encoding
3175 scheme.
3176 0 uses the old/obsolete behavior, i.e., the modifier is the
3178 first parameter.
3179 1 prefixes modified sequences with CSI.
3181 2 forces the modifier to be the second parameter if it would
3183 otherwise be the first.
3184 3 marks the sequence with a “>” to hint that it is private.
3186 If modifyFunctionKeys is zero, xterm uses Control- and Shift-
3188 modifiers to allow the user to construct numbered function-keys
3189 beyond the set provided by the keyboard:
3190 Control
3192 adds the value given by the ctrlFKeys resource.
3193 Shift
3195 adds twice the value given by the ctrlFKeys resource.
3196 Control/Shift
3198 adds three times the value given by the ctrlFKeys
3199 resource.
3200 modifyKeyboard (class ModifyKeyboard)
3202 Normally xterm makes a special case regarding modifiers (shift,
3203 control, etc.) to handle special keyboard layouts (legacy and
3204 vt220). This is done to provide compatible keyboards for DEC
3205 VT220 and related terminals that implement user-defined keys
3206 (UDK).
3207 The bits of the resource value selectively enable modification
3209 of the given category when these keyboards are selected. The
3210 default is “0”:
3211 0 The legacy/vt220 keyboards interpret only the Control-
3213 modifier when constructing numbered function-keys. Other
3214 special keys are not modified.
3215 1 allows modification of the numeric keypad
3217 2 allows modification of the editing keypad
3219 4 allows modification of function-keys, overrides use of
3221 Shift-modifier for UDK.
3222 8 allows modification of other special keys
3224 modifyOtherKeys (class ModifyOtherKeys)
3226 Like modifyCursorKeys, tells xterm to construct an escape
3227 sequence for other keys (such as “2”) when modified by
3228 Control-, Alt- or Meta-modifiers. This feature does not apply
3229 to function keys and well-defined keys such as ESC or the
3230 control keys. The default is “0”:
3231 0 disables this feature.
3233 1 enables this feature for keys except for those with well-
3235 known behavior, e.g., Tab, Backarrow and some special
3236 control character cases, e.g., Control-Space to make a
3237 NUL.
3238 2 enables this feature for keys including the exceptions
3240 listed.
3241 multiClickTime (class MultiClickTime)
3243 Specifies the maximum time in milliseconds between multi-click
3244 select events. The default is “250” milliseconds.
3245 multiScroll (class MultiScroll)
3247 Specifies whether or not scrolling should be done
3248 asynchronously. The default is “false”.
3249 nMarginBell (class Column)
3251 Specifies the number of characters from the right margin at
3252 which the margin bell should be rung, when enabled by the
3253 marginBell resource. The default is “10”.
3254 nextEventDelay (class NextEventDelay)
3256 Specifies a delay time in milliseconds before checking for new
3257 X events. The default is “1”.
3258 numColorRegisters (class NumColorRegisters)
3260 If xterm is configured to support ReGIS or SIXEL graphics, this
3261 specifies the number of color-registers which are available.
3262 If this resource is not specified, xterm uses a value
3264 determined by the decTerminalID resource:
3265 Result decTerminalID
3267 ───────────────────────
3268 4 125
3269 4 240
3270 4 241
3271 4 330
3272 16 340
3273 2 382
3274 1024 other
3275 numLock (class NumLock)
3277 If “true”, xterm checks if NumLock is used as a modifier (see
3278 xmodmap(1)). If so, this modifier is used to simplify the
3279 logic when implementing special NumLock for the sunKeyboard
3280 resource. Also (when sunKeyboard is false), similar logic is
3281 used to find the modifier associated with the left and right
3282 Alt keys. The default is “true”.
3283 oldXtermFKeys (class OldXtermFKeys)
3285 If “true”, xterm will use old-style (X11R5) escape sequences
3286 for function keys F1 to F4, for compatibility with X Consortium
3287 xterm. Otherwise, it uses the VT100 codes for PF1 to PF4. The
3288 default is “false”.
3289 Setting this resource has the same effect as setting the
3291 keyboardType to legacy. The keyboardType resource is the
3292 preferred mechanism for selecting this mode.
3293 The old-style escape sequences resemble VT220 keys, but appear
3295 to have been invented for xterm in X11R4.
3296 on2Clicks (class On2Clicks)
3298 on3Clicks (class On3Clicks)
3300 on4Clicks (class On4Clicks)
3302 on5Clicks (class On5Clicks)
3304 Specify selection behavior in response to multiple mouse
3305 clicks. A single mouse click is always interpreted as
3306 described in the Selection Functions section (see POINTER
3307 USAGE). Multiple mouse clicks (using the button which
3308 activates the select-start action) are interpreted according to
3309 the resource values of on2Clicks, etc. The resource value can
3310 be one of these:
3311 word
3313 Select a “word” as determined by the charClass resource.
3314 See the CHARACTER CLASSES section.
3315 line
3317 Select a line (counting wrapping).
3318 group
3320 Select a group of adjacent lines (counting wrapping). The
3321 selection stops on a blank line, and does not extend outside
3322 the current page.
3323 page
3325 Select all visible lines, i.e., the page.
3326 all
3328 Select all lines, i.e., including the saved lines.
3329 regex
3331 Select the best match for the POSIX extended regular
3332 expression (ERE) which follows in the resource value:
3333 · Xterm matches the regular expression against a byte
3335 array for the entire (possibly wrapped) line. That byte
3336 array may be UTF-8 or ISO-8859-1, depending on the mode
3337 in which xterm is running.
3338 · Xterm steps through each byte-offset in this array,
3340 keeping track of the best (longest) match. If more than
3341 one match ties for the longest length, the first is
3342 used.
3343 Xterm does this to make it convenient to click anywhere
3345 in the area of interest and cause the regular expression
3346 to match the entire word, etc.
3347 · The “^” and “$” anchors in a regular expression denote
3349 the ends of the entire line.
3350 · If the regular expression contains backslashes “\” those
3352 should be escaped “\\” because the X libraries interpret
3353 backslashes in resource strings.
3354 none
3356 No selection action is associated with this resource. Xterm
3357 interprets it as the end of the list. For example, you may
3358 use it to disable triple (and higher) clicking by setting
3359 on3Clicks to “none”.
3360 The default values for on2Clicks and on3Clicks are “word” and
3362 “line”, respectively. There is no default value for on4Clicks
3363 or on5Clicks, making those inactive. On startup, xterm
3364 determines the maximum number of clicks by the onXClicks
3365 resource values which are set.
3366 openIm (class OpenIm)
3368 Tells xterm whether to open the input method at startup. The
3369 default is “true”.
3370 pointerColor (class PointerColor)
3372 Specifies the foreground color of the pointer. The default is
3373 “XtDefaultForeground”.
3374 pointerColorBackground (class PointerColorBackground)
3376 Specifies the background color of the pointer. The default is
3377 “XtDefaultBackground”.
3378 pointerMode (class PointerMode)
3380 Specifies when the pointer may be hidden as the user types. It
3381 will be redisplayed if the user moves the mouse, or clicks one
3382 of its buttons.
3383 0 never
3385 1 the application running in xterm has not activated mouse
3387 mode. This is the default.
3388 2 always.
3390 pointerShape (class Cursor)
3392 Specifies the name of the shape of the pointer. The default is
3393 “xterm”.
3394 popOnBell (class PopOnBell)
3396 Specifies whether the window would be raised when Control-G is
3397 received. The default is “false”.
3398 If the window is iconified, this has no effect. However, the
3400 zIconBeep resource provides you with the ability to see which
3401 iconified windows have sounded a bell.
3402 precompose (class Precompose)
3404 Tells xterm whether to precompose UTF-8 data into Normalization
3405 Form C, which combines commonly-used accents onto base
3406 characters. If it does not do this, accents are left as
3407 separatate characters. The default is “true”.
3408 preeditType (class PreeditType)
3410 Tells xterm which types of preedit (preconversion) string to
3411 display. The default is “OverTheSpot,Root”.
3412 printAttributes (class PrintAttributes)
3414 Specifies whether to print graphic attributes along with the
3415 text. A real DEC VTxxx terminal will print the underline,
3416 highlighting codes but your printer may not handle these.
3417 · “0” disables the attributes.
3419 · “1” prints the normal set of attributes (bold, underline,
3421 inverse and blink) as VT100-style control sequences.
3422 · “2” prints ANSI color attributes as well.
3424 The default is “1”.
3426 printFileImmediate (class PrintFileImmediate)
3428 When the print-immediate action is invoked, xterm prints the
3429 screen contents directly to a file. Set this resource to the
3430 prefix of the filename (a timestamp will be appended to the
3431 actual name).
3432 The default is an empty string, i.e., “”, However, when the
3434 print-immediate action is invoked, if the string is empty, then
3435 “XTerm” is used.
3436 printFileOnXError (class PrintFileOnXError)
3438 If xterm exits with an X error, e.g., your connection is broken
3439 when the server crashes, it can be told to write the contents
3440 of the screen to a file. To enable the feature, set this
3441 resource to the prefix of the filename (a timestamp will be
3442 appended to the actual name).
3443 The default is an empty string, i.e., “”, which disables this
3445 feature. However, when the print-on-error action is invoked,
3446 if the string is empty, then “XTermError” is used.
3447 These error codes are handled: ERROR_XERROR, ERROR_XIOERROR and
3449 ERROR_ICEERROR.
3450 printModeImmediate (class PrintModeImmediate)
3452 When the print-immediate action is invoked, xterm prints the
3453 screen contents directly to a file. You can use the
3454 printModeImmediate resource to tell it to use escape sequences
3455 to reconstruct the video attributes and colors. This uses the
3456 same values as the printAttributes resource. The default is
3457 “0”.
3458 printModeOnXError (class PrintModeOnXError)
3460 Xterm implements the printFileOnXError feature using the
3461 printer feature, although the output is written directly to a
3462 file. You can use the printModeOnXError resource to tell it to
3463 use escape sequences to reconstruct the video attributes and
3464 colors. This uses the same values as the printAttributes
3465 resource. The default is “0”.
3466 printOptsImmediate (class PrintOptsImmediate)
3468 Specify the range of text which is printed to a file when the
3469 print-immediate action is invoked.
3470 · If zero (0), then this selects the current (visible screen)
3472 plus the saved lines, except if the alternate screen is
3473 being used. In that case, only the alternate screen is
3474 selected.
3475 · If nonzero, the bits of this resource value (checked in
3477 descending order) select the range:
3478 8 selects the saved lines.
3480 4 selects the alternate screen.
3482 2 selects the normal screen.
3484 1 selects the current screen, which can be either the
3486 normal or alternate screen.
3487 The default is “9”, which selects the current visible screen
3489 plus saved lines, with no special case for the alternated
3490 screen.
3491 printOptsOnXError (class PrintOptsOnXError)
3493 Specify the range of text which is printed to a file when the
3494 print-on-error action is invoked. The resource value is
3495 interpreted the same as in printOptsImmediate.
3496 The default is “9”, which selects the current visible screen
3498 plus saved lines, with no special case for the alternated
3499 screen.
3500 printerAutoClose (class PrinterAutoClose)
3502 If “true”, xterm will close the printer (a pipe) when the
3503 application switches the printer offline with a Media Copy
3504 command. The default is “false”.
3505 printerCommand (class PrinterCommand)
3507 Specifies a shell command to which xterm will open a pipe when
3508 the first MC (Media Copy) command is initiated. The default is
3509 an empty string, i.e., “”. If the resource value is given as
3510 an empty string, the printer is disabled.
3511 printerControlMode (class PrinterControlMode)
3513 Specifies the printer control mode. A “1” selects autoprint
3514 mode, which causes xterm to print a line from the screen when
3515 you move the cursor off that line with a line feed, form feed
3516 or vertical tab character, or an autowrap occurs. Autoprint
3517 mode is overridden by printer controller mode (a “2”), which
3518 causes all of the output to be directed to the printer. The
3519 default is “0”.
3520 printerExtent (class PrinterExtent)
3522 Controls whether a print page function will print the entire
3523 page (true), or only the portion within the scrolling margins
3524 (false). The default is “false”.
3525 printerFormFeed (class PrinterFormFeed)
3527 Controls whether a form feed is sent to the printer at the end
3528 of a print page function. The default is “false”.
3529 printerNewLine (class PrinterNewLine)
3531 Controls whether a newline is sent to the printer at the end of
3532 a print page function. The default is “true”.
3533 privateColorRegisters (class PrivateColorRegisters)
3535 If xterm is configured to support ReGIS or SIXEL graphics, this
3536 controls whether xterm allocates separate color registers for
3537 each sixel device control string, e.g., for DECGCI. If not
3538 true, color registers are allocated only once, when the
3539 terminal is reset, and color changes in any graphic affect
3540 all graphics. The default is “true”.
3541 quietGrab (class QuietGrab)
3543 Controls whether the cursor is repainted when NotifyGrab and
3544 NotifyUngrab event types are received during change of focus.
3545 The default is “false”.
3546 regisDefaultFont (class RegisDefaultFont)
3548 If xterm is configured to support ReGIS graphics, this resource
3549 tells xterm which font to use if the ReGIS data does not
3550 specify one. No default value is specified; xterm accepts a
3551 TrueType font specification as in the faceName resource.
3552 If no value is specified, xterm draws a bitmap indicating a
3554 missing character.
3555 regisScreenSize (class RegisScreenSize)
3557 If xterm is configured to support ReGIS graphics, this resource
3558 tells xterm the default size (in pixels) for these graphics,
3559 which also sets the default coordinate space to [0,0] (upper-
3560 left) and [width,height] (lower-right).
3561 The application using ReGIS may use the “A” option of the “S”
3563 command to adjust the coordinate space or change the
3564 addressable portion of the screen.
3565 The default is “1000x1000” (given as width by height).
3567 Xterm accepts a special resource value “auto”, which tells
3569 xterm to use the decTerminalID resource to set the default size
3570 based on the hardware terminal's limits. Those limits are the
3571 same as for the maxGraphicSize resource.
3572 renderFont (class RenderFont)
3574 If xterm is built with the Xft library, this controls whether
3575 the faceName resource is used. The default is “default”.
3576 The resource values are strings, evaluated as booleans after
3578 startup.
3579 false
3581 disable the feature and use the normal (bitmap) font.
3582 true
3584 startup using the TrueType font specified by the faceName
3585 and faceSize resource settings. If there is no value for
3586 faceName, disable the feature and use the normal (bitmap)
3587 font.
3588 After startup, you can still switch to/from the bitmap
3590 font using the “TrueType Fonts” menu entry.
3591 default
3593 startup using the normal (bitmap) font, but enable the
3594 “TrueType Fonts” menu entry to allow runtime switching
3595 to/from TrueType fonts.
3596 If there is no faceName resource set, then runtime
3598 switching to TrueType fonts is disabled. Xterm has a
3599 separate compiled-in value for faceName for the special
3600 case where renderFont is “default”. That is normally
3601 “mono”.
3602 resizeGravity (class ResizeGravity)
3604 Affects the behavior when the window is resized to be taller or
3605 shorter. NorthWest specifies that the top line of text on the
3606 screen stay fixed. If the window is made shorter, lines are
3607 dropped from the bottom; if the window is made taller, blank
3608 lines are added at the bottom. This is compatible with the
3609 behavior in R4. SouthWest (the default) specifies that the
3610 bottom line of text on the screen stay fixed. If the window is
3611 made taller, additional saved lines will be scrolled down onto
3612 the screen; if the window is made shorter, lines will be
3613 scrolled off the top of the screen, and the top saved lines
3614 will be dropped.
3615 retryInputMethod (class RetryInputMethod)
3617 Tells xterm how many times to retry, in case the input-method
3618 server is not responding. This is a different issue than
3619 unsupported preedit type, etc. You may encounter retries if
3620 your X configuration (and its libraries) are missing pieces.
3621 Setting this resource to zero “0” will cancel the retrying.
3622 The default is “3”.
3623 reverseVideo (class ReverseVideo)
3625 Specifies whether or not reverse video should be simulated.
3626 The default is “false”.
3627 There are several aspects to reverse video in xterm:
3629 · The command-line -rv option tells the X libraries to
3631 reverse the foreground and background colors. Xterm's
3632 command-line options set resource values. In particular,
3633 the X Toolkit sets the reverseVideo resource when the -rv
3634 option is used.
3635 · If the user has also used command-line options -fg or -bg
3637 to set the foreground and background colors, xterm does not
3638 see these options directly. Instead, it examines the
3639 resource values to reconstruct the command-line options,
3640 and determine which of the colors is the user's intended
3641 foreground, etc. Their actual values are irrelevant to the
3642 reverse video function; some users prefer the X defaults
3643 (black text on a white background), others prefer white
3644 text on a black background.
3645 · After startup, the user can toggle the “Enable Reverse
3647 Video” menu entry. This exchanges the current foreground
3648 and background colors of the VT100 widget, and repaints the
3649 screen. Because of the X resource hierarchy, the
3650 reverseVideo resource applies to more than the VT100
3651 widget.
3652 Programs running in an xterm can also use control sequences to
3654 enable the VT100 reverse video mode. These are independent of
3655 the reverseVideo resource and the menu entry. Xterm exchanges
3656 the current foreground and background colors when drawing text
3657 affected by these control sequences.
3658 Other control sequences can alter the foreground and background
3660 colors which are used:
3661 · Programs can also use the ANSI color control sequences to
3663 set the foreground and background colors.
3664 · Extensions to the ANSI color controls (such as 16-, 88- or
3666 256-colors) are treated similarly to the ANSI control.
3667 · Using other control sequences (the “dynamic colors”
3669 feature), a program can change the foreground and
3670 background colors.
3671 reverseWrap (class ReverseWrap)
3673 Specifies whether or not reverse-wraparound should be enabled.
3674 This corresponds to xterm's private mode 45. The default is
3675 “false”.
3676 rightScrollBar (class RightScrollBar)
3678 Specifies whether or not the scrollbar should be displayed on
3679 the right rather than the left. The default is “false”.
3680 saveLines (class SaveLines)
3682 Specifies the number of lines to save beyond the top of the
3683 screen when a scrollbar is turned on. The default is “64”.
3684 scrollBar (class ScrollBar)
3686 Specifies whether or not the scrollbar should be displayed.
3687 The default is “false”.
3688 scrollBarBorder (class ScrollBarBorder)
3690 Specifies the width of the scrollbar border. Note that this is
3691 drawn to overlap the border of the xterm window. Modifying the
3692 scrollbar's border affects only the line between the VT100
3693 widget and the scrollbar. The default value is 1.
3694 scrollKey (class ScrollCond)
3696 Specifies whether or not pressing a key should automatically
3697 cause the scrollbar to go to the bottom of the scrolling
3698 region. This corresponds to xterm's private mode 1011. The
3699 default is “false”.
3700 scrollLines (class ScrollLines)
3702 Specifies the number of lines that the scroll-back and scroll-
3703 forw actions should use as a default. The default value is 1.
3704 scrollTtyOutput (class ScrollCond)
3706 Specifies whether or not output to the terminal should
3707 automatically cause the scrollbar to go to the bottom of the
3708 scrolling region. The default is “true”.
3709 selectToClipboard (class SelectToClipboard)
3711 Tells xterm whether to use the PRIMARY or CLIPBOARD for SELECT
3712 tokens in the selection mechanism. The set-select action can
3713 change this at runtime, allowing the user to work with programs
3714 that handle only one of these mechanisms. The default is
3715 “false”, which tells it to use PRIMARY.
3716 shiftFonts (class ShiftFonts)
3718 Specifies whether to enable the actions larger-vt-font() and
3719 smaller-vt-font(), which are normally bound to the shifted
3720 KP_Add and KP_Subtract. The default is “true”.
3721 showBlinkAsBold (class ShowBlinkAsBold)
3723 Tells xterm whether to display text with blink-attribute the
3724 same as bold. If xterm has not been configured to support
3725 blinking text, the default is “true”, which corresponds to
3726 older versions of xterm, otherwise the default is “false”.
3727 showMissingGlyphs (class ShowMissingGlyphs)
3729 Tells xterm whether to display a box outlining places where a
3730 character has been used that the font does not represent. The
3731 default is “false”.
3732 showWrapMarks (class ShowWrapMarks)
3734 For debugging xterm and applications that may manipulate the
3735 wrapped-line flag by writing text at the right margin, show a
3736 mark on the right inner-border of the window. The mark shows
3737 which lines have the flag set.
3738 signalInhibit (class SignalInhibit)
3740 Specifies whether or not the entries in the Main Options menu
3741 for sending signals to xterm should be disallowed. The default
3742 is “false”.
3743 sixelScrolling (class SixelScrolling)
3745 If xterm is configured to support SIXEL graphics, this resource
3746 tells it whether to scroll up one line at a time when sixels
3747 would be written past the bottom line on the window. The
3748 default is “false”.
3749 sixelScrollsRight (class SixelScrollsRight)
3751 If xterm is configured to support SIXEL graphics, this resource
3752 tells it whether to scroll to the right as needed to keep the
3753 current position visible rather than truncate the plot on the
3754 on the right. The default is “false”.
3755 tekGeometry (class Geometry)
3757 Specifies the preferred size and position of the Tektronix
3758 window. There is no default for this resource.
3759 tekInhibit (class TekInhibit)
3761 Specifies whether or not the escape sequence to enter Tektronix
3762 mode should be ignored. The default is “false”.
3763 tekSmall (class TekSmall)
3765 Specifies whether or not the Tektronix mode window should start
3766 in its smallest size if no explicit geometry is given. This is
3767 useful when running xterm on displays with small screens. The
3768 default is “false”.
3769 tekStartup (class TekStartup)
3771 Specifies whether or not xterm should start up in Tektronix
3772 mode. The default is “false”.
3773 tiXtraScroll (class TiXtraScroll)
3775 Specifies whether xterm should scroll to a new page when
3776 processing the ti termcap entry, i.e., the private modes 47,
3777 1047 or 1049. This is only in effect if titeInhibit is “true”,
3778 because the intent of this option is to provide a picture of
3779 the full-screen application's display on the scrollback without
3780 wiping out the text that would be shown before the application
3781 was initialized. The default for this resource is “false”.
3782 titeInhibit (class TiteInhibit)
3784 Originally specified whether or not xterm should remove ti and
3785 te termcap entries (used to switch between alternate screens on
3786 startup of many screen-oriented programs) from the TERMCAP
3787 string.
3788 TERMCAP is used rarely now, but xterm supports the feature on
3790 modern systems:
3791 · If set, xterm also ignores the escape sequence to switch to
3793 the alternate screen.
3794 · Xterm supports terminfo in a different way, supporting
3796 composite control sequences (also known as private modes)
3797 1047, 1048 and 1049 which have the same effect as the
3798 original 47 control sequence.
3799 The default for this resource is “false”.
3801 titleModes (class TitleModes)
3803 Tells xterm whether to accept or return window- and icon-labels
3804 in ISO-8859-1 (the default) or UTF-8. Either can be encoded in
3805 hexadecimal. The default for this resource is “0”.
3806 Each bit (bit “0” is 1, bit “1” is 2, etc.) corresponds to one
3808 of the parameters set by the title modes control sequence:
3809 0 Set window/icon labels using hexadecimal
3811 1 Query window/icon labels using hexadecimal
3813 2 Set window/icon labels using UTF-8 (overrides utf8Title
3815 resource).
3816 3 Query window/icon labels using UTF-8
3818 translations (class Translations)
3820 Specifies the key and button bindings for menus, selections,
3821 “programmed strings”, etc. The translations resource, which
3822 provides much of xterm's configurability, is a feature of the X
3823 Toolkit Intrinsics library (Xt). See the Actions section.
3824 trimSelection (class TrimSelection)
3826 If you set highlightSelection, you can see the text which is
3827 selected, including any trailing spaces. Clearing the screen
3828 (or a line) resets it to a state containing no spaces. Some
3829 lines may contain trailing spaces when an application writes
3830 them to the screen. However, you may not wish to paste lines
3831 with trailing spaces. If this resource is true, xterm will
3832 trim trailing spaces from text which is selected. It does not
3833 affect spaces which result in a wrapped line, nor will it trim
3834 the trailing newline from your selection. The default is
3835 “false”.
3836 underLine (class UnderLine)
3838 This specifies whether or not text with the underline attribute
3839 should be underlined. It may be desirable to disable
3840 underlining when color is being used for the underline
3841 attribute. The default is “true”.
3842 useClipping (class UseClipping)
3844 Tell xterm whether to use clipping to keep from producing dots
3845 outside the text drawing area. Originally used to work around
3846 for overstriking effects, this is also needed to work with some
3847 incorrectly-sized fonts. The default is “true”.
3848 utf8 (class Utf8)
3850 This specifies whether xterm will run in UTF-8 mode. If you
3851 set this resource, xterm also sets the wideChars resource as a
3852 side-effect. The resource can be set via the menu entry “UTF-8
3853 Encoding”. The default is “default”.
3854 Xterm accepts either a keyword (ignoring case) or the number
3856 shown in parentheses:
3857 false (0)
3859 UTF-8 mode is initially off. The command-line option +u8
3860 sets the resource to this value. Escape sequences for
3861 turning UTF-8 mode on/off are allowed.
3862 true (1)
3864 UTF-8 mode is initially on. Escape sequences for turning
3865 UTF-8 mode on/off are allowed.
3866 always (2)
3868 The command-line option -u8 sets the resource to this value.
3869 Escape sequences for turning UTF-8 mode on/off are ignored.
3870 default (3)
3872 This is the default value of the resource. It is changed
3873 during initialization depending on whether the locale
3874 resource was set, to false (0) or always (2). See the
3875 locale resource for additional discussion of non-UTF-8
3876 locales.
3877 If you want to set the value of utf8, it should be in this
3879 range. Other nonzero values are treated the same as “1”, i.e.,
3880 UTF-8 mode is initially on, and escape sequences for turning
3881 UTF-8 mode on/off are allowed.
3882 utf8Fonts (class Utf8Fonts)
3884 See the discussion of the locale resource. This specifies
3885 whether xterm will use UTF-8 fonts specified via resource
3886 patterns such as “*vt100.utf8Fonts.font” or normal (ISO-8859-1)
3887 fonts via patterns such as “*vt100.font”. The resource can be
3888 set via the menu entry “UTF-8 Fonts”. The default is
3889 “default”.
3890 Xterm accepts either a keyword (ignoring case) or the number
3892 shown in parentheses:
3893 false (0)
3895 Use the ISO-8859-1 fonts. The menu entry is enabled,
3896 allowing the choice of fonts to be changed at runtime.
3897 true (1)
3899 Use the UTF-8 fonts. The menu entry is enabled,
3900 allowing the choice of fonts to be changed at runtime.
3901 always (2)
3903 Always use the UTF-8 fonts. This also disables the menu
3904 entry.
3905 default (3)
3907 At startup, the resource is set to true or false,
3908 according to the effective value of the utf8 resource.
3909 utf8Latin1 (class Utf8Latin1)
3911 If true, allow an ISO-8859-1 normal font to be combined with an
3912 ISO-10646-1 font if the latter is given via the -fw option or
3913 its corresponding resource value. The default is “false”.
3914 utf8SelectTypes (class Utf8SelectTypes)
3916 Override xterm's default selection target list (see
3917 SELECT/PASTE) for selections in wide-character (UTF-8) mode.
3918 The default is an empty string, i.e., “”, which does not
3919 override anything.
3920 utf8Title (class Utf8Title)
3922 Applications can set xterm's title by writing a control
3923 sequence. Normally this control sequence follows the VT220
3924 convention, which encodes the string in ISO-8859-1 and allows
3925 for an 8-bit string terminator. If xterm is started in a UTF-8
3926 locale, it translates the ISO-8859-1 string to UTF-8 to work
3927 with the X libraries which assume the string is UTF-8.
3928 However, some users may wish to write a title string encoded in
3930 UTF-8. The window manager is responsible for drawing window
3931 titles. Some window managers (not all) support UTF-8 encoding
3932 of window titles. Set this resource to “true” to allow UTF-8
3933 encoded title strings. That cancels the translation to UTF-8,
3934 allowing UTF-8 strings to be displayed as is.
3935 This feature is available as a menu entry, since it is related
3937 to the particular applications you are running within xterm.
3938 You can also use a control sequence (see the discussion of
3939 “Title Modes” in Xterm Control Sequences), to set an equivalent
3940 flag. The titleModes resource sets the same value, which
3941 overrides this resource.
3942 The default is “false”.
3944 veryBoldColors (class VeryBoldColors)
3946 Specifies whether to combine video attributes with colors
3947 specified by colorBD, colorBL, colorIT, colorRV, and colorUL.
3948 The resource value is the sum of values for each attribute:
3949 1 for reverse,
3950 2 for underline,
3951 4 for bold,
3952 8 for blink, and
3953 512 for italic
3954 The default is “0”.
3956 visualBell (class VisualBell)
3958 Specifies whether or not a visible bell (i.e., flashing) should
3959 be used instead of an audible bell when Control-G is received.
3960 The default is “false”, which tells xterm to use an audible
3961 bell.
3962 visualBellDelay (class VisualBellDelay)
3964 Number of milliseconds to delay when displaying a visual bell.
3965 Default is 100. If set to zero, no visual bell is displayed.
3966 This is useful for very slow displays, e.g., an LCD display on
3967 a laptop.
3968 visualBellLine (class VisualBellLine)
3970 Specifies whether to flash only the current line when
3971 displaying a visual bell rather than flashing the entire
3972 screen: The default is “false”, which tells xterm to flash the
3973 entire screen.
3974 vt100Graphics (class VT100Graphics)
3976 This specifies whether xterm will interpret VT100 graphic
3977 character escape sequences while in UTF-8 mode. The default is
3978 “true”, to provide support for various legacy applications.
3979 wideBoldFont (class WideBoldFont)
3981 This option specifies the font to be used for displaying bold
3982 wide text. By default, it will attempt to use a font twice as
3983 wide as the font that will be used to draw bold text. If no
3984 double-width font is found, it will improvise, by stretching
3985 the bold font.
3986 wideChars (class WideChars)
3988 Specifies if xterm should respond to control sequences that
3989 process 16-bit characters. The default is “false”.
3990 wideFont (class WideFont)
3992 This option specifies the font to be used for displaying wide
3993 text. By default, it will attempt to use a font twice as wide
3994 as the font that will be used to draw normal text. If no
3995 double-width font is found, it will improvise, by stretching
3996 the normal font.
3997 ximFont (class XimFont)
3999 This option specifies the font to be used for displaying the
4000 preedit string in the “OverTheSpot” input method.
4001 In “OverTheSpot” preedit type, the preedit (preconversion)
4003 string is displayed at the position of the cursor. It is the
4004 XIM server's responsibility to display the preedit string. The
4005 XIM client must inform the XIM server of the cursor position.
4006 For best results, the preedit string must be displayed with a
4007 proper font. Therefore, xterm informs the XIM server of the
4008 proper font. The font is be supplied by a "fontset", whose
4009 default value is “*”. This matches every font, the X library
4010 automatically chooses fonts with proper charsets. The ximFont
4011 resource is provided to override this default font setting.
4012 Tek4014 Widget Resources
4014 The following resources are specified as part of the tek4014 widget
4015 (class Tek4014). These are specified by patterns such as
4016 “XTerm.tek4014.NAME”:
4017 font2 (class Font)
4019 Specifies font number 2 to use in the Tektronix window.
4020 font3 (class Font)
4022 Specifies font number 3 to use in the Tektronix window.
4023 fontLarge (class Font)
4025 Specifies the large font to use in the Tektronix window.
4026 fontSmall (class Font)
4028 Specifies the small font to use in the Tektronix window.
4029 ginTerminator (class GinTerminator)
4031 Specifies what character(s) should follow a GIN report or
4032 status report. The possibilities are “none”, which sends no
4033 terminating characters, “CRonly”, which sends CR, and “CR&EOT”,
4034 which sends both CR and EOT. The default is “none”.
4035 height (class Height)
4037 Specifies the height of the Tektronix window in pixels.
4038 initialFont (class InitialFont)
4040 Specifies which of the four Tektronix fonts to use initially.
4041 Values are the same as for the set-tek-text action. The
4042 default is “large”.
4043 width (class Width)
4045 Specifies the width of the Tektronix window in pixels.
4046 Menu Resources
4048 The resources that may be specified for the various menus are described
4049 in the documentation for the Athena SimpleMenu widget. The name and
4050 classes of the entries in each of the menus are listed below.
4051 Resources named “lineN” where N is a number are separators with class
4052 SmeLine.
4053 As with all X resource-based widgets, the labels mentioned are
4055 customary defaults for the application.
4056 The Main Options menu (widget name mainMenu) has the following entries:
4058 toolbar (class SmeBSB)
4060 This entry invokes the set-toolbar(toggle) action.
4061 securekbd (class SmeBSB)
4063 This entry invokes the secure() action.
4064 allowsends (class SmeBSB)
4066 This entry invokes the allow-send-events(toggle) action.
4067 redraw (class SmeBSB)
4069 This entry invokes the redraw() action.
4070 logging (class SmeBSB)
4072 This entry invokes the logging(toggle) action.
4073 print-immediate (class SmeBSB)
4075 This entry invokes the print-immediate() action.
4076 print-on-error (class SmeBSB)
4078 This entry invokes the print-on-error() action.
4079 print (class SmeBSB)
4081 This entry invokes the print() action.
4082 print-redir (class SmeBSB)
4084 This entry invokes the print-redir() action.
4085 dump-html (class SmeBSB)
4087 This entry invokes the dump-html() action.
4088 dump-svg (class SmeBSB)
4090 This entry invokes the dump-svg() action.
4091 8-bit-control (class SmeBSB)
4093 This entry invokes the set-8-bit-control(toggle) action.
4094 backarrow key (class SmeBSB)
4096 This entry invokes the set-backarrow(toggle) action.
4097 num-lock (class SmeBSB)
4099 This entry invokes the set-num-lock(toggle) action.
4100 alt-esc (class SmeBSB)
4102 This entry invokes the alt-sends-escape(toggle) action.
4103 meta-esc (class SmeBSB)
4105 This entry invokes the meta-sends-escape(toggle) action.
4106 delete-is-del (class SmeBSB)
4108 This entry invokes the delete-is-del(toggle) action.
4109 oldFunctionKeys (class SmeBSB)
4111 This entry invokes the set-old-function-keys(toggle) action.
4112 hpFunctionKeys (class SmeBSB)
4114 This entry invokes the set-hp-function-keys(toggle) action.
4115 scoFunctionKeys (class SmeBSB)
4117 This entry invokes the set-sco-function-keys(toggle) action.
4118 sunFunctionKeys (class SmeBSB)
4120 This entry invokes the set-sun-function-keys(toggle) action.
4121 sunKeyboard (class SmeBSB)
4123 This entry invokes the sunKeyboard(toggle) action.
4124 suspend (class SmeBSB)
4126 This entry invokes the send-signal(tstp) action on systems that
4127 support job control.
4128 continue (class SmeBSB)
4130 This entry invokes the send-signal(cont) action on systems that
4131 support job control.
4132 interrupt (class SmeBSB)
4134 This entry invokes the send-signal(int) action.
4135 hangup (class SmeBSB)
4137 This entry invokes the send-signal(hup) action.
4138 terminate (class SmeBSB)
4140 This entry invokes the send-signal(term) action.
4141 kill (class SmeBSB)
4143 This entry invokes the send-signal(kill) action.
4144 quit (class SmeBSB)
4146 This entry invokes the quit() action.
4147 The VT Options menu (widget name vtMenu) has the following entries:
4149 scrollbar (class SmeBSB)
4151 This entry invokes the set-scrollbar(toggle) action.
4152 jumpscroll (class SmeBSB)
4154 This entry invokes the set-jumpscroll(toggle) action.
4155 reversevideo (class SmeBSB)
4157 This entry invokes the set-reverse-video(toggle) action.
4158 autowrap (class SmeBSB)
4160 This entry invokes the set-autowrap(toggle) action.
4161 reversewrap (class SmeBSB)
4163 This entry invokes the set-reversewrap(toggle) action.
4164 autolinefeed (class SmeBSB)
4166 This entry invokes the set-autolinefeed(toggle) action.
4167 appcursor (class SmeBSB)
4169 This entry invokes the set-appcursor(toggle) action.
4170 appkeypad (class SmeBSB)
4172 This entry invokes the set-appkeypad(toggle) action.
4173 scrollkey (class SmeBSB)
4175 This entry invokes the set-scroll-on-key(toggle) action.
4176 scrollttyoutput (class SmeBSB)
4178 This entry invokes the set-scroll-on-tty-output(toggle) action.
4179 allow132 (class SmeBSB)
4181 This entry invokes the set-allow132(toggle) action.
4182 cursesemul (class SmeBSB)
4184 This entry invokes the set-cursesemul(toggle) action.
4185 keepSelection (class SmeBSB)
4187 This entry invokes the set-keep-selection(toggle) action.
4188 selectToClipboard (class SmeBSB)
4190 This entry invokes the set-keep-clipboard(toggle) action.
4191 visualbell (class SmeBSB)
4193 This entry invokes the set-visual-bell(toggle) action.
4194 bellIsUrgent (class SmeBSB)
4196 This entry invokes the set-bellIsUrgent(toggle) action.
4197 poponbell (class SmeBSB)
4199 This entry invokes the set-pop-on-bell(toggle) action.
4200 cursorblink (class SmeBSB)
4202 This entry invokes the set-cursorblink(toggle) action.
4203 titeInhibit (class SmeBSB)
4205 This entry invokes the set-titeInhibit(toggle) action.
4206 activeicon (class SmeBSB)
4208 This entry toggles active icons on and off if this feature was
4209 compiled into xterm. It is enabled only if xterm was started
4210 with the command line option +ai or the activeIcon resource is
4211 set to “true”.
4212 softreset (class SmeBSB)
4214 This entry invokes the soft-reset() action.
4215 hardreset (class SmeBSB)
4217 This entry invokes the hard-reset() action.
4218 clearsavedlines (class SmeBSB)
4220 This entry invokes the clear-saved-lines() action.
4221 tekshow (class SmeBSB)
4223 This entry invokes the set-visibility(tek,toggle) action.
4224 tekmode (class SmeBSB)
4226 This entry invokes the set-terminal-type(tek) action.
4227 vthide (class SmeBSB)
4229 This entry invokes the set-visibility(vt,off) action.
4230 altscreen (class SmeBSB)
4232 This entry invokes the set-altscreen(toggle) action.
4233 sixelScrolling (class SmeBSB)
4235 This entry invokes the set-sixel-scrolling(toggle) action.
4236 privateColorRegisters (class SmeBSB)
4238 This entry invokes the set-private-colors(toggle) action.
4239 The VT Fonts menu (widget name fontMenu) has the following entries:
4241 fontdefault (class SmeBSB)
4243 This entry invokes the set-vt-font(d) action, setting the font
4244 using the font (default) resource, e.g., “Default” in the menu.
4245 font1 (class SmeBSB)
4247 This entry invokes the set-vt-font(1) action, setting the font
4248 using the font1 resource, e.g., “Unreadable” in the menu.
4249 font2 (class SmeBSB)
4251 This entry invokes the set-vt-font(2) action, setting the font
4252 using the font2 resource, e.g., “Tiny” in the menu.
4253 font3 (class SmeBSB)
4255 This entry invokes the set-vt-font(3) action, setting the font
4256 using the font3 resource, e.g., “Small” in the menu.
4257 font4 (class SmeBSB)
4259 This entry invokes the set-vt-font(4) action, letting the font
4260 using the font4 resource, e.g., “Medium” in the menu.
4261 font5 (class SmeBSB)
4263 This entry invokes the set-vt-font(5) action, letting the font
4264 using the font5 resource, e.g., “Large” in the menu.
4265 font6 (class SmeBSB)
4267 This entry invokes the set-vt-font(6) action, letting the font
4268 using the font6 resource, e.g., “Huge” in the menu.
4269 fontescape (class SmeBSB)
4271 This entry invokes the set-vt-font(e) action.
4272 fontsel (class SmeBSB)
4274 This entry invokes the set-vt-font(s) action.
4275 allow-bold-fonts (class SmeBSB)
4277 This entry invokes the allow-bold-fonts(toggle) action.
4278 font-linedrawing (class SmeBSB)
4280 This entry invokes the set-font-linedrawing(s) action.
4281 font-packed (class SmeBSB)
4283 This entry invokes the set-font-packed(s) action.
4284 font-doublesize (class SmeBSB)
4286 This entry invokes the set-font-doublesize(s) action.
4287 render-font (class SmeBSB)
4289 This entry invokes the set-render-font(s) action.
4290 utf8-fonts (class SmeBSB)
4292 This entry invokes the set-utf8-fonts(s) action.
4293 utf8-mode (class SmeBSB)
4295 This entry invokes the set-utf8-mode(s) action.
4296 utf8-title (class SmeBSB)
4298 This entry invokes the set-utf8-title(s) action.
4299 allow-color-ops (class SmeBSB)
4301 This entry invokes the allow-color-ops(toggle) action.
4302 allow-font-ops (class SmeBSB)
4304 This entry invokes the allow-fonts-ops(toggle) action.
4305 allow-tcap-ops (class SmeBSB)
4307 This entry invokes the allow-tcap-ops(toggle) action.
4308 allow-title-ops (class SmeBSB)
4310 This entry invokes the allow-title-ops(toggle) action.
4311 allow-window-ops (class SmeBSB)
4313 This entry invokes the allow-window-ops(toggle) action.
4314 The Tek Options menu (widget name tekMenu) has the following entries:
4316 tektextlarge (class SmeBSB)
4318 This entry invokes the set-tek-text(large) action.
4319 tektext2 (class SmeBSB)
4321 This entry invokes the set-tek-text(2) action.
4322 tektext3 (class SmeBSB)
4324 This entry invokes the set-tek-text(3) action.
4325 tektextsmall (class SmeBSB)
4327 This entry invokes the set-tek-text(small) action.
4328 tekpage (class SmeBSB)
4330 This entry invokes the tek-page() action.
4331 tekreset (class SmeBSB)
4333 This entry invokes the tek-reset() action.
4334 tekcopy (class SmeBSB)
4336 This entry invokes the tek-copy() action.
4337 vtshow (class SmeBSB)
4339 This entry invokes the set-visibility(vt,toggle) action.
4340 vtmode (class SmeBSB)
4342 This entry invokes the set-terminal-type(vt) action.
4343 tekhide (class SmeBSB)
4345 This entry invokes the set-visibility(tek,toggle) action.
4346 Scrollbar Resources
4348 The following resources are useful when specified for the Athena
4349 Scrollbar widget:
4350 thickness (class Thickness)
4352 Specifies the width in pixels of the scrollbar.
4353 background (class Background)
4355 Specifies the color to use for the background of the scrollbar.
4356 foreground (class Foreground)
4358 Specifies the color to use for the foreground of the scrollbar.
4359 The “thumb” of the scrollbar is a simple checkerboard pattern
4360 alternating pixels for foreground and background color.
4361
4363 Once the VTxxx window is created, xterm allows you to select text and
4364 copy it within the same or other windows using the pointer or the
4365 keyboard.
4366 A “pointer” could be a mouse, touchpad or similar device. X
4368 applications generally do not care, since they see only button events
4369 which have
4370 · position and
4372 · button up/down state
4374 Xterm can see these events as long as it has focus.
4376 The keyboard also supplies events, but it is less flexible than the
4378 pointer for selecting/copying text.
4379 Events are applied to actions using the translations resource. See
4381 Actions for a complete list, and Default Key Bindings for the built-in
4382 set of translations resources.
4383 Selection Functions
4385 The selection functions are invoked when the pointer buttons are used
4386 with no modifiers, and when they are used with the “shift” key. The
4387 assignment of the functions described below to keys and buttons may be
4388 changed through the resource database; see Actions below.
4389 Pointer button one (usually left)
4391 is used to save text into the cut buffer:
4392 ~Meta <Btn1Down>:select-start()
4394 Move the cursor to beginning of the text, and then hold the button
4396 down while moving the cursor to the end of the region and
4397 releasing the button. The selected text is highlighted and is
4398 saved in the global cut buffer and made the selection when the
4399 button is released:
4400 <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n
4402 Normally (but see the discussion of on2Clicks, etc):
4404 · Double-clicking selects by words.
4406 · Triple-clicking selects by lines.
4408 · Quadruple-clicking goes back to characters, etc.
4410 Multiple-click is determined by the time from button up to button
4412 down, so you can change the selection unit in the middle of a
4413 selection. Logical words and lines selected by double- or triple-
4414 clicking may wrap across more than one screen line if lines were
4415 wrapped by xterm itself rather than by the application running in
4416 the window. If the key/button bindings specify that an X
4417 selection is to be made, xterm will leave the selected text
4418 highlighted for as long as it is the selection owner.
4419 Pointer button two (usually middle)
4421 “types” (pastes) the text from the given selection, if any,
4422 otherwise from the cut buffer, inserting it as keyboard input:
4423 ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0)
4425 Pointer button three (usually right)
4427 extends the current selection.
4428 ~Ctrl ~Meta <Btn3Down>:start-extend()
4430 (Without loss of generality, you can swap “right” and “left”
4432 everywhere in the rest of this paragraph.) If pressed while
4433 closer to the right edge of the selection than the left, it
4434 extends/contracts the right edge of the selection. If you
4435 contract the selection past the left edge of the selection, xterm
4436 assumes you really meant the left edge, restores the original
4437 selection, then extends/contracts the left edge of the selection.
4438 Extension starts in the selection unit mode that the last
4439 selection or extension was performed in; you can multiple-click to
4440 cycle through them.
4441 By cutting and pasting pieces of text without trailing new lines, you
4443 can take text from several places in different windows and form a
4444 command to the shell, for example, or take output from a program and
4445 insert it into your favorite editor. Since cut buffers are globally
4446 shared among different applications, you may regard each as a “file”
4447 whose contents you know. The terminal emulator and other text programs
4448 should be treating it as if it were a text file, i.e., the text is
4449 delimited by new lines.
4450 Scrolling
4452 The scroll region displays the position and amount of text currently
4453 showing in the window (highlighted) relative to the amount of text
4454 actually saved. As more text is saved (up to the maximum), the size of
4455 the highlighted area decreases.
4456 Clicking button one with the pointer in the scroll region moves the
4458 adjacent line to the top of the display window.
4459 Clicking button three moves the top line of the display window down to
4461 the pointer position.
4462 Clicking button two moves the display to a position in the saved text
4464 that corresponds to the pointer's position in the scrollbar.
4465 Tektronix Pointer
4467 Unlike the VTxxx window, the Tektronix window does not allow the
4468 copying of text. It does allow Tektronix GIN mode, and in this mode
4469 the cursor will change from an arrow to a cross. Pressing any key will
4470 send that key and the current coordinate of the cross cursor. Pressing
4471 button one, two, or three will return the letters “l”, “m”, and “r”,
4472 respectively. If the “shift” key is pressed when a pointer button is
4473 pressed, the corresponding upper case letter is sent. To distinguish a
4474 pointer button from a key, the high bit of the character is set (but
4475 this is bit is normally stripped unless the terminal mode is RAW; see
4476 tty(4) for details).
4477
4479 X clients provide select and paste support by responding to requests
4480 conveyed by the server.
4481 PRIMARY
4483 When configured to use the primary selection, (the default) xterm can
4484 provide the selection data in ways which help to retain character
4485 encoding information as it is pasted.
4486 A user “selects” text on xterm, which highlights the selected text. A
4488 subsequent “paste” to another client forwards a request to the client
4489 owning the selection. If xterm owns the primary selection, it makes
4490 the data available in the form of one or more “selection targets”. If
4491 it does not own the primary selection, e.g., if it has released it or
4492 another client has asserted ownership, it relies on cut-buffers to pass
4493 the data. But cut-buffers handle only ISO-8859-1 data (officially -
4494 some clients ignore the rules).
4495 CLIPBOARD
4497 When configured to use the clipboard (using the selectToClipboard
4498 resource), the problem with persistence of ownership is bypassed.
4499 Otherwise, there is no difference regarding the data which can be
4500 passed via selection.
4501 The PRIMARY token is a standard X feature, documented in the ICCCM
4503 (Inter-Client Communication Conventions Manual), which states
4504 The selection named by the atom PRIMARY is used for all commands
4506 that take only a single argument and is the principal means of
4507 communication between clients that use the selection mechanism.
4508 SELECT
4510 However, many applications use CLIPBOARD in imitation of other
4511 windowing systems. The selectToClipboard resource (and corresponding
4512 menu entry Select to Clipboard) introduce the SELECT token (known only
4513 to xterm) which chooses between the PRIMARY and CLIPBOARD tokens.
4514 Without using this feature, one can use workarounds such as the xclip
4516 program to show the contents of the X clipboard within an xterm window.
4517 Selection Targets
4519 The different types of data which are passed depend on what the
4520 receiving client asks for. These are termed selection targets.
4521 When asking for the selection data, xterm tries the following types in
4523 this order:
4524 UTF8_STRING
4526 This is an XFree86 extension, which denotes that the data is
4527 encoded in UTF-8. When xterm is built with wide-character
4528 support, it both accepts and provides this type.
4529 TEXT the text is in the encoding which corresponds to your current
4531 locale.
4532 COMPOUND_TEXT
4534 this is a format for multiple character set data, such as
4535 multi-lingual text. It can store UTF-8 data as a special
4536 case.
4537 STRING
4539 This is Latin 1 (ISO-8859-1) data.
4540 The middle two (TEXT and COMPOUND_TEXT) are added if xterm is
4542 configured with the i18nSelections resource set to “true”.
4543 UTF8_STRING is preferred (therefore first in the list) since xterm
4545 stores text as Unicode data when running in wide-character mode, and no
4546 translation is needed. On the other hand, TEXT and COMPOUND_TEXT may
4547 require translation. If the translation is incomplete, they will
4548 insert X's “defaultString” whose value cannot be set, and may simply be
4549 empty. Xterm's defaultString resource specifies the string to use for
4550 incomplete translations of the UTF8_STRING.
4551 You can alter the types which xterm tries using the eightBitSelectTypes
4553 or utf8SelectTypes resources. For instance, you might have some
4554 specific locale setting which does not use UTF-8 encoding. The
4555 resource value is a comma-separated list of the selection targets,
4556 which consist of the names shown. You can use the special name I18N to
4557 denote the optional inclusion of TEXT and COMPOUND_TEXT. The names are
4558 matched ignoring case, and can be abbreviated. The default list can be
4559 expressed in several ways, e.g.,
4560 UTF8_STRING,I18N,STRING
4562 utf8,i18n,string
4563 u,i,s
4564 Mouse Protocol
4566 Applications can send escape sequences to xterm to cause it to send
4567 escape sequences back to the computer when you press a pointer button,
4568 or even (depending on which escape sequence) send escape sequences back
4569 to the computer as you move the pointer.
4570 These escape sequences and the responses, called the mouse protocol,
4572 are documented in XTerm Control Sequences. They do not appear in the
4573 actions invoked by the translations resource because the resource does
4574 not change while you run xterm, whereas applications can change the
4575 mouse prototol (i.e., enable, disable, use different modes).
4576 However, the mouse protocol is interpreted within the actions that are
4578 usually associated with the pointer buttons. Xterm ignores the mouse
4579 protocol in the insert-selection action if the shift-key is pressed at
4580 the same time. It also modifies a few other actions if the shift-key
4581 is pressed, e.g., suppressing the response with the pointer position,
4582 though not eliminating changes to the selected text.
4583
4585 Xterm has four menus, named mainMenu, vtMenu, fontMenu, and tekMenu.
4586 Each menu pops up under the correct combinations of key and button
4587 presses. Each menu is divided into sections, separated by a horizontal
4588 line. Some menu entries correspond to modes that can be altered. A
4589 check mark appears next to a mode that is currently active. Selecting
4590 one of these modes toggles its state. Other menu entries are commands;
4591 selecting one of these performs the indicated function.
4592 All of the menu entries correspond to X actions. In the list below,
4594 the menu label is shown followed by the action's name in parenthesis.
4595 Main Options
4597 The xterm mainMenu pops up when the “control” key and pointer button
4598 one are pressed in a window. This menu contains items that apply to
4599 both the VTxxx and Tektronix windows. There are several sections:
4600 Commands for managing X events:
4602 Toolbar (resource toolbar)
4604 Clicking on the “Toolbar” menu entry hides the toolbar if
4605 it is visible, and shows it if it is not.
4606 Secure Keyboard (resource securekbd)
4608 The Secure Keyboard mode is helpful when typing in
4609 passwords or other sensitive data in an unsecure
4610 environment (see SECURITY below, but read the limitations
4611 carefully).
4612 Allow SendEvents (resource allowsends)
4614 Specifies whether or not synthetic key and button events
4615 generated using the X protocol SendEvent request should
4616 be interpreted or discarded. This corresponds to the
4617 allowSendEvents resource.
4618 Redraw Window (resource redraw)
4620 Forces the X display to repaint; useful in some
4621 environments.
4622 Commands for capturing output:
4624 Log to File (resource logging)
4626 Captures text sent to the screen in a logfile, as in the
4627 -l logging option.
4628 Print-All Immediately (resource print-immediate)
4630 Invokes the print-immediate action, sending the text of
4631 the current window directly to a file, as specified by
4632 the printFileImmediate, printModeImmediate and
4633 printOptsImmediate resources.
4634 Print-All on Error (resource print-on-error)
4636 Invokes the print-on-error action, which toggles a flag
4637 telling xterm that if it exits with an X error, to send
4638 the text of the current window directly to a file, as
4639 specified by the printFileOnXError, printModeOnXError and
4640 printOptsOnXError resources.
4641 Print Window (resource print)
4643 Sends the text of the current window to the program given
4644 in the printerCommand resource.
4645 Redirect to Printer (resource print-redir)
4647 This sets the printerControlMode to 0 or 2. You can use
4648 this to turn the printer on as if an application had sent
4649 the appropriate control sequence. It is also useful for
4650 switching the printer off if an application turns it on
4651 without resetting the print control mode.
4652 XHTML Screen Dump (resource dump-html)
4654 Available only when compiled with screen dump support.
4655 Invokes the dump-html action. This creates an XHTML file
4656 matching the contents of the current screen, including
4657 the border, internal border, colors and most attributes:
4658 bold, italic, underline, faint, strikeout, reverse; blink
4659 is rendered as white-on-red; double underline is rendered
4660 the same as underline since there is no portable
4661 equivalent in CSS 2.2.
4662 The font is whatever your browser uses for preformatted
4664 (<pre>) elements. The XHTML file references a cascading
4665 style sheet (CSS) named “xterm.css” that you can create
4666 to select a font or override properties.
4667 The following CSS selectors are used with the expected
4669 default behavior in the XHTML file:
4670 .ul for underline,
4672 .bd for bold,
4673 .it for italic,
4674 .st for strikeout,
4675 .lu for strikeout combined with underline.
4676 In addition you may use
4678 .ev to affect even numbered lines and
4680 .od to affect odd numbered lines.
4681 Attributes faint, reverse and blink are implemented as
4683 style attributes setting color properties. All colors
4684 are specified as RGB percentages in order to support
4685 displays with 10 bits per RGB.
4686 The name of the file will be
4688 xterm.yyyy.MM.dd.hh.mm.ss.xhtml
4690 where yyyy, MM, dd, hh, mm and ss are the year, month,
4692 day, hour, minute and second when the screen dump was
4693 performed (the file is created in the directory xterm is
4694 started in, or the home directory for a login xterm).
4695 The dump-html action can also be triggered using the
4697 Media Copy control sequence CSI 1 0 i, for example from a
4698 shell script with
4699 printf '\033[10i'
4701 Only the UTF-8 encoding is supported.
4703 SVG Screen Dump (resource dump-svg)
4705 Available only when compiled with screen dump support.
4706 Invokes the dump-svg action. This creates a Scalable
4707 Vector Graphics (SVG) file matching the contents of the
4708 current screen, including the border, internal border,
4709 colors and most attributes: bold, italic, underline,
4710 double underline, faint, strikeout, reverse; blink is
4711 rendered as white-on-red. The font is whatever your
4712 renderer uses for the monospace font-family. All colors
4713 are specified as RGB percentages in order to support
4714 displays with 10 bits per RGB.
4715 The name of the file will be
4717 xterm.yyyy.MM.dd.hh.mm.ss.svg
4719 where yyyy, MM, dd, hh, mm and ss are the year, month,
4721 day, hour, minute and second when the screen dump was
4722 performed (the file is created in the directory xterm is
4723 started in, or the home directory for a login xterm).
4724 The dump-svg action can also be triggered using the Media
4726 Copy control sequence CSI 1 1 i, for example from a shell
4727 script with
4728 printf '\033[11i'
4730 Only the UTF-8 encoding is supported.
4732 Modes for setting keyboard style:
4734 8-Bit Controls (resource 8-bit-control)
4736 Enabled for VT220 emulation, this controls whether xterm
4737 will send 8-bit control sequences rather than using 7-bit
4738 (ASCII) controls, e.g., sending a byte in the range
4739 128–159 rather than the escape character followed by a
4740 second byte. Xterm always interprets both 8-bit and
4741 7-bit control sequences (see Xterm Control Sequences).
4742 This corresponds to the eightBitControl resource.
4743 Backarrow Key (BS/DEL) (resource backarrow key)
4745 Modifies the behavior of the backarrow key, making it
4746 transmit either a backspace (8) or delete (127)
4747 character. This corresponds to the backarrowKey
4748 resource.
4749 Alt/NumLock Modifiers (resource num-lock)
4751 Controls the treatment of Alt- and NumLock-key modifiers.
4752 This corresponds to the numLock resource.
4753 Meta Sends Escape (resource meta-esc)
4755 Controls whether Meta keys are converted into a two-
4756 character sequence with the character itself preceded by
4757 ESC. This corresponds to the metaSendsEscape resource.
4758 Delete is DEL (resource delete-is-del)
4760 Controls whether the Delete key on the editing keypad
4761 should send DEL (127) or the VT220-style Remove escape
4762 sequence. This corresponds to the deleteIsDEL resource.
4763 Old Function-Keys (resource oldFunctionKeys)
4765 HP Function-Keys (resource hpFunctionKeys)
4767 SCO Function-Keys (resource scoFunctionKeys)
4769 Sun Function-Keys (resource sunFunctionKeys)
4771 VT220 Keyboard (resource sunKeyboard)
4773 These act as a radio-button, selecting one style for the
4774 keyboard layout. The layout corresponds to more than one
4775 resource setting: sunKeyboard, sunFunctionKeys,
4776 scoFunctionKeys and hpFunctionKeys.
4777 Commands for process signalling:
4779 Send STOP Signal (resource suspend)
4781 Send CONT Signal (resource continue)
4783 Send INT Signal (resource interrupt)
4785 Send HUP Signal (resource hangup)
4787 Send TERM Signal (resource terminate)
4789 Send KILL Signal (resource kill)
4791 These send the SIGTSTP, SIGCONT, SIGINT, SIGHUP, SIGTERM
4792 and SIGKILL signals respectively, to the process group of
4793 the process running under xterm (usually the shell). The
4794 SIGCONT function is especially useful if the user has
4795 accidentally typed CTRL-Z, suspending the process.
4796 Quit (resource quit)
4798 Stop processing X events except to support the -hold
4799 option, and then send a SIGHUP signal to the process
4800 group of the process running under xterm (usually the
4801 shell).
4802 VT Options
4804 The xterm vtMenu sets various modes in the VTxxx emulation, and is
4805 popped up when the “control” key and pointer button two are pressed in
4806 the VTxxx window.
4807 VTxxx Modes:
4809 Enable Scrollbar (resource scrollbar)
4811 Enable (or disable) the scrollbar. This corresponds to
4812 the -sb option and the scrollBar resource.
4813 Enable Jump Scroll (resource jumpscroll)
4815 Enable (or disable) jump scrolling. This corresponds to
4816 the -j option and the jumpScroll resource.
4817 Enable Reverse Video (resource reversevideo)
4819 Enable (or disable) reverse-video. This corresponds to
4820 the -rv option and the reverseVideo resource.
4821 Enable Auto Wraparound (resource autowrap)
4823 Enable (or disable) auto-wraparound. This corresponds to
4824 the -aw option and the autoWrap resource.
4825 Enable Reverse Wraparound (resource reversewrap)
4827 Enable (or disable) reverse wraparound. This corresponds
4828 to the -rw option and the reverseWrap resource.
4829 Enable Auto Linefeed (resource autolinefeed)
4831 Enable (or disable) auto-linefeed. This is the VT102 NEL
4832 function, which causes the emulator to emit a linefeed
4833 after each carriage return. There is no corresponding
4834 command-line option or resource setting.
4835 Enable Application Cursor Keys (resource appcursor)
4837 Enable (or disable) application cursor keys. This
4838 corresponds to the appcursorDefault resource. There is
4839 no corresponding command-line option.
4840 Enable Application Keypad (resource appkeypad)
4842 Enable (or disable) application keypad keys. This
4843 corresponds to the appkeypadDefault resource. There is
4844 no corresponding command-line option.
4845 Scroll to Bottom on Key Press (resource scrollkey)
4847 Enable (or disable) scrolling to the bottom of the
4848 scrolling region on a keypress. This corresponds to the
4849 -sk option and the scrollKey resource.
4850 As a special case, the XON / XOFF keys (control/S and
4852 control/Q) are ignored.
4853 Scroll to Bottom on Tty Output (resource scrollttyoutput)
4855 Enable (or disable) scrolling to the bottom of the
4856 scrolling region on output to the terminal. This
4857 corresponds to the -si option and the scrollTtyOutput
4858 resource.
4859 Allow 80/132 Column Switching (resource allow132)
4861 Enable (or disable) switching between 80 and 132 columns.
4862 This corresponds to the -132 option and the c132
4863 resource.
4864 Keep Selection (resource keepSelection)
4866 Tell xterm whether to disown the selection when it stops
4867 highlighting it, e.g., when an application modifies the
4868 display so that it no longer matches the text which has
4869 been highlighted. As long as xterm continues to own the
4870 selection, it can provide the corresponding text to other
4871 clients via cut/paste. This corresponds to the
4872 keepSelection resource. There is no corresponding
4873 command-line option.
4874 Select to Clipboard (resource selectToClipboard)
4876 Tell xterm whether to use the PRIMARY or CLIPBOARD for
4877 SELECT tokens in the translations resource which maps
4878 keyboard and mouse actions to select/paste actions. This
4879 corresponds to the selectToClipboard resource. There is
4880 no corresponding command-line option.
4881 Enable Visual Bell (resource visualbell)
4883 Enable (or disable) visible bell (i.e., flashing) instead
4884 of an audible bell. This corresponds to the -vb option
4885 and the visualBell resource.
4886 Enable Bell Urgency (resource bellIsUrgent)
4888 Enable (or disable) Urgency window manager hint when
4889 Control-G is received. This corresponds to the
4890 bellIsUrgent resource.
4891 Enable Pop on Bell (resource poponbell)
4893 Enable (or disable) raising of the window when Control-G
4894 is received. This corresponds to the -pop option and the
4895 popOnBell resource.
4896 Enable Blinking Cursor (resource cursorblink)
4898 Enable (or disable) the blinking-cursor feature. This
4899 corresponds to the -bc option and the cursorBlink
4900 resource. There are also escape sequences (see Xterm
4901 Control Sequences):
4902 · If the cursorBlinkXOR resource is set, the menu entry
4904 and the escape sequence states will be XOR'd: if both
4905 are enabled, the cursor will not blink, if only one
4906 is enabled, the cursor will blink.
4907 · If the cursorBlinkXOR is not set; if either the menu
4909 entry or the escape sequence states are set, the
4910 cursor will blink.
4911 In either case, the checkbox for the menu shows the state
4913 of the cursorBlink resource, which may not correspond to
4914 what the cursor is actually doing.
4915 Enable Alternate Screen Switching (resource titeInhibit)
4917 Enable (or disable) switching between the normal and
4918 alternate screens. This corresponds to the titeInhibit
4919 resource. There is no corresponding command-line option.
4920 Enable Active Icon (resource activeicon)
4922 Enable (or disable) the active-icon feature. This
4923 corresponds to the -ai option and the activeIcon
4924 resource.
4925 Sixel Scrolling (resource sixelScrolling)
4927 When enabled, sixel graphics are positioned at the
4928 current text cursor location, scroll the image vertically
4929 if larger than the screen, and leave the text cursor at
4930 the start of the next complete line after the image when
4931 returning to text mode (this is the default). When
4932 disabled, sixel graphics are positioned at the upper left
4933 of the screen, are cropped to fit the screen, and do not
4934 affect the text cursor location. This corresponds to the
4935 sixelScrolling resource. There is no corresponding
4936 command-line option.
4937 Private Color Registers (resource privateColorRegisters)
4939 If xterm is configured to support ReGIS graphics, this
4940 controls whether a private color palette can be used.
4941 When enabled, each graphic image uses a separate set of
4943 color registers, so that it essentially has a private
4944 palette (this is the default). If it is not set, all
4945 graphics images share a common set of registers which is
4946 how sixel and ReGIS graphics worked on actual hardware.
4947 The default is likely a more useful mode on modern
4948 TrueColor hardware.
4949 This corresponds to the privateColorRegisters resource.
4951 There is no corresponding command-line option.
4952 VTxxx Commands:
4954 Do Soft Reset (resource softreset)
4956 Reset scroll regions. This can be convenient when some
4957 program has left the scroll regions set incorrectly
4958 (often a problem when using VMS or TOPS-20). This
4959 corresponds to the VT220 DECSTR control sequence.
4960 Do Full Reset (resource hardreset)
4962 The full reset entry will clear the screen, reset tabs to
4963 every eight columns, and reset the terminal modes (such
4964 as wrap and smooth scroll) to their initial states just
4965 after xterm has finished processing the command line
4966 options. This corresponds to the VT102 RIS control
4967 sequence, with a few obvious differences. For example,
4968 your session is not disconnected as a real VT102 would
4969 do.
4970 Reset and Clear Saved Lines (resource clearsavedlines)
4972 Perform a full reset, and also clear the saved lines.
4973 Commands for setting the current screen:
4975 Show Tek Window (resource tekshow)
4977 When enabled, pops the Tektronix 4014 window up (makes it
4978 visible). When disabled, hides the Tektronix 4014
4979 window.
4980 Switch to Tek Mode (resource tekmode)
4982 When enabled, pops the Tektronix 4014 window up if it is
4983 not already visible, and switches the input stream to
4984 that window. When disabled, hides the Tektronix 4014
4985 window and switches input back to the VTxxx window.
4986 Hide VT Window (resource vthide)
4988 When enabled, hides the VTxxx window, shows the Tektronix
4989 4014 window if it was not already visible and switches
4990 the input stream to that window. When disabled, shows
4991 the VTxxx window, and switches the input stream to that
4992 window.
4993 Show Alternate Screen (resource altscreen)
4995 When enabled, shows the alternate screen. When disabled,
4996 shows the normal screen. Note that the normal screen may
4997 have saved lines; the alternate screen does not.
4998 VT Fonts
5000 The xterm fontMenu pops up when the “control” key and pointer button
5001 three are pressed in a window. It sets the font used in the VTxxx
5002 window, or modifies the way the font is specified or displayed. There
5003 are several sections.
5004 The first section allows you to select the font from a set of
5006 alternatives:
5007 Default (resource fontdefault)
5009 Set the font to the default, i.e., that given by the
5010 *VT100.font resource.
5011 Unreadable (resource font1)
5013 Set the font to that given by the *VT100.font1 resource.
5014 Tiny (resource font2)
5016 Set the font to that given by the *VT100.font2 resource.
5017 Small (resource font3)
5019 Set the font to that given by the *VT100.font3 resource.
5020 Medium (resource font4)
5022 Set the font to that given by the *VT100.font4 resource.
5023 Large (resource font5)
5025 Set the font to that given by the *VT100.font5 resource.
5026 Huge (resource font6)
5028 Set the font to that given by the *VT100.font6 resource.
5029 Escape Sequence (resource fontescape)
5031 This allows you to set the font last specified by the Set
5032 Font escape sequence (see Xterm Control Sequences).
5033 Selection (resource fontsel)
5035 This allows you to set the font specified the current
5036 selection as a font name (if the PRIMARY selection is
5037 owned).
5038 The second section allows you to modify the way it is displayed:
5040 Bold Fonts (resource allow-bold-fonts)
5042 This is normally checked (enabled). When unchecked,
5043 xterm will not use bold fonts. The setting corresponds
5044 to the allowBoldFonts resource.
5045 Line-Drawing Characters (resource font-linedrawing)
5047 When set, tells xterm to draw its own line-drawing
5048 characters. Otherwise it relies on the font containing
5049 these. Compare to the forceBoxChars resource.
5050 Packed Font (resource font-packed)
5052 When set, tells xterm to use the minimum glyph-width from
5053 a font when displaying characters. Use the maximum width
5054 (unchecked) to help display proportional fonts. Compare
5055 to the forcePackedFont resource.
5056 Doublesized Characters (resource font-doublesize)
5058 When set, xterm may ask the font server to produce scaled
5059 versions of the normal font, for VT102 double-size
5060 characters.
5061 The third section allows you to modify the way it is specified:
5063 TrueType Fonts (resource render-font)
5065 If the renderFont and corresponding resources were set,
5066 this is a further control whether xterm will actually use
5067 the Xft library calls to obtain a font.
5068 UTF-8 Encoding (resource utf8-mode)
5070 This controls whether xterm uses UTF-8 encoding of
5071 input/output. It is useful for temporarily switching
5072 xterm to display text from an application which does not
5073 follow the locale settings. It corresponds to the utf8
5074 resource.
5075 UTF-8 Fonts (resource utf8-fonts)
5077 This controls whether xterm uses UTF-8 fonts for display.
5078 It is useful for temporarily switching xterm to display
5079 text from an application which does not follow the locale
5080 settings. It combines the utf8 and utf8Fonts resources,
5081 subject to the locale resource.
5082 UTF-8 Titles (resource utf8-title)
5084 This controls whether xterm accepts UTF-8 encoding for
5085 title control sequences. It corresponds to the utf8Fonts
5086 resource.
5087 Initially the checkmark is set according to both the utf8
5089 and utf8Fonts resource values. If the latter is set to
5090 “always”, the checkmark is disabled. Likewise, if there
5091 are no fonts given in the utf8Fonts subresources, then
5092 the checkmark also is disabled.
5093 The standard XTerm app-defaults file defines both sets of
5095 fonts, while the UXTerm app-defaults file defines only
5096 one set. Assuming the standard app-defaults files, this
5097 command will launch xterm able to switch between UTF-8
5098 and ISO-8859-1 encoded fonts:
5099 uxterm -class XTerm
5101 The fourth section allows you to enable or disable special operations
5103 which can be controlled by writing escape sequences to the terminal.
5104 These are disabled if the SendEvents feature is enabled:
5105 Allow Color Ops (resource allow-font-ops)
5107 This corresponds to the allowColorOps resource. Enable
5108 or disable control sequences that set/query the colors.
5109 Allow Font Ops (resource allow-font-ops)
5111 This corresponds to the allowFontOps resource. Enable or
5112 disable control sequences that set/query the font.
5113 Allow Mouse Ops (resource allow-mouse-ops)
5115 Enable or disable control sequences that cause the
5116 terminal to send escape sequences on pointer-clicks and
5117 movement. This corresponds to the allowMouseOps
5118 resource.
5119 Allow Tcap Ops (resource allow-tcap-ops)
5121 Enable or disable control sequences that query the
5122 terminal's notion of its function-key strings, as termcap
5123 or terminfo capabilities. This corresponds to the
5124 allowTcapOps resource.
5125 Allow Title Ops (resource allow-title-ops)
5127 Enable or disable control sequences that modify the
5128 window title or icon name. This corresponds to the
5129 allowTitleOps resource.
5130 Allow Window Ops (resource allow-window-ops)
5132 Enable or disable extended window control sequences (as
5133 used in dtterm). This corresponds to the allowWindowOps
5134 resource.
5135 Tek Options
5137 The xterm tekMenu sets various modes in the Tektronix emulation, and is
5138 popped up when the “control” key and pointer button two are pressed in
5139 the Tektronix window. The current font size is checked in the modes
5140 section of the menu.
5141 Large Characters (resource tektextlarge)
5143 #2 Size Characters (resource tektext2)
5145 #3 Size Characters (resource tektext3)
5147 Small Characters (resource tektextsmall)
5149 Commands:
5151 PAGE (resource tekpage)
5153 Simulates the Tektronix “PAGE” button by
5154 · clearing the window,
5156 · cancelling the graphics input-mode, and
5158 · moving the cursor to the home position.
5160 RESET (resource tekreset)
5162 Unlike the similarly-named Tektronix “RESET” button, this
5163 does everything that PAGE does as well as resetting the
5164 line-type and font-size to their default values.
5165 COPY (resource tekcopy)
5167 Simulates the Tektronix “COPY” button (which makes a
5168 hard-copy of the screen) by writing the information to a
5169 text file.
5170 Windows:
5172 Show VT Window (resource vtshow)
5174 Switch to VT Mode (resource vtmode)
5176 Hide Tek Window (resource tekhide)
5178
5180 X environments differ in their security consciousness.
5181 · Most servers, run under xdm, are capable of using a “magic cookie”
5183 authorization scheme that can provide a reasonable level of
5184 security for many people. If your server is only using a host-
5185 based mechanism to control access to the server (see xhost(1)),
5186 then if you enable access for a host and other users are also
5187 permitted to run clients on that same host, it is possible that
5188 someone can run an application which uses the basic services of the
5189 X protocol to snoop on your activities, potentially capturing a
5190 transcript of everything you type at the keyboard.
5191 · Any process which has access to your X display can manipulate it in
5193 ways that you might not anticipate, even redirecting your keyboard
5194 to itself and sending events to your application's windows. This
5195 is true even with the “magic cookie” authorization scheme. While
5196 the allowSendEvents provides some protection against rogue
5197 applications tampering with your programs, guarding against a
5198 snooper is harder.
5199 · The X input extension for instance allows an application to bypass
5201 all of the other (limited) authorization and security features,
5202 including the GrabKeyboard protocol.
5203 · The possibility of an application spying on your keystrokes is of
5205 particular concern when you want to type in a password or other
5206 sensitive data. The best solution to this problem is to use a
5207 better authorization mechanism than is provided by X.
5208 Subject to all of these caveats, a simple mechanism exists for
5210 protecting keyboard input in xterm.
5211 The xterm menu (see MENUS above) contains a Secure Keyboard entry
5213 which, when enabled, attempts to ensure that all keyboard input is
5214 directed only to xterm (using the GrabKeyboard protocol request). When
5215 an application prompts you for a password (or other sensitive data),
5216 you can enable Secure Keyboard using the menu, type in the data, and
5217 then disable Secure Keyboard using the menu again.
5218 · This ensures that you know which window is accepting your
5220 keystrokes.
5221 · It cannot ensure that there are no processes which have access to
5223 your X display that might be observing the keystrokes as well.
5224 Only one X client at a time can grab the keyboard, so when you attempt
5226 to enable Secure Keyboard it may fail. In this case, the bell will
5227 sound. If the Secure Keyboard succeeds, the foreground and background
5228 colors will be exchanged (as if you selected the Enable Reverse Video
5229 entry in the Modes menu); they will be exchanged again when you exit
5230 secure mode. If the colors do not switch, then you should be very
5231 suspicious that you are being spoofed. If the application you are
5232 running displays a prompt before asking for the password, it is safest
5233 to enter secure mode before the prompt gets displayed, and to make sure
5234 that the prompt gets displayed correctly (in the new colors), to
5235 minimize the probability of spoofing. You can also bring up the menu
5236 again and make sure that a check mark appears next to the entry.
5237 Secure Keyboard mode will be disabled automatically if your xterm
5239 window becomes iconified (or otherwise unmapped), or if you start up a
5240 reparenting window manager (that places a title bar or other decoration
5241 around the window) while in Secure Keyboard mode. (This is a feature
5242 of the X protocol not easily overcome.) When this happens, the
5243 foreground and background colors will be switched back and the bell
5244 will sound in warning.
5245
5247 Clicking the left pointer button twice in rapid succession (double-
5248 clicking) causes all characters of the same class (e.g., letters, white
5249 space, punctuation) to be selected as a “word”. Since different people
5250 have different preferences for what should be selected (for example,
5251 should filenames be selected as a whole or only the separate subnames),
5252 the default mapping can be overridden through the use of the charClass
5253 (class CharClass) resource.
5254 This resource is a series of comma-separated range:value pairs.
5256 · The range is either a single number or low-high in the range of 0
5258 to 65535, corresponding to the code for the character or characters
5259 to be set.
5260 · The value is arbitrary. For example, the default table uses the
5262 character number of the first character occurring in the set. When
5263 not in UTF-8 mode, only the first 256 entries of this table will be
5264 used.
5265 The default table starts as follows -
5267 static int charClass[256] = {
5269 /* NUL SOH STX ETX EOT ENQ ACK BEL */
5270 32, 1, 1, 1, 1, 1, 1, 1,
5271 /* BS HT NL VT NP CR SO SI */
5272 1, 32, 1, 1, 1, 1, 1, 1,
5273 /* DLE DC1 DC2 DC3 DC4 NAK SYN ETB */
5274 1, 1, 1, 1, 1, 1, 1, 1,
5275 /* CAN EM SUB ESC FS GS RS US */
5276 1, 1, 1, 1, 1, 1, 1, 1,
5277 /* SP ! " # $ % & ' */
5278 32, 33, 34, 35, 36, 37, 38, 39,
5279 /* ( ) * + , - . / */
5280 40, 41, 42, 43, 44, 45, 46, 47,
5281 /* 0 1 2 3 4 5 6 7 */
5282 48, 48, 48, 48, 48, 48, 48, 48,
5283 /* 8 9 : ; < = > ? */
5284 48, 48, 58, 59, 60, 61, 62, 63,
5285 /* @ A B C D E F G */
5286 64, 48, 48, 48, 48, 48, 48, 48,
5287 /* H I J K L M N O */
5288 48, 48, 48, 48, 48, 48, 48, 48,
5289 /* P Q R S T U V W */
5290 48, 48, 48, 48, 48, 48, 48, 48,
5291 /* X Y Z [ \ ] ^ _ */
5292 48, 48, 48, 91, 92, 93, 94, 48,
5293 /* ` a b c d e f g */
5294 96, 48, 48, 48, 48, 48, 48, 48,
5295 /* h i j k l m n o */
5296 48, 48, 48, 48, 48, 48, 48, 48,
5297 /* p q r s t u v w */
5298 48, 48, 48, 48, 48, 48, 48, 48,
5299 /* x y z { | } ~ DEL */
5300 48, 48, 48, 123, 124, 125, 126, 1,
5301 /* x80 x81 x82 x83 IND NEL SSA ESA */
5302 1, 1, 1, 1, 1, 1, 1, 1,
5303 /* HTS HTJ VTS PLD PLU RI SS2 SS3 */
5304 1, 1, 1, 1, 1, 1, 1, 1,
5305 /* DCS PU1 PU2 STS CCH MW SPA EPA */
5306 1, 1, 1, 1, 1, 1, 1, 1,
5307 /* x98 x99 x9A CSI ST OSC PM APC */
5308 1, 1, 1, 1, 1, 1, 1, 1,
5309 /* - i c/ L ox Y- | So */
5310 160, 161, 162, 163, 164, 165, 166, 167,
5311 /* .. c0 ip << _ R0 - */
5312 168, 169, 170, 171, 172, 173, 174, 175,
5313 /* o +- 2 3 ' u q| . */
5314 176, 177, 178, 179, 180, 181, 182, 183,
5315 /* , 1 2 >> 1/4 1/2 3/4 ? */
5316 184, 185, 186, 187, 188, 189, 190, 191,
5317 /* A` A' A^ A~ A: Ao AE C, */
5318 48, 48, 48, 48, 48, 48, 48, 48,
5319 /* E` E' E^ E: I` I' I^ I: */
5320 48, 48, 48, 48, 48, 48, 48, 48,
5321 /* D- N~ O` O' O^ O~ O: X */
5322 48, 48, 48, 48, 48, 48, 48, 215,
5323 /* O/ U` U' U^ U: Y' P B */
5324 48, 48, 48, 48, 48, 48, 48, 48,
5325 /* a` a' a^ a~ a: ao ae c, */
5326 48, 48, 48, 48, 48, 48, 48, 48,
5327 /* e` e' e^ e: i` i' i^ i: */
5328 48, 48, 48, 48, 48, 48, 48, 48,
5329 /* d n~ o` o' o^ o~ o: -: */
5330 48, 48, 48, 48, 48, 48, 48, 247,
5331 /* o/ u` u' u^ u: y' P y: */
5332 48, 48, 48, 48, 48, 48, 48, 48};
5333 For example, the string “33:48,37:48,45-47:48,38:48” indicates
5335 that the exclamation mark, percent sign, dash, period, slash,
5336 and ampersand characters should be treated the same way as
5337 characters and numbers. This is useful for cutting and pasting
5338 electronic mailing addresses and filenames.
5339
5341 It is possible to rebind keys (or sequences of keys) to arbitrary
5342 strings for input, by changing the translations resources for the vt100
5343 or tek4014 widgets. Changing the translations resource for events
5344 other than key and button events is not expected, and will cause
5345 unpredictable behavior.
5346 Actions
5348 The following actions are provided for use within the vt100 or tek4014
5349 translations resources:
5350 allow-bold-fonts(on/off/toggle)
5352 This action sets, unsets or toggles the allowBoldFonts resource
5353 and is also invoked by the allow-bold-fonts entry in fontMenu.
5354 allow-color-ops(on/off/toggle)
5356 This action sets, unsets or toggles the allowColorOps resource
5357 and is also invoked by the allow-color-ops entry in fontMenu.
5358 allow-font-ops(on/off/toggle)
5360 This action sets, unsets or toggles the allowFontOps resource
5361 and is also invoked by the allow-font-ops entry in fontMenu.
5362 allow-mouse-ops(on/off/toggle)
5364 This action sets, unsets or toggles the allowMousepOps resource
5365 and is also invoked by the allow-mouse-ops entry in fontMenu.
5366 allow-send-events(on/off/toggle)
5368 This action sets, unsets or toggles the allowSendEvents
5369 resource and is also invoked by the allowsends entry in
5370 mainMenu.
5371 allow-tcap-ops(on/off/toggle)
5373 This action sets, unsets or toggles the allowTcapOps resource
5374 and is also invoked by the allow-tcap-ops entry in fontMenu.
5375 allow-title-ops(on/off/toggle)
5377 This action sets, unsets or toggles the allowTitleOps resource
5378 and is also invoked by the allow-title-ops entry in fontMenu.
5379 allow-window-ops(on/off/toggle)
5381 This action sets, unsets or toggles the allowWindowOps resource
5382 and is also invoked by the allow-window-ops entry in fontMenu.
5383 alt-sends-escape()
5385 This action toggles the state of the altSendsEscape resource.
5386 bell([percent])
5388 This action rings the keyboard bell at the specified percentage
5389 above or below the base volume.
5390 clear-saved-lines()
5392 This action does hard-reset() and also clears the history of
5393 lines saved off the top of the screen. It is also invoked from
5394 the clearsavedlines entry in vtMenu. The effect is identical
5395 to a hardware reset (RIS) control sequence.
5396 copy-selection(destname [, ...])
5398 This action puts the currently selected text into all of the
5399 selections or cutbuffers specified by destname. Unlike select-
5400 end, it does not send a mouse position or otherwise modify the
5401 internal selection state.
5402 create-menu(m/v/f/t)
5404 This action creates one of the menus used by xterm, if it has
5405 not been previously created. The parameter values are the menu
5406 names: mainMenu, vtMenu, fontMenu, tekMenu, respectively.
5407 dabbrev-expand()
5409 Expands the word before cursor by searching in the preceding
5410 text on the screen and in the scrollback buffer for words
5411 starting with that abbreviation. Repeating dabbrev-expand()
5412 several times in sequence searches for an alternative expansion
5413 by looking farther back. Lack of more matches is signaled by a
5414 bell. Attempts to expand an empty word (i.e., when cursor is
5415 preceded by a space) yield successively all previous words.
5416 Consecutive identical expansions are ignored. The word here is
5417 defined as a sequence of non-whitespace characters. This
5418 feature partially emulates the behavior of “dynamic
5419 abbreviation” expansion in Emacs (bound there to M-/). Here is
5420 a resource setting for xterm which will do the same thing:
5421 *VT100*translations: #override \n\
5423 Meta <KeyPress> /:dabbrev-expand()
5424 deiconify()
5426 Changes the window state back to normal, if it was iconified.
5427 delete-is-del()
5429 This action toggles the state of the deleteIsDEL resource.
5430 dired-button()
5432 Handles a button event (other than press and release) by
5433 echoing the event's position (i.e., character line and column)
5434 in the following format:
5435 ^X ESC G <line+“ ”> <col+“ ”>
5437 dump-html()
5439 Invokes the XHTML Screen Dump feature.
5440 dump-svg()
5442 Invokes the SVG Screen Dump feature.
5443 exec-formatted(format, sourcename [, ...])
5445 Execute an external command, using the current selection for
5446 part of the command's parameters. The first parameter, format
5447 gives the basic command. Succeeding parameters specify the
5448 selection source as in insert-selection.
5449 The format parameter allows these substitutions:
5451 %% inserts a "%".
5453 %P the screen-position at the beginning of the highlighted
5455 region, as a semicolon-separated pair of integers using
5456 the values that the CUP control sequence would use.
5457 %p the screen-position after the beginning of the highlighted
5459 region, using the same convention as “%P”.
5460 %S the length of the string that “%s” would insert.
5462 %s the content of the selection, unmodified.
5464 %T the length of the string that “%t” would insert.
5466 %t the selection, trimmed of leading/trailing whitespace.
5468 Embedded spaces (and newlines) are copied as is.
5469 %R the length of the string that “%r” would insert.
5471 %r the selection, trimmed of trailing whitespace.
5473 %V the video attributes at the beginning of the highlighted
5475 region, as a semicolon-separated list of integers using
5476 the values that the SGR control sequence would use.
5477 %v the video attributes after the end of the highlighted
5479 region, using the same convention as “%V”.
5480 After constructing the command-string, xterm forks a subprocess
5482 and executes the command, which completes independently of
5483 xterm.
5484 For example, this translation would invoke a new xterm process
5486 to view a file whose name is selected while holding the shift
5487 key down. The new process is started when the mouse button is
5488 released:
5489 *VT100*translations: #override Shift \
5491 <Btn1Up>:exec-formatted("xterm -e view '%t'", SELECT)
5492 exec-selectable(format, onClicks)
5494 Execute an external command, using data copied from the screen
5495 for part of the command's parameters. The first parameter,
5496 format gives the basic command as in exec-formatted. The
5497 second parameter specifies the method for copying the data as
5498 in the on2Clicks resource.
5499 fullscreen(on/off/toggle)
5501 This action sets, unsets or toggles the fullscreen resource.
5502 iconify()
5504 Iconifies the window.
5505 hard-reset()
5507 This action resets the scrolling region, tabs, window size, and
5508 cursor keys and clears the screen. It is also invoked from the
5509 hardreset entry in vtMenu.
5510 ignore()
5512 This action ignores the event but checks for special pointer
5513 position escape sequences.
5514 insert()
5516 This action inserts the character or string associated with the
5517 key that was pressed.
5518 insert-eight-bit()
5520 This action inserts an eight-bit (Meta) version of the
5521 character or string associated with the key that was pressed.
5522 Only single-byte values are treated specially. The exact
5523 action depends on the value of the altSendsEscape and the
5524 metaSendsEscape and the eightBitInput resources. The
5525 metaSendsEscape resource is tested first. See the
5526 eightBitInput resource for a full discussion.
5527 The term “eight-bit” is misleading: xterm checks if the key is
5529 in the range 128 to 255 (the eighth bit is set). If the value
5530 is in that range, depending on the resource values, xterm may
5531 then do one of the following:
5532 · add 128 to the value, setting its eighth bit,
5534 · send an ESC byte before the key, or
5536 · send the key unaltered.
5538 insert-formatted(format, sourcename [, ...])
5540 Insert the current selection or data related to it, formatted.
5541 The first parameter, format gives the template for the data as
5542 in exec-formatted. Succeeding parameters specify the selection
5543 source as in insert-selection.
5544 insert-selectable(format, onClicks)
5546 Insert data copied from the screen, formatted. The first
5547 parameter, format gives the template for the data as in exec-
5548 formatted. The second parameter specifies the method for
5549 copying the data as in the on2Clicks resource.
5550 insert-selection(sourcename [, ...])
5552 This action inserts the string found in the selection or
5553 cutbuffer indicated by sourcename. Sources are checked in the
5554 order given (case is significant) until one is found.
5555 Commonly-used selections include: PRIMARY, SECONDARY, and
5556 CLIPBOARD. Cut buffers are typically named CUT_BUFFER0 through
5557 CUT_BUFFER7.
5558 insert-seven-bit()
5560 This action is a synonym for insert(). The term “seven-bit” is
5561 misleading: it only implies that xterm does not try to add 128
5562 to the key's value as in insert-eight-bit().
5563 interpret(control-sequence)
5565 Interpret the given control sequence locally, i.e., without
5566 passing it to the host. This works by inserting the control
5567 sequence at the front of the input buffer. Use “\” to escape
5568 octal digits in the string. Xt does not allow you to put a
5569 null character (i.e., “\000”) in the string.
5570 keymap(name)
5572 This action dynamically defines a new translation table whose
5573 resource name is name with the suffix “Keymap” (i.e.,
5574 nameKeymap, where case is significant). The name None restores
5575 the original translation table.
5576 larger-vt-font()
5578 Set the font to the next larger one, based on the font
5579 dimensions. See also set-vt-font().
5580 load-vt-fonts(name[,class])
5582 Load fontnames from the given subresource name and class. That
5583 is, load the “*VT100.name.font”, resource as “*VT100.font” etc.
5584 If no name is given, the original set of fontnames is restored.
5585 Unlike set-vt-font(), this does not affect the escape- and
5587 select-fonts, since those are not based on resource values. It
5588 does affect the fonts loosely organized under the “Default”
5589 menu entry, including font, boldFont, wideFont and
5590 wideBoldFont.
5591 maximize()
5593 Resizes the window to fill the screen.
5594 meta-sends-escape()
5596 This action toggles the state of the metaSendsEscape resource.
5597 popup-menu(menuname)
5599 This action displays the specified popup menu. Valid names
5600 (case is significant) include: mainMenu, vtMenu, fontMenu, and
5601 tekMenu.
5602 print(printer-flags)
5604 This action prints the window. It is also invoked by the print
5605 entry in mainMenu.
5606 The action accepts optional parameters, which temporarily
5608 override resource settings. The parameter values are matched
5609 ignoring case:
5610 noFormFeed
5612 no form feed will be sent at the end of the last line
5613 printed (i.e., printerFormFeed is “false”).
5614 FormFeed
5616 a form feed will be sent at the end of the last line
5617 printed (i.e., printerFormFeed is “true”).
5618 noNewLine
5620 no newline will be sent at the end of the last line
5621 printed, and wrapped lines will be combined into long
5622 lines (i.e., printerNewLine is “false”).
5623 NewLine
5625 a newline will be sent at the end of the last line
5626 printed, and each line will be limited (by adding a
5627 newline) to the screen width (i.e., printerNewLine is
5628 “true”).
5629 noAttrs
5631 the page is printed without attributes (i.e.,
5632 printAttributes is “0”).
5633 monoAttrs
5635 the page is printed with monochrome (vt220) attributes
5636 (i.e., printAttributes is “1”).
5637 colorAttrs
5639 the page is printed with ANSI color attributes (i.e.,
5640 printAttributes is “2”).
5641 print-everything(printer-flags)
5643 This action sends the entire text history, in addition to the
5644 text currently visible, to the program given in the
5645 printerCommand resource. It allows the same optional
5646 parameters as the print action. With a suitable printer
5647 command, the action can be used to load the text history in an
5648 editor.
5649 print-immediate()
5651 Sends the text of the current window directly to a file, as
5652 specified by the printFileImmediate, printModeImmediate and
5653 printOptsImmediate resources.
5654 print-on-error()
5656 Toggles a flag telling xterm that if it exits with an X error,
5657 to send the text of the current window directly to a file, as
5658 specified by the printFileOnXError, printModeOnXError and
5659 printOptsOnXError resources.
5660 print-redir()
5662 This action toggles the printerControlMode between 0 and 2.
5663 The corresponding popup menu entry is useful for switching the
5664 printer off if you happen to change your mind after deciding to
5665 print random binary files on the terminal.
5666 quit()
5668 This action sends a SIGHUP to the subprogram and exits. It is
5669 also invoked by the quit entry in mainMenu.
5670 readline-button()
5672 Supports the optional readline feature by echoing repeated
5673 cursor forward or backward control sequences on button release
5674 event, to request that the host application update its notion
5675 of the cursor's position to match the button event.
5676 redraw()
5678 This action redraws the window. It is also invoked by the
5679 redraw entry in mainMenu.
5680 restore()
5682 Restores the window to the size before it was last maximized.
5683 scroll-back(count [,units [,mouse] ])
5685 This action scrolls the text window backward so that text that
5686 had previously scrolled off the top of the screen is now
5687 visible.
5688 The count argument indicates the number of units (which may be
5690 page, halfpage, pixel, or line) by which to scroll.
5691 An adjustment can be specified for the page or halfpage units
5693 by appending a “+” or “-” sign followed by a number, e.g.,
5694 page-2 to specify 2 lines less than a page.
5695 If the third parameter mouse is given, the action is ignored
5697 when mouse reporting is enabled.
5698 scroll-forw(count [,units [,mouse] ])
5700 This action is similar to scroll-back except that it scrolls in
5701 the other direction.
5702 secure()
5704 This action toggles the Secure Keyboard mode (see SECURITY),
5705 and is invoked from the securekbd entry in mainMenu.
5706 scroll-lock(on/off/toggle)
5708 This action sets, unsets or toggles internal state which tells
5709 xterm whether Scroll Lock is active, subject to the
5710 allowScrollLock resource.
5711 scroll-to(count)
5713 Scroll to the given line relative to the beginning of the
5714 saved-lines. For instance, “scroll-to(0)” would scroll to the
5715 beginning. Two special nonnumeric parameters are recognized:
5716 scroll-to(begin)
5718 Scroll to the beginning of the saved lines.
5719 scroll-to(end)
5721 Scroll to the end of the saved lines, i.e., to the
5722 currently active page.
5723 select-cursor-end(destname [, ...])
5725 This action is similar to select-end except that it should be
5726 used with select-cursor-start.
5727 select-cursor-extend()
5729 This action is similar to select-extend except that it should
5730 be used with select-cursor-start.
5731 select-cursor-start()
5733 This action is similar to select-start except that it begins
5734 the selection at the current text cursor position.
5735 select-end(destname [, ...])
5737 This action puts the currently selected text into all of the
5738 selections or cutbuffers specified by destname. It also sends
5739 a mouse position and updates the internal selection state to
5740 reflect the end of the selection process.
5741 select-extend()
5743 This action tracks the pointer and extends the selection. It
5744 should only be bound to Motion events.
5745 select-set()
5747 This action stores text that corresponds to the current
5748 selection, without affecting the selection mode.
5749 select-start()
5751 This action begins text selection at the current pointer
5752 location. See the section on POINTER USAGE for information on
5753 making selections.
5754 send-signal(signame)
5756 This action sends the signal named by signame to the xterm
5757 subprocess (the shell or program specified with the -e command
5758 line option). It is also invoked by the suspend, continue,
5759 interrupt, hangup, terminate, and kill entries in mainMenu.
5760 Allowable signal names are (case is not significant): tstp (if
5761 supported by the operating system), suspend (same as tstp),
5762 cont (if supported by the operating system), int, hup, term,
5763 quit, alrm, alarm (same as alrm) and kill.
5764 set-8-bit-control(on/off/toggle)
5766 This action sets, unsets or toggles the eightBitControl
5767 resource. It is also invoked from the 8-bit-control entry in
5768 vtMenu.
5769 set-allow132(on/off/toggle)
5771 This action sets, unsets or toggles the c132 resource. It is
5772 also invoked from the allow132 entry in vtMenu.
5773 set-altscreen(on/off/toggle)
5775 This action sets, unsets or toggles between the alternate and
5776 current screens.
5777 set-appcursor(on/off/toggle)
5779 This action sets, unsets or toggles the handling Application
5780 Cursor Key mode and is also invoked by the appcursor entry in
5781 vtMenu.
5782 set-appkeypad(on/off/toggle)
5784 This action sets, unsets or toggles the handling of Application
5785 Keypad mode and is also invoked by the appkeypad entry in
5786 vtMenu.
5787 set-autolinefeed(on/off/toggle)
5789 This action sets, unsets or toggles automatic insertion of
5790 linefeeds. It is also invoked by the autolinefeed entry in
5791 vtMenu.
5792 set-autowrap(on/off/toggle)
5794 This action sets, unsets or toggles automatic wrapping of long
5795 lines. It is also invoked by the autowrap entry in vtMenu.
5796 set-backarrow(on/off/toggle)
5798 This action sets, unsets or toggles the backarrowKey resource.
5799 It is also invoked from the backarrow key entry in vtMenu.
5800 set-bellIsUrgent(on/off/toggle)
5802 This action sets, unsets or toggles the bellIsUrgent resource.
5803 It is also invoked by the bellIsUrgent entry in vtMenu.
5804 set-cursorblink(on/off/toggle)
5806 This action sets, unsets or toggles the cursorBlink resource.
5807 It is also invoked from the cursorblink entry in vtMenu.
5808 set-cursesemul(on/off/toggle)
5810 This action sets, unsets or toggles the curses resource. It is
5811 also invoked from the cursesemul entry in vtMenu.
5812 set-font-doublesize(on/off/toggle)
5814 This action sets, unsets or toggles the fontDoublesize
5815 resource. It is also invoked by the font-doublesize entry in
5816 fontMenu.
5817 set-hp-function-keys(on/off/toggle)
5819 This action sets, unsets or toggles the hpFunctionKeys
5820 resource. It is also invoked by the hpFunctionKeys entry in
5821 mainMenu.
5822 set-jumpscroll(on/off/toggle)
5824 This action sets, unsets or toggles the jumpscroll resource.
5825 It is also invoked by the jumpscroll entry in vtMenu.
5826 set-font-linedrawing(on/off/toggle)
5828 This action sets, unsets or toggles the xterm's state regarding
5829 whether the current font has line-drawing characters and
5830 whether it should draw them directly. It is also invoked by
5831 the font-linedrawing entry in fontMenu.
5832 set-font-packed(on/off/toggle)
5834 This action sets, unsets or toggles the forcePackedFont
5835 resource which controls use of the font's minimum or maximum
5836 glyph width. It is also invoked by the font-packed entry in
5837 fontMenu.
5838 set-keep-clipboard(on/off/toggle)
5840 This action sets, unsets or toggles the keepClipboard resource.
5841 set-keep-selection(on/off/toggle)
5843 This action sets, unsets or toggles the keepSelection resource.
5844 It is also invoked by the keepSelection entry in vtMenu.
5845 set-logging(on/off/toggle)
5847 This action sets, unsets or toggles the state of the logging
5848 option.
5849 set-old-function-keys(on/off/toggle)
5851 This action sets, unsets or toggles the state of legacy
5852 function keys. It is also invoked by the oldFunctionKeys entry
5853 in mainMenu.
5854 set-marginbell(on/off/toggle)
5856 This action sets, unsets or toggles the marginBell resource.
5857 set-num-lock(on/off/toggle)
5859 This action toggles the state of the numLock resource.
5860 set-pop-on-bell(on/off/toggle)
5862 This action sets, unsets or toggles the popOnBell resource. It
5863 is also invoked by the poponbell entry in vtMenu.
5864 set-private-colors(on/off/toggle)
5866 This action sets, unsets or toggles the privateColorRegisters
5867 resource.
5868 set-render-font(on/off/toggle)
5870 This action sets, unsets or toggles the renderFont resource.
5871 It is also invoked by the render-font entry in fontMenu.
5872 set-reverse-video(on/off/toggle)
5874 This action sets, unsets or toggles the reverseVideo resource.
5875 It is also invoked by the reversevideo entry in vtMenu.
5876 set-reversewrap(on/off/toggle)
5878 This action sets, unsets or toggles the reverseWrap resource.
5879 It is also invoked by the reversewrap entry in vtMenu.
5880 set-scroll-on-key(on/off/toggle)
5882 This action sets, unsets or toggles the scrollKey resource. It
5883 is also invoked from the scrollkey entry in vtMenu.
5884 set-scroll-on-tty-output(on/off/toggle)
5886 This action sets, unsets or toggles the scrollTtyOutput
5887 resource. It is also invoked from the scrollttyoutput entry in
5888 vtMenu.
5889 set-scrollbar(on/off/toggle)
5891 This action sets, unsets or toggles the scrollbar resource. It
5892 is also invoked by the scrollbar entry in vtMenu.
5893 set-sco-function-keys(on/off/toggle)
5895 This action sets, unsets or toggles the scoFunctionKeys
5896 resource. It is also invoked by the scoFunctionKeys entry in
5897 mainMenu.
5898 set-select(on/off/toggle)
5900 This action sets, unsets or toggles the selectToClipboard
5901 resource. It is also invoked by the selectToClipboard entry in
5902 vtMenu.
5903 set-sixel-scrolling(on/off/toggle)
5905 This action toggles between inline (sixel scrolling) and
5906 absolute positioning. It can also be controlled via DEC
5907 private mode 80 (DECSDM) or from the sixelScrolling entry in
5908 the btMenu.
5909 set-sun-function-keys(on/off/toggle)
5911 This action sets, unsets or toggles the sunFunctionKeys
5912 resource. It is also invoked by the sunFunctionKeys entry in
5913 mainMenu.
5914 set-sun-keyboard(on/off/toggle)
5916 This action sets, unsets or toggles the sunKeyboard resource.
5917 It is also invoked by the sunKeyboard entry in mainMenu.
5918 set-tek-text(large/2/3/small)
5920 This action sets the font used in the Tektronix window to the
5921 value of the selected resource according to the argument. The
5922 argument can be either a keyword or single-letter alias, as
5923 shown in parentheses:
5924 large (l)
5926 Use resource fontLarge, same as menu entry tektextlarge.
5927 two (2)
5929 Use resource font2, same as menu entry tektext2.
5930 three (3)
5932 Use resource font3, same as menu entry tektext3.
5933 small (s)
5935 Use resource fontSmall, same as menu entry tektextsmall.
5936 set-terminal-type(type)
5938 This action directs output to either the vt or tek windows,
5939 according to the type string. It is also invoked by the
5940 tekmode entry in vtMenu and the vtmode entry in tekMenu.
5941 set-titeInhibit(on/off/toggle)
5943 This action sets, unsets or toggles the titeInhibit resource,
5944 which controls switching between the alternate and current
5945 screens.
5946 set-toolbar(on/off/toggle)
5948 This action sets, unsets or toggles the toolbar feature. It is
5949 also invoked by the toolbar entry in mainMenu.
5950 set-utf8-fonts(on/off/toggle)
5952 This action sets, unsets or toggles the utf8Fonts resource. It
5953 is also invoked by the utf8-fonts entry in fontMenu.
5954 set-utf8-mode(on/off/toggle)
5956 This action sets, unsets or toggles the utf8 resource. It is
5957 also invoked by the utf8-mode entry in fontMenu.
5958 set-utf8-title(on/off/toggle)
5960 This action sets, unsets or toggles the utf8Title resource. It
5961 is also invoked by the utf8-title entry in fontMenu.
5962 set-visibility(vt/tek,on/off/toggle)
5964 This action sets, unsets or toggles whether or not the vt or
5965 tek windows are visible. It is also invoked from the tekshow
5966 and vthide entries in vtMenu and the vtshow and tekhide entries
5967 in tekMenu.
5968 set-visual-bell(on/off/toggle)
5970 This action sets, unsets or toggles the visualBell resource.
5971 It is also invoked by the visualbell entry in vtMenu.
5972 set-vt-font(d/1/2/3/4/5/6/e/s [,normalfont [, boldfont]])
5974 This action sets the font or fonts currently being used in the
5975 VTxxx window. The first argument is a single character that
5976 specifies the font to be used:
5977 d or D indicate the default font (the font initially used when
5979 xterm was started),
5980 1 through 6 indicate the fonts specified by the font1 through
5982 font6 resources,
5983 e or E indicate the normal and bold fonts that have been set
5985 through escape codes (or specified as the second and
5986 third action arguments, respectively), and
5987 s or S indicate the font selection (as made by programs such as
5989 xfontsel(1)) indicated by the second action argument.
5990 If xterm is configured to support wide characters, an
5992 additional two optional parameters are recognized for the e
5993 argument: wide font and wide bold font.
5994 smaller-vt-font()
5996 Set the font to the next smaller one, based on the font
5997 dimensions. See also set-vt-font().
5998 soft-reset()
6000 This action resets the scrolling region. It is also invoked
6001 from the softreset entry in vtMenu. The effect is identical to
6002 a soft reset (DECSTR) control sequence.
6003 spawn-new-terminal(params)
6005 Spawn a new xterm process. This is available on systems which
6006 have a modern version of the process filesystem, e.g., “/proc”,
6007 which xterm can read.
6008 Use the “cwd” process entry, e.g., /proc/12345/cwd to obtain
6010 the working directory of the process which is running in the
6011 current xterm.
6012 On systems which have the “exe” process entry, e.g.,
6014 /proc/12345/exe, use this to obtain the actual executable.
6015 Otherwise, use the $PATH variable to find xterm.
6016 If parameters are given in the action, pass them to the new
6018 xterm process.
6019 start-extend()
6021 This action is similar to select-start except that the
6022 selection is extended to the current pointer location.
6023 start-cursor-extend()
6025 This action is similar to select-extend except that the
6026 selection is extended to the current text cursor position.
6027 string(string)
6029 This action inserts the specified text string as if it had been
6030 typed. Quotation is necessary if the string contains
6031 whitespace or non-alphanumeric characters. If the string
6032 argument begins with the characters “0x”, it is interpreted as
6033 a hex character constant.
6034 tek-copy()
6036 This action copies the escape codes used to generate the
6037 current window contents to a file in the current directory
6038 beginning with the name COPY. It is also invoked from the
6039 tekcopy entry in tekMenu.
6040 tek-page()
6042 This action clears the Tektronix window. It is also invoked by
6043 the tekpage entry in tekMenu.
6044 tek-reset()
6046 This action resets the Tektronix window. It is also invoked by
6047 the tekreset entry in tekMenu.
6048 vi-button()
6050 Handles a button event (other than press and release) by
6051 echoing a control sequence computed from the event's line
6052 number in the screen relative to the current line:
6053 ESC ^P
6055 or
6057 ESC ^N
6059 according to whether the event is before, or after the current
6061 line, respectively. The ^N (or ^P) is repeated once for each
6062 line that the event differs from the current line. The control
6063 sequence is omitted altogether if the button event is on the
6064 current line.
6065 visual-bell()
6067 This action flashes the window quickly.
6068 The Tektronix window also has the following action:
6070 gin-press(l/L/m/M/r/R)
6072 This action sends the indicated graphics input code.
6073 Default Key Bindings
6075 The default bindings in the VTxxx window use the SELECT token, which is
6076 set by the selectToClipboard resource. These are for the vt100 widget:
6077 Shift <KeyPress> Prior:scroll-back(1,halfpage) \n\
6079 Shift <KeyPress> Next:scroll-forw(1,halfpage) \n\
6080 Shift <KeyPress> Select:select-cursor-start() \
6081 select-cursor-end(SELECT, CUT_BUFFER0) \n\
6082 Shift <KeyPress> Insert:insert-selection(SELECT, CUT_BUFFER0) \n\
6083 Alt <Key>Return:fullscreen() \n\
6084 <KeyRelease> Scroll_Lock:scroll-lock() \n\
6085 Shift~Ctrl <KeyPress> KP_Add:larger-vt-font() \n\
6086 Shift Ctrl <KeyPress> KP_Add:smaller-vt-font() \n\
6087 Shift <KeyPress> KP_Subtract:smaller-vt-font() \n\
6088 ~Meta <KeyPress>:insert-seven-bit() \n\
6089 Meta <KeyPress>:insert-eight-bit() \n\
6090 !Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
6091 !Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
6092 !Lock Ctrl @Num_Lock <Btn1Down>:popup-menu(mainMenu) \n\
6093 ! @Num_Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
6094 ~Meta <Btn1Down>:select-start() \n\
6095 ~Meta <Btn1Motion>:select-extend() \n\
6096 !Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
6097 !Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
6098 !Lock Ctrl @Num_Lock <Btn2Down>:popup-menu(vtMenu) \n\
6099 ! @Num_Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
6100 ~Ctrl ~Meta <Btn2Down>:ignore() \n\
6101 Meta <Btn2Down>:clear-saved-lines() \n\
6102 ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0) \n\
6103 !Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
6104 !Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
6105 !Lock Ctrl @Num_Lock <Btn3Down>:popup-menu(fontMenu) \n\
6106 ! @Num_Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
6107 ~Ctrl ~Meta <Btn3Down>:start-extend() \n\
6108 ~Meta <Btn3Motion>:select-extend() \n\
6109 Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6110 Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6111 Lock @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6112 @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6113 <Btn4Down>:scroll-back(5,line,m) \n\
6114 Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6115 Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6116 Lock @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6117 @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6118 <Btn5Down>:scroll-forw(5,line,m) \n\
6119 <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n\
6120 <BtnDown>:ignore()
6121 The default bindings in the Tektronix window are analogous but less
6123 extensive. These are for the tek4014 widget:
6124 ~Meta<KeyPress>: insert-seven-bit() \n\
6126 Meta<KeyPress>: insert-eight-bit() \n\
6127 !Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
6128 !Lock Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
6129 !Lock Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
6130 !Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
6131 !Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
6132 !Lock Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
6133 !Lock Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
6134 !Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
6135 Shift ~Meta<Btn1Down>: gin-press(L) \n\
6136 ~Meta<Btn1Down>: gin-press(l) \n\
6137 Shift ~Meta<Btn2Down>: gin-press(M) \n\
6138 ~Meta<Btn2Down>: gin-press(m) \n\
6139 Shift ~Meta<Btn3Down>: gin-press(R) \n\
6140 ~Meta<Btn3Down>: gin-press(r)
6141 Custom Key Bindings
6143 You can modify the translations resource by overriding parts of it, or
6144 merging your resources with it.
6145 Here is an example which uses shifted select/paste to copy to the
6147 clipboard, and unshifted select/paste for the primary selection. In
6148 each case, a (different) cut buffer is also a target or source of the
6149 select/paste operation. It is important to remember however, that cut
6150 buffers store data in ISO-8859-1 encoding, while selections can store
6151 data in a variety of formats and encodings. While xterm owns the
6152 selection, it highlights it. When it loses the selection, it removes
6153 the corresponding highlight. But you can still paste from the
6154 corresponding cut buffer.
6155 *VT100*translations: #override \n\
6157 ~Shift~Ctrl<Btn2Up>: insert-selection(PRIMARY, CUT_BUFFER0) \n\
6158 Shift~Ctrl<Btn2Up>: insert-selection(CLIPBOARD, CUT_BUFFER1) \n\
6159 ~Shift <BtnUp> : select-end(PRIMARY, CUT_BUFFER0) \n\
6160 Shift <BtnUp> : select-end(CLIPBOARD, CUT_BUFFER1)
6161 In the example, the class name VT100 is used rather than the widget
6163 name. These are different; a class name could apply to more than one
6164 widget. A leading “*” is used because the widget hierarchy above the
6165 vt100 widget depends on whether the toolbar support is compiled into
6166 xterm.
6167 Most of the predefined translations are related to the mouse, with a
6169 few that use some of the special keys on the keyboard. Applications
6170 use special keys (function-keys, cursor-keys, keypad-keys) with
6171 modifiers (shift, control, alt). If xterm defines a translation for a
6172 given combination of special key and modifier, that makes it
6173 unavailable for use by applications within the terminal. For instance,
6174 one might extend the use of Page Up and Page Down keys seen here:
6175 Shift <KeyPress> Prior : scroll-back(1,halfpage) \n\
6177 Shift <KeyPress> Next : scroll-forw(1,halfpage) \n\
6178 to the Home and End keys:
6180 Shift <KeyPress> Home : scroll-to(begin) \n\
6182 Shift <KeyPress> End : scroll-to(end)
6183 but then shift-Home and shift-End would then be unavailable to
6185 applications.
6186 Not everyone finds the three-button mouse bindings easy to use. In a
6188 wheel mouse, the middle button might be the wheel. As an alternative,
6189 you could add a binding using shifted keys:
6190 *VT100*translations: #override \n\
6192 Shift <Key>Home: copy-selection(SELECT) \n\
6193 Shift <Key>Insert: copy-selection(SELECT) \n\
6194 Ctrl Shift <Key>C: copy-selection(SELECT) \n\
6195 Ctrl Shift <Key>V: insert-selection(SELECT)
6196 You would still use the left- and right-mouse buttons (typically 1 and
6198 3) for beginning and extending selections.
6199 Besides mouse problems, there are also keyboards with inconvenient
6201 layouts. Some lack a numeric keypad, making it hard to use the shifted
6202 keypad plus and minus bindings for switching between font sizes. You
6203 can work around that by assigning the actions to more readily accessed
6204 keys:
6205 *VT100*translations: #override \n\
6207 Ctrl <Key> +: larger-vt-font() \n\
6208 Ctrl <Key> -: smaller-vt-font()
6209 The keymap feature allows you to switch between sets of translations.
6211 The sample below shows how the keymap() action may be used to add
6212 special keys for entering commonly-typed words:
6213 *VT100.Translations: #override <Key>F13: keymap(dbx)
6215 *VT100.dbxKeymap.translations: \
6216 <Key>F14: keymap(None) \n\
6217 <Key>F17: string("next") \n\
6218 string(0x0d) \n\
6219 <Key>F18: string("step") \n\
6220 string(0x0d) \n\
6221 <Key>F19: string("continue") \n\
6222 string(0x0d) \n\
6223 <Key>F20: string("print ") \n\
6224 insert-selection(PRIMARY, CUT_BUFFER0)
6225 Default Scrollbar Bindings
6227 Key bindings are normally associated with the vt100 or tek4014 widgets
6228 which act as terminal emulators. Xterm's scrollbar (and toolbar if it
6229 is configured) are separate widgets. Because all of these use the X
6230 Toolkit, they have corresponding translations resources. Those
6231 resources are distinct, and match different patterns, e.g., the
6232 differences in widget-name and number of levels of widgets which they
6233 may contain.
6234 The scrollbar widget is a child of the vt100 widget. It is positioned
6236 on top of the vt100 widget. Toggling the scrollbar on and off causes
6237 the vt100 widget to resize.
6238 The default bindings for the scrollbar widget use only mouse-button
6240 events:
6241 <Btn5Down>: StartScroll(Forward) \n\
6243 <Btn1Down>: StartScroll(Forward) \n\
6244 <Btn2Down>: StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
6245 <Btn3Down>: StartScroll(Backward) \n\
6246 <Btn4Down>: StartScroll(Backward) \n\
6247 <Btn2Motion>: MoveThumb() NotifyThumb() \n\
6248 <BtnUp>: NotifyScroll(Proportional) EndScroll()
6249 Events which the scrollbar widget does not recognize at all are lost.
6251 However, at startup, xterm augments these translations with the default
6253 translations used for the vt100 widget, together with the resource
6254 “actions” which those translations use. Because the scrollbar (or
6255 menubar) widgets do not recognize these actions (but because it has a
6256 corresponding translation), they are passed on to the vt100 widget.
6257 This augmenting of the scrollbar's translations has a few limitations:
6259 · Xterm knows what the default translations are, but there is no
6261 suitable library interface for determining what customizations a
6262 user may have added to the vt100 widget. All that xterm can do is
6263 augment the scrollbar widget to give it the same starting point for
6264 further customization by the user.
6265 · Events in the gap between the widgets may be lost.
6267 · Compose sequences begun in one widget cannot be completed in the
6269 other, because the input methods for each widget do not share
6270 context information.
6271 Most customizations of the scrollbar translations do not concern key
6273 bindings. Rather, users are generally more interested in changing the
6274 bindings of the mouse buttons. For example, some people prefer using
6275 the left pointer button for dragging the scrollbar thumb. That can be
6276 set up by altering the translations resource, e.g.,
6277 *VT100.scrollbar.translations: #override \n\
6279 <Btn5Down>: StartScroll(Forward) \n\
6280 <Btn1Down>: StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
6281 <Btn4Down>: StartScroll(Backward) \n\
6282 <Btn1Motion>: MoveThumb() NotifyThumb() \n\
6283 <BtnUp>: NotifyScroll(Proportional) EndScroll()
6284
6286 Applications can send sequences of characters to the terminal to change
6287 its behavior. Often they are referred to as “ANSI escape sequences” or
6288 just plain “escape sequences” but both terms are misleading:
6289 · ANSI x3.64 (obsolete) which was replaced by ISO 6429 (ECMA-48) gave
6291 rules for the format of these sequences of characters.
6292 · While the original VT100 was claimed to be ANSI-compatible (against
6294 x3.64), there is no freely available version of the ANSI standard
6295 to show where the VT100 differs. Most of the documents which
6296 mention the ANSI standard have additions not found in the original
6297 (such as those based on ansi.sys). So this discussion focuses on
6298 the ISO standards.
6299 · The standard describes only sequences sent from the host to the
6301 terminal. There is no standard for sequences sent by special keys
6302 from the terminal to the host. By convention (and referring to
6303 existing terminals), the format of those sequences usually conforms
6304 to the host-to-terminal standard.
6305 · Some of xterm's sequences do not fit into the standard scheme.
6307 Technically those are “unspecified”. As an example, DEC Screen
6308 Alignment Test (DECALN) is this three-character sequence:
6309 ESC # 8
6311 · Some sequences fit into the standard format, but are not listed in
6313 the standard. These include the sequences used for setting up
6314 scrolling margins and doing forward/reverse scrolling.
6315 · Some of the sequences (in particular, the single-character
6317 functions such as tab and backspace) do not include the escape
6318 character.
6319 With all of that in mind, the standard refers to these sequences of
6321 characters as “control sequences”.
6322 Xterm Control Sequences lists the control sequences which an
6324 application can send xterm to make it perform various operations. Most
6325 of these operations are standardized, from either the DEC or Tektronix
6326 terminals, or from more widely used standards such as ISO-6429.
6327 A few examples of usage are given in this section.
6329 Window and Icon Titles
6331 Some scripts use echo with options -e and -n to tell the shell to
6332 interpret the string “\e” as the escape character and to suppress a
6333 trailing newline on output. Those are not portable, nor recommended.
6334 Instead, use printf (POSIX).
6335 For example, to set the window title to “Hello world!”, you could use
6337 one of these commands in a script:
6338 printf '\033]2;Hello world!\033\'
6340 printf '\033]2;Hello world!\007'
6341 printf '\033]2;%s\033\' "Hello world!"
6342 printf '\033]2;%s\007' "Hello world!"
6343 The printf command interprets the octal value “\033” for escape, and
6345 (since it was not given in the format) omits a trailing newline from
6346 the output.
6347 Some programs (such as screen(1)) set both window- and icon-titles at
6349 the same time, using a slightly different control sequence:
6350 printf '\033]0;Hello world!\033\'
6352 printf '\033]0;Hello world!\007'
6353 printf '\033]0;%s\033\' "Hello world!"
6354 printf '\033]0;%s\007' "Hello world!"
6355 The difference is the parameter “0” in each command. Most window
6357 managers will honor either window title or icon title. Some will make
6358 a distinction and allow you to set just the icon title. You can tell
6359 xterm to ask for this with a different parameter in the control
6360 sequence:
6361 printf '\033]1;Hello world!\033\'
6363 printf '\033]1;Hello world!\007'
6364 printf '\033]1;%s\033\' "Hello world!"
6365 printf '\033]1;%s\007' "Hello world!"
6366 Special Keys
6368 Xterm, like any VT100-compatible terminal emulator, has two modes for
6369 the special keys (cursor-keys, numeric keypad, and certain function-
6370 keys):
6371 · normal mode, which makes the special keys transmit “useful”
6373 sequences such as the control sequence for cursor-up when pressing
6374 the up-arrow, and
6375 · application mode, which uses a different control sequence that
6377 cannot be mistaken for the “useful” sequences.
6378 The main difference between the two modes is that normal mode sequences
6380 start with CSI (escape [) and application mode sequences start with SS3
6381 (escape O).
6382 The terminal is initialized into one of these two modes (usually the
6384 normal mode), based on the terminal description (termcap or terminfo).
6385 The terminal description also has capabilities (strings) defined for
6386 the keypad mode used in curses applications.
6387 There is a problem in using the terminal description for applications
6389 that are not intended to be full-screen curses applications: the
6390 definitions of special keys are only correct for this keypad mode. For
6391 example, some shells (unlike ksh(1), which appears to be hard-coded,
6392 not even using termcap) allow their users to customize key-bindings,
6393 assigning shell actions to special keys.
6394 · bash(1) allows constant strings to be assigned to functions. This
6396 is only successful if the terminal is initialized to application
6397 mode by default, because bash lacks flexibility in this area. It
6398 uses a (less expressive than bash's) readline scripting language
6399 for setting up key bindings, which relies upon the user to
6400 statically enumerate the possible bindings for given values of
6401 $TERM.
6402 · zsh(1) provides an analogous feature, but it accepts runtime
6404 expressions, as well as providing a $terminfo array for scripts.
6405 In particular, one can use the terminal database, transforming when
6406 defining a key-binding. By transforming the output so that CSI and
6407 SS3 are equated, zsh can use the terminal database to obtain useful
6408 definitions for its command-line use regardless of whether the
6409 terminal uses normal or application mode initially. Here is an
6410 example:
6411 [[ "$terminfo[kcuu1]" == "^[O"* ]] && \
6413 bindkey -M viins "${terminfo[kcuu1]/O/[}" \
6414 vi-up-line-or-history
6415 Changing Colors
6417 A few shell programs provide the ability for users to add color and
6418 other video attributes to the shell prompt strings. Users can do this
6419 by setting $PS1 (the primary prompt string). Again, bash and zsh have
6420 provided features not found in ksh. There is a problem, however: the
6421 prompt's width on the screen will not necessarily be the same as the
6422 number of characters. Because there is no guidance in the POSIX
6423 standard, each shell addresses the problem in a different way:
6424 · bash treats characters within “\[” and “\]” as nonprinting (using
6426 no width on the screen).
6427 · zsh treats characters within “%{” and “%}” as nonprinting.
6429 In addition to the difference in syntax, the shells provide different
6431 methods for obtaining useful escape sequences:
6432 · As noted in Special Keys, zsh initializes the $terminfo array with
6434 the terminal capabilities.
6435 It also provides a function echoti which works like tput(1) to
6437 convert a terminal capability with its parameters into a string
6438 that can be written to the terminal.
6439 · Shells lacking a comparable feature (such as bash) can always use
6441 the program tput to do this transformation.
6442 Hard-coded escape sequences are supported by each shell, but are not
6444 recommended because those rely upon particular configurations and
6445 cannot be easily moved between different user environments.
6446
6448 Xterm sets several environment variables.
6449 System Independent
6451 Some variables are used on every system:
6452 DISPLAY
6454 is the display name, pointing to the X server (see DISPLAY NAMES
6455 in X(7)).
6456 TERM
6458 is set according to the terminfo (or termcap) entry which it is
6459 using as a reference.
6460 On some systems, you may encounter situations where the shell
6462 which you use and xterm are built using libraries with different
6463 terminal databases. In that situation, xterm may choose a
6464 terminal description not known to the shell.
6465 WINDOWID
6467 is set to the X window id number of the xterm window.
6468 XTERM_FILTER
6470 is set if a locale-filter is used. The value is the pathname of
6471 the filter.
6472 XTERM_LOCALE
6474 shows the locale which was used by xterm on startup. Some shell
6475 initialization scripts may set a different locale.
6476 XTERM_SHELL
6478 is set to the pathname of the program which is invoked. Usually
6479 that is a shell program, e.g., /bin/sh. Since it is not
6480 necessarily a shell program however, it is distinct from “SHELL”.
6481 XTERM_VERSION
6483 is set to the string displayed by the -version option. That is
6484 normally an identifier for the X Window libraries used to build
6485 xterm, followed by xterm's patch number in parenthesis. The patch
6486 number is also part of the response to a Secondary Device
6487 Attributes (DA) control sequence (see Xterm Control Sequences).
6488 System Dependent
6490 Depending on your system configuration, xterm may also set the
6491 following:
6492 COLUMNS
6494 the width of the xterm in characters (cf: “stty columns”).
6495 When this variable is set, curses applications (and most terminal
6497 programs) will assume that the terminal has this many columns.
6498 Xterm would do this for systems which have no ability to tell the
6500 size of the terminal. Those are very rare, none newer than the
6501 mid 1990s when SVR4 became prevalent.
6502 HOME
6504 when xterm is configured (at build-time) to update utmp.
6505 LINES
6507 the height of the xterm in characters (cf: “stty rows”).
6508 When this variable is set, curses applications (and most terminal
6510 programs) will assume that the terminal has this many lines
6511 (rows).
6512 Xterm would do this for systems which have no ability to tell the
6514 size of the terminal. Those are very rare, none newer than the
6515 mid 1990s when SVR4 became prevalent.
6516 LOGNAME
6518 when xterm is configured (at build-time) to update utmp.
6519 Your configuration may have set LOGNAME; xterm does not modify
6521 that. If it is unset, xterm will use USER if it is set. Finally,
6522 if neither is set, xterm will use the getlogin(2) function.
6523 SHELL
6525 when xterm is configured (at build-time) to update utmp. It is
6526 also set if you provide a valid shell name as the optional
6527 parameter.
6528 Xterm sets this to an absolute pathname. If you have set the
6530 variable to a relative pathname, xterm may set it to a different
6531 shell pathname.
6532 If you have set this to an pathname which does not correspond to a
6534 valid shell, xterm may unset it, to avoid confusion.
6535 TERMCAP
6537 the contents of the termcap entry corresponding to $TERM, with
6538 lines and columns values substituted for the actual size window
6539 you have created.
6540 This feature is, like LINES and COLUMNS, used rarely. It
6542 addresses the same limitation of a few older systems by providing
6543 a way for termcap-based applications to get the initial
6544 screensize.
6545 TERMINFO
6547 may be defined to a nonstandard location using the configure
6548 script.
6549
6551 The actual pathnames given may differ on your system.
6552 /etc/shells
6554 contains a list of valid shell programs, used by xterm to decide
6555 if the “SHELL” environment variable should be set for the process
6556 started by xterm.
6557 On systems which have the getusershell function, xterm will use
6559 that function rather than directly reading the file, since the
6560 file may not be present if the system uses default settings.
6561 /etc/utmp
6563 the system logfile, which records user logins.
6564 /etc/wtmp
6566 the system logfile, which records user logins and logouts.
6567 /usr/share/X11/app-defaults/XTerm
6569 the xterm default application resources.
6570 /usr/share/X11/app-defaults/XTerm-color
6572 the xterm color application resources. If your display supports
6573 color, use this
6574 *customization: -color
6576 in your .Xdefaults file to automatically use this resource file
6578 rather than /usr/share/X11/app-defaults/XTerm. If you do not do
6579 this, xterm uses its compiled-in default resource settings for
6580 colors.
6581 /usr/share/pixmaps
6583 the directory in which xterm's pixmap icon files are installed.
6584
6586 Most of the fatal error messages from xterm use the following format:
6587 xterm: Error XXX, errno YYY: ZZZ
6589 The XXX codes (which are used by xterm as its exit-code) are listed
6591 below, with a brief explanation.
6592 1 is used for miscellaneous errors, usually accompanied by a
6594 specific message,
6595 11 ERROR_FIONBIO
6597 main: ioctl() failed on FIONBIO
6598 12 ERROR_F_GETFL
6600 main: ioctl() failed on F_GETFL
6601 13 ERROR_F_SETFL
6603 main: ioctl() failed on F_SETFL
6604 14 ERROR_OPDEVTTY
6606 spawn: open() failed on /dev/tty
6607 15 ERROR_TIOCGETP
6609 spawn: ioctl() failed on TIOCGETP
6610 17 ERROR_PTSNAME
6612 spawn: ptsname() failed
6613 18 ERROR_OPPTSNAME
6615 spawn: open() failed on ptsname
6616 19 ERROR_PTEM
6618 spawn: ioctl() failed on I_PUSH/"ptem"
6619 20 ERROR_CONSEM
6621 spawn: ioctl() failed on I_PUSH/"consem"
6622 21 ERROR_LDTERM
6624 spawn: ioctl() failed on I_PUSH/"ldterm"
6625 22 ERROR_TTCOMPAT
6627 spawn: ioctl() failed on I_PUSH/"ttcompat"
6628 23 ERROR_TIOCSETP
6630 spawn: ioctl() failed on TIOCSETP
6631 24 ERROR_TIOCSETC
6633 spawn: ioctl() failed on TIOCSETC
6634 25 ERROR_TIOCSETD
6636 spawn: ioctl() failed on TIOCSETD
6637 26 ERROR_TIOCSLTC
6639 spawn: ioctl() failed on TIOCSLTC
6640 27 ERROR_TIOCLSET
6642 spawn: ioctl() failed on TIOCLSET
6643 28 ERROR_INIGROUPS
6645 spawn: initgroups() failed
6646 29 ERROR_FORK
6648 spawn: fork() failed
6649 30 ERROR_EXEC
6651 spawn: exec() failed
6652 32 ERROR_PTYS
6654 get_pty: not enough ptys
6655 34 ERROR_PTY_EXEC
6657 waiting for initial map
6658 35 ERROR_SETUID
6660 spawn: setuid() failed
6661 36 ERROR_INIT
6663 spawn: can't initialize window
6664 46 ERROR_TIOCKSET
6666 spawn: ioctl() failed on TIOCKSET
6667 47 ERROR_TIOCKSETC
6669 spawn: ioctl() failed on TIOCKSETC
6670 49 ERROR_LUMALLOC
6672 luit: command-line malloc failed
6673 50 ERROR_SELECT
6675 in_put: select() failed
6676 54 ERROR_VINIT
6678 VTInit: can't initialize window
6679 57 ERROR_KMMALLOC1
6681 HandleKeymapChange: malloc failed
6682 60 ERROR_TSELECT
6684 Tinput: select() failed
6685 64 ERROR_TINIT
6687 TekInit: can't initialize window
6688 71 ERROR_BMALLOC2
6690 SaltTextAway: malloc() failed
6691 80 ERROR_LOGEXEC
6693 StartLog: exec() failed
6694 83 ERROR_XERROR
6696 xerror: XError event
6697 84 ERROR_XIOERROR
6699 xioerror: X I/O error
6700 85 ERROR_ICEERROR
6702 ICE I/O error
6703 90 ERROR_SCALLOC
6705 Alloc: calloc() failed on base
6706 91 ERROR_SCALLOC2
6708 Alloc: calloc() failed on rows
6709 102 ERROR_SAVE_PTR
6711 ScrnPointers: malloc/realloc() failed
6712
6714 Large pastes do not work on some systems. This is not a bug in xterm;
6715 it is a bug in the pseudo terminal driver of those systems. Xterm
6716 feeds large pastes to the pty only as fast as the pty will accept data,
6717 but some pty drivers do not return enough information to know if the
6718 write has succeeded.
6719 When connected to an input method, it is possible for xterm to hang if
6721 the XIM server is suspended or killed.
6722 Many of the options are not resettable after xterm starts.
6724 This program still needs to be rewritten. It should be split into very
6726 modular sections, with the various emulators being completely separate
6727 widgets that do not know about each other. Ideally, you'd like to be
6728 able to pick and choose emulator widgets and stick them into a single
6729 control widget.
6730 There needs to be a dialog box to allow entry of the Tek COPY file
6732 name.
6733
6735 resize(1), luit(1), uxterm(1), X(7), pty(4), tty(4)
6736 Xterm Control Sequences (this is the file ctlseqs.ms).
6738 https://invisible-island.net/xterm/xterm.html
6740 https://invisible-island.net/xterm/manpage/xterm.html
6741 https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
6742 https://invisible-island.net/xterm/xterm.faq.html
6743 https://invisible-island.net/xterm/xterm.log.html
6744
6746 Far too many people.
6747 These contributed to the X Consortium: Loretta Guarino Reid (DEC-UEG-
6749 WSL), Joel McCormack (DEC-UEG-WSL), Terry Weissman (DEC-UEG-WSL),
6750 Edward Moy (Berkeley), Ralph R. Swick (MIT-Athena), Mark Vandevoorde
6751 (MIT-Athena), Bob McNamara (DEC-MAD), Jim Gettys (MIT-Athena), Bob
6752 Scheifler (MIT X Consortium), Doug Mink (SAO), Steve Pitschke
6753 (Stellar), Ron Newman (MIT-Athena), Jim Fulton (MIT X Consortium), Dave
6754 Serisky (HP), Jonathan Kamens (MIT-Athena).
6755 Beginning with XFree86, there were far more identifiable contributors.
6757 The THANKS file in xterm's source lists 189 at the end of 2017. Keep
6758 in mind these: Jason Bacon, Jens Schweikhardt, Ross Combs, Stephen P.
6759 Wall, David Wexelblat, and Thomas Dickey (invisible-island.net).
6760Patch #334 2018-08-12 XTERM(1)