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 bitmap 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 “true”.
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 on text cursor blinking. This overrides the cursorBlink
296 resource.
297 +bc turn off 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 X Toolkit sets the WM_CLASS property using the instance name
345 and this class value.
346 -cm This option disables recognition of ANSI color-change escape
348 sequences. It sets the colorMode resource to “false”.
349 +cm This option enables recognition of ANSI color-change escape
351 sequences. This is the same as the vt100 resource colorMode.
352 -cn This option indicates that newlines should not be cut in line-
354 mode selections. It sets the cutNewline resource to “false”.
355 +cn This option indicates that newlines should be cut in line-mode
357 selections. It sets the cutNewline resource to “true”.
358 -cr color
360 This option specifies the color to use for text cursor. The
361 default is to use the same foreground color that is used for
362 text. It sets the cursorColor resource according to the
363 parameter.
364 -cu This option indicates that xterm should work around a bug in
366 the more(1) program that causes it to incorrectly display lines
367 that are exactly the width of the window and are followed by a
368 line beginning with a tab (the leading tabs are not displayed).
369 This option is so named because it was originally thought to be
370 a bug in the curses(3x) cursor motion package.
371 +cu This option indicates that xterm should not work around the
373 more(1) bug mentioned above.
374 -dc This option disables the escape sequence to change dynamic
376 colors: the vt100 foreground and background colors, its text
377 cursor color, the pointer cursor foreground and background
378 colors, the Tektronix emulator foreground and background
379 colors, its text cursor color and highlight color. The option
380 sets the dynamicColors option to “false”.
381 +dc This option enables the escape sequence to change dynamic
383 colors. The option sets the dynamicColors option to “true”.
384 -e program [ arguments ... ]
386 This option specifies the program (and its command line
387 arguments) to be run in the xterm window. It also sets the
388 window title and icon name to be the basename of the program
389 being executed if neither -T nor -n are given on the command
390 line.
391 NOTE: This must be the last option on the command line.
393 -en encoding
395 This option determines the encoding on which xterm runs. It
396 sets the locale resource. Encodings other than UTF-8 are
397 supported by using luit. The -lc option should be used instead
398 of -en for systems with locale support.
399 -fa pattern
401 This option sets the pattern for fonts selected from the
402 FreeType library if support for that library was compiled into
403 xterm. This corresponds to the faceName resource. When a CJK
404 double-width font is specified, you also need to turn on the
405 cjkWidth resource.
406 If you specify both -fa and the X Toolkit option -fn, the -fa
408 setting overrides the latter.
409 See also the renderFont resource, which combines with this to
411 determine whether FreeType fonts are initially active.
412 -fb font
414 This option specifies a font to be used when displaying bold
415 text. It sets the boldFont resource.
416 This font must be the same height and width as the normal font,
418 otherwise it is ignored. If only one of the normal or bold
419 fonts is specified, it will be used as the normal font and the
420 bold font will be produced by overstriking this font.
421 See also the discussion of boldMode and alwaysBoldMode
423 resources.
424 -fbb This option indicates that xterm should compare normal and bold
426 fonts bounding boxes to ensure they are compatible. It sets
427 the freeBoldBox resource to “false”.
428 +fbb This option indicates that xterm should not compare normal and
430 bold fonts bounding boxes to ensure they are compatible. It
431 sets the freeBoldBox resource to “true”.
432 -fbx This option indicates that xterm should not assume that the
434 normal and bold fonts have VT100 line-drawing characters. If
435 any are missing, xterm will draw the characters directly. It
436 sets the forceBoxChars resource to “false”.
437 +fbx This option indicates that xterm should assume that the normal
439 and bold fonts have VT100 line-drawing characters. It sets the
440 forceBoxChars resource to “true”.
441 -fc fontchoice
443 Specify the initial font chosen from the font menu. The option
444 value corresponds to the initialFont resource.
445 -fd pattern
447 This option sets the pattern for double-width fonts selected
448 from the FreeType library if support for that library was
449 compiled into xterm. This corresponds to the
450 faceNameDoublesize resource.
451 -fi font
453 This option sets the font for active icons if that feature was
454 compiled into xterm.
455 See also the discussion of the iconFont resource.
457 -fs size
459 This option sets the pointsize for fonts selected from the
460 FreeType library if support for that library was compiled into
461 xterm. This corresponds to the faceSize resource.
462 -fullscreen
464 This option indicates that xterm should ask the window manager
465 to let it use the full-screen for display, e.g., without window
466 decorations. It sets the fullscreen resource to “true”.
467 +fullscreen
469 This option indicates that xterm should not ask the window
470 manager to let it use the full-screen for display. It sets the
471 fullscreen resource to “false”.
472 -fw font
474 This option specifies the font to be used for displaying wide
475 text. By default, it will attempt to use a font twice as wide
476 as the font that will be used to draw normal text. If no
477 double-width font is found, it will improvise, by stretching
478 the normal font. This corresponds to the wideFont resource.
479 -fwb font
481 This option specifies the font to be used for displaying bold
482 wide text. By default, it will attempt to use a font twice as
483 wide as the font that will be used to draw bold text. If no
484 double-width font is found, it will improvise, by stretching
485 the bold font. This corresponds to the wideBoldFont resource.
486 -fx font
488 This option specifies the font to be used for displaying the
489 preedit string in the “OverTheSpot” input method.
490 See also the discussion of the ximFont resource.
492 -hc color
494 (see -selbg).
495 -hf This option indicates that HP function key escape codes should
497 be generated for function keys. It sets the hpFunctionKeys
498 resource to “true”.
499 +hf This option indicates that HP function key escape codes should
501 not be generated for function keys. It sets the hpFunctionKeys
502 resource to “false”.
503 -hm Tells xterm to use highlightTextColor and highlightColor to
505 override the reversed foreground/background colors in a
506 selection. It sets the highlightColorMode resource to “true”.
507 +hm Tells xterm not to use highlightTextColor and highlightColor to
509 override the reversed foreground/background colors in a
510 selection. It sets the highlightColorMode resource to “false”.
511 -hold Turn on the hold resource, i.e., xterm will not immediately
513 destroy its window when the shell command completes. It will
514 wait until you use the window manager to destroy/kill the
515 window, or if you use the menu entries that send a signal,
516 e.g., HUP or KILL.
517 +hold Turn off the hold resource, i.e., xterm will immediately
519 destroy its window when the shell command completes.
520 -ie Turn on the ptyInitialErase resource, i.e., use the pseudo-
522 terminal's sense of the stty erase value.
523 +ie Turn off the ptyInitialErase resource, i.e., set the stty erase
525 value using the kb string from the termcap entry as a
526 reference, if available.
527 -im Turn on the useInsertMode resource, which forces use of insert
529 mode by adding appropriate entries to the TERMCAP environment
530 variable. (This option is ignored on most systems, because
531 TERMCAP is not used).
532 +im Turn off the useInsertMode resource.
534 -into windowId
536 Given an X window identifier (an integer, which can be
537 hexadecimal, octal or decimal according to whether it begins
538 with "0x", "0" or neither), xterm will reparent its top-level
539 shell widget to that window. This is used to embed xterm
540 within other applications.
541 For instance, there are scripts for Tcl/Tk and Gtk which can be
543 used to demonstrate the feature. When using Gtk, there is a
544 limitation of that toolkit which requires that xterm's
545 allowSendEvents resource is enabled.
546 -itc Set the vt100 resource colorITMode to “false”, disabling the
548 display of characters with italic attribute as color.
549 +itc Set the vt100 resource colorITMode to “true”, enabling the
551 display of characters with italic attribute as color rather
552 than italic.
553 -j This option indicates that xterm should do jump scrolling. It
555 corresponds to the jumpScroll resource. Normally, text is
556 scrolled one line at a time; this option allows xterm to move
557 multiple lines at a time so that it does not fall as far
558 behind. Its use is strongly recommended since it makes xterm
559 much faster when scanning through large amounts of text. The
560 VT100 escape sequences for enabling and disabling smooth scroll
561 as well as the VT Options menu can be used to turn this feature
562 on or off.
563 +j This option indicates that xterm should not do jump scrolling.
565 -k8 This option sets the allowC1Printable resource. When
567 allowC1Printable is set, xterm overrides the mapping of C1
568 control characters (code 128–159) to treat them as printable.
569 +k8 This option resets the allowC1Printable resource.
571 -kt keyboardtype
573 This option sets the keyboardType resource. Possible values
574 include: “unknown”, “default”, “legacy”, “hp”, “sco”, “sun”,
575 “tcap” and “vt220”.
576 The value “unknown”, causes the corresponding resource to be
578 ignored.
579 The value “default”, suppresses the associated resources
581 hpFunctionKeys,
583 scoFunctionKeys,
584 sunFunctionKeys,
585 tcapFunctionKeys,
586 oldXtermFKeys and
587 sunKeyboard,
588 using the Sun/PC keyboard layout.
590 -l Turn logging on, unless disabled by the logInhibit resource.
592 Some versions of xterm may have logging enabled. However,
594 normally logging is not supported, due to security concerns in
595 the early 1990s. That was a problem in X11R4 xterm (1989)
596 which was addressed by a patch to X11R5 late in 1993. X11R6
597 included these fixes. The older version (when running with
598 root privilege) would create the log file using root privilege.
599 The reason why xterm ran with root privileges was to open
600 pseudo-terminals. Those privileges are now needed only on very
601 old systems: Unix98 pseudo-terminals made the BSD scheme
602 unnecessary.
603 Unless overridden by the -lf option or the logFile resource:
605 · If the filename is “-”, then logging is sent to the
607 standard output.
608 · Otherwise a filename is generated, and the log file is
610 written to the directory from which xterm is invoked.
611 · The generated filename is of the form
613 XtermLog.XXXXXX
615 or
617 Xterm.log.hostname.yyyy.mm.dd.hh.mm.ss.XXXXXX
619 depending on how xterm was built.
621 +l Turn logging off.
623 -lc Turn on support of various encodings according to the users'
625 locale setting, i.e., LC_ALL, LC_CTYPE, or LANG environment
626 variables. This is achieved by turning on UTF-8 mode and by
627 invoking luit for conversion between locale encodings and
628 UTF-8. (luit is not invoked in UTF-8 locales.) This
629 corresponds to the locale resource.
630 The actual list of encodings which are supported is determined
632 by luit. Consult the luit manual page for further details.
633 See also the discussion of the -u8 option which supports UTF-8
635 locales.
636 +lc Turn off support of automatic selection of locale encodings.
638 Conventional 8bit mode or, in UTF-8 locales or with -u8 option,
639 UTF-8 mode will be used.
640 -lcc path
642 File name for the encoding converter from/to locale encodings
643 and UTF-8 which is used with -lc option or locale resource.
644 This corresponds to the localeFilter resource.
645 -leftbar
647 Force scrollbar to the left side of VT100 screen. This is the
648 default, unless you have set the rightScrollBar resource.
649 -lf filename
651 Specify the log filename. This sets the logFile resource. If
652 set to “-”, xterm writes its log to the standard output. See
653 the -l option.
654 -ls This option indicates that the shell that is started in the
656 xterm window will be a login shell (i.e., the first character
657 of argv[0] will be a dash, indicating to the shell that it
658 should read the user's .login or .profile).
659 The -ls flag and the loginShell resource are ignored if -e is
661 also given, because xterm does not know how to make the shell
662 start the given command after whatever it does when it is a
663 login shell - the user's shell of choice need not be a Bourne
664 shell after all. Also, xterm -e is supposed to provide a
665 consistent functionality for other applications that need to
666 start text-mode programs in a window, and if loginShell were
667 not ignored, the result of ~/.profile might interfere with
668 that.
669 If you do want the effect of -ls and -e simultaneously, you may
671 get away with something like
672 xterm -e /bin/bash -l -c "my command here"
674 Finally, -ls is not completely ignored, because xterm -ls -e
676 does write a /etc/wtmp entry (if configured to do so), whereas
677 xterm -e does not.
678 +ls This option indicates that the shell that is started should not
680 be a login shell (i.e., it will be a normal “subshell”).
681 -maximized
683 This option indicates that xterm should ask the window manager
684 to maximize its layout on startup. This corresponds to the
685 maximized resource.
686 Maximizing is not the reverse of iconifying; it is possible to
688 do both with certain window managers.
689 +maximized
691 This option indicates that xterm should ask the window manager
692 to not maximize its layout on startup.
693 -mb This option indicates that xterm should ring a margin bell when
695 the user types near the right end of a line.
696 +mb This option indicates that margin bell should not be rung.
698 -mc milliseconds
700 This option specifies the maximum time between multi-click
701 selections.
702 -mesg Turn off the messages resource, i.e., disallow write access to
704 the terminal.
705 +mesg Turn on the messages resource, i.e., allow write access to the
707 terminal.
708 -mk_width
710 Set the mkWidth resource to “true”. This makes xterm use a
711 built-in version of the wide-character width calculation. The
712 default is “false”
713 +mk_width
715 Reset the mkWidth resource.
716 -ms color
718 This option specifies the color to be used for the pointer
719 cursor. The default is to use the foreground color. This sets
720 the pointerColor resource.
721 -nb number
723 This option specifies the number of characters from the right
724 end of a line at which the margin bell, if enabled, will ring.
725 The default is “10”.
726 -nul This option disables the display of underlining.
728 +nul This option enables the display of underlining.
730 -pc This option enables the PC-style use of bold colors (see
732 boldColors resource).
733 +pc This option disables the PC-style use of bold colors.
735 -pf font
737 This option specifies the font to be used for the pointer. The
738 corresponding resource name is pointerFont. The resource value
739 default is cursor.
740 -pob This option indicates that the window should be raised whenever
742 a Control-G is received.
743 +pob This option indicates that the window should not be raised
745 whenever a Control-G is received.
746 -report-charclass
748 Print a report to the standard output showing information about
749 the character-classes which can be altered using the charClass
750 resource.
751 -report-colors
753 Print a report to the standard output showing information about
754 colors as xterm allocates them. This corresponds to the
755 reportColors resource.
756 -report-fonts
758 Print a report to the standard output showing information about
759 fonts which are loaded. This corresponds to the reportFonts
760 resource.
761 -report-icons
763 Print a report to the standard output showing information about
764 pixmap-icons which are loaded. This corresponds to the
765 reportIcons resource.
766 -report-xres
768 Print a report to the standard output showing the values of
769 boolean, numeric or string X resources for the VT100 widget
770 when initialization is complete. This corresponds to the
771 reportXRes resource.
772 -rightbar
774 Force scrollbar to the right side of VT100 screen.
775 -rvc This option disables the display of characters with reverse
777 attribute as color.
778 +rvc This option enables the display of characters with reverse
780 attribute as color.
781 -rw This option indicates that reverse-wraparound should be
783 allowed. This allows the cursor to back up from the leftmost
784 column of one line to the rightmost column of the previous
785 line. This is very useful for editing long shell command lines
786 and is encouraged. This option can be turned on and off from
787 the VT Options menu.
788 +rw This option indicates that reverse-wraparound should not be
790 allowed.
791 -s This option indicates that xterm may scroll asynchronously,
793 meaning that the screen does not have to be kept completely up
794 to date while scrolling. This allows xterm to run faster when
795 network latencies are very high and is typically useful when
796 running across a very large internet or many gateways.
797 +s This option indicates that xterm should scroll synchronously.
799 -samename
801 Does not send title and icon name change requests when the
802 request would have no effect: the name is not changed. This
803 has the advantage of preventing flicker and the disadvantage of
804 requiring an extra round trip to the server to find out the
805 previous value. In practice this should never be a problem.
806 +samename
808 Always send title and icon name change requests.
809 -sb This option indicates that some number of lines that are
811 scrolled off the top of the window should be saved and that a
812 scrollbar should be displayed so that those lines can be
813 viewed. This option may be turned on and off from the VT
814 Options menu.
815 +sb This option indicates that a scrollbar should not be displayed.
817 -selbg color
819 This option specifies the color to use for the background of
820 selected text. If not specified, reverse video is used. See
821 the discussion of the highlightColor resource.
822 -selfg color
824 This option specifies the color to use for selected text. If
825 not specified, reverse video is used. See the discussion of
826 the highlightTextColor resource.
827 -sf This option indicates that Sun function key escape codes should
829 be generated for function keys.
830 +sf This option indicates that the standard escape codes should be
832 generated for function keys.
833 -sh number
835 scale line-height values by the given number. See the
836 discussion of the scaleHeight resource.
837 -si This option indicates that output to a window should not
839 automatically reposition the screen to the bottom of the
840 scrolling region. This option can be turned on and off from
841 the VT Options menu.
842 +si This option indicates that output to a window should cause it
844 to scroll to the bottom.
845 -sk This option indicates that pressing a key while using the
847 scrollbar to review previous lines of text should cause the
848 window to be repositioned automatically in the normal position
849 at the bottom of the scroll region.
850 +sk This option indicates that pressing a key while using the
852 scrollbar should not cause the window to be repositioned.
853 -sl number
855 This option specifies the number of lines to save that have
856 been scrolled off the top of the screen. This corresponds to
857 the saveLines resource. The default is “1024”.
858 -sm This option, corresponding to the sessionMgt resource,
860 indicates that xterm should set up session manager callbacks.
861 +sm This option indicates that xterm should not set up session
863 manager callbacks.
864 -sp This option indicates that Sun/PC keyboard should be assumed,
866 providing mapping for keypad “+” to “,”, and CTRL-F1 to F13,
867 CTRL-F2 to F14, etc.
868 +sp This option indicates that the standard escape codes should be
870 generated for keypad and function keys.
871 -t This option indicates that xterm should start in Tektronix
873 mode, rather than in VTxxx mode. Switching between the two
874 windows is done using the “Options” menus.
875 Terminal database (terminfo (5) or termcap (5)) entries that
877 work with xterm are:
878 “tek4014”,
880 “tek4015”,
881 “tek4012”,
882 “tek4013”,
883 “tek4010”, and
884 “dumb”.
885 Xterm automatically searches the terminal database in this
887 order for these entries and then sets the “TERM” variable (and
888 the “TERMCAP” environment variable, if relevant).
889 +t This option indicates that xterm should start in VTxxx mode.
891 -tb This option, corresponding to the toolBar resource, indicates
893 that xterm should display a toolbar (or menubar) at the top of
894 its window. The buttons in the toolbar correspond to the popup
895 menus, e.g., control/left/mouse for Main Options.
896 +tb This option indicates that xterm should not set up a toolbar.
898 -ti term_id
900 Specify the name used by xterm to select the correct response
901 to terminal ID queries. It also specifies the emulation level,
902 used to determine the type of response to a DA control
903 sequence. Valid values include vt52, vt100, vt101, vt102,
904 vt220, and vt240 (the “vt” is optional). The default is
905 “vt420”. The term_id argument specifies the terminal ID to
906 use. (This is the same as the decTerminalID resource).
907 -tm string
909 This option specifies a series of terminal setting keywords
910 followed by the characters that should be bound to those
911 functions, similar to the stty program. The keywords and their
912 values are described in detail in the ttyModes resource.
913 -tn name
915 This option specifies the name of the terminal type to be set
916 in the TERM environment variable. It corresponds to the
917 termName resource. This terminal type must exist in the
918 terminal database (termcap or terminfo, depending on how xterm
919 is built) and should have li# and co# entries. If the terminal
920 type is not found, xterm uses the built-in list “xterm”,
921 “vt102”, etc.
922 -u8 This option sets the utf8 resource. When utf8 is set, xterm
924 interprets incoming data as UTF-8. This sets the wideChars
925 resource as a side-effect, but the UTF-8 mode set by this
926 option prevents it from being turned off. If you must turn
927 UTF-8 encoding on and off, use the -wc option or the
928 corresponding wideChars resource, rather than the -u8 option.
929 This option and the utf8 resource are overridden by the -lc and
931 -en options and locale resource. That is, if xterm has been
932 compiled to support luit, and the locale resource is not
933 “false” this option is ignored. We recommend using the -lc
934 option or the “locale: true” resource in UTF-8 locales when
935 your operating system supports locale, or -en UTF-8 option or
936 the “locale: UTF-8” resource when your operating system does
937 not support locale.
938 +u8 This option resets the utf8 resource.
940 -uc This option makes the cursor underlined instead of a box.
942 +uc This option makes the cursor a box instead of underlined.
944 -ulc This option disables the display of characters with underline
946 attribute as color rather than with underlining.
947 +ulc This option enables the display of characters with underline
949 attribute as color rather than with underlining.
950 -ulit This option, corresponding to the italicULMode resource,
952 disables the display of characters with underline attribute as
953 italics rather than with underlining.
954 +ulit This option, corresponding to the italicULMode resource,
956 enables the display of characters with underline attribute as
957 italics rather than with underlining.
958 -ut This option indicates that xterm should not write a record into
960 the system utmp log file.
961 +ut This option indicates that xterm should write a record into the
963 system utmp log file.
964 -vb This option indicates that a visual bell is preferred over an
966 audible one. Instead of ringing the terminal bell whenever a
967 Control-G is received, the window will be flashed.
968 +vb This option indicates that a visual bell should not be used.
970 -wc This option sets the wideChars resource.
972 When wideChars is set, xterm maintains internal structures for
974 16-bit characters. If xterm is not started in UTF-8 mode (or
975 if this resource is not set), initially it maintains those
976 structures to support 8-bit characters. Xterm can later be
977 switched, using a menu entry or control sequence, causing it to
978 reallocate those structures to support 16-bit characters.
979 The default is “false”.
981 +wc This option resets the wideChars resource.
983 -wf This option indicates that xterm should wait for the window to
985 be mapped the first time before starting the subprocess so that
986 the initial terminal size settings and environment variables
987 are correct. It is the application's responsibility to catch
988 subsequent terminal size changes.
989 +wf This option indicates that xterm should not wait before
991 starting the subprocess.
992 -ziconbeep percent
994 Same as zIconBeep resource. If percent is non-zero, xterms
995 that produce output while iconified will cause an XBell sound
996 at the given volume and have “***” prepended to their icon
997 titles. Most window managers will detect this change
998 immediately, showing you which window has the output. (A
999 similar feature was in x10 xterm.)
1000 -C This option indicates that this window should receive console
1002 output. This is not supported on all systems. To obtain
1003 console output, you must be the owner of the console device,
1004 and you must have read and write permission for it. If you are
1005 running X under xdm on the console screen you may need to have
1006 the session startup and reset programs explicitly change the
1007 ownership of the console device in order to get this option to
1008 work.
1009 -Sccn This option allows xterm to be used as an input and output
1011 channel for an existing program and is sometimes used in
1012 specialized applications. The option value specifies the last
1013 few letters of the name of a pseudo-terminal to use in slave
1014 mode, plus the number of the inherited file descriptor. If the
1015 option contains a “/” character, that delimits the characters
1016 used for the pseudo-terminal name from the file descriptor.
1017 Otherwise, exactly two characters are used from the option for
1018 the pseudo-terminal name, the remainder is the file descriptor.
1019 Examples (the first two are equivalent since the descriptor
1020 follows the last “/”):
1021 -S/dev/pts/123/45
1023 -S123/45
1024 -Sab34
1025 Note that xterm does not close any file descriptor which it did
1027 not open for its own use. It is possible (though probably not
1028 portable) to have an application which passes an open file
1029 descriptor down to xterm past the initialization or the -S
1030 option to a process running in the xterm.
1031 Old Options
1033 The following command line arguments are provided for compatibility
1034 with older versions. They may not be supported in the next release as
1035 the X Toolkit provides standard options that accomplish the same task.
1036 %geom This option specifies the preferred size and position of the
1038 Tektronix window. It is shorthand for specifying the
1039 “tekGeometry” resource.
1040 #geom This option specifies the preferred position of the icon
1042 window. It is shorthand for specifying the “iconGeometry”
1043 resource.
1044 -T string
1046 This option specifies the title for xterm's windows. It is
1047 equivalent to -title.
1048 -n string
1050 This option specifies the icon name for xterm's windows. It is
1051 shorthand for specifying the “iconName” resource. Note that
1052 this is not the same as the toolkit option -name. The default
1053 icon name is the application name.
1054 If no suitable icon is found, xterm provides a compiled-in
1056 pixmap.
1057 X Toolkit sets the WM_ICON_NAME property using this value.
1059 -r This option indicates that reverse video should be simulated by
1061 swapping the foreground and background colors. It is
1062 equivalent to -rv.
1063 -w number
1065 This option specifies the width in pixels of the border
1066 surrounding the window. It is equivalent to -borderwidth or
1067 -bw.
1068 X Toolkit Options
1070 The following standard X Toolkit command line arguments are commonly
1071 used with xterm:
1072 -bd color
1074 This option specifies the color to use for the border of the
1075 window. The corresponding resource name is borderColor. Xterm
1076 uses the X Toolkit default, which is “XtDefaultForeground”.
1077 Xterm's VT100 window has two borders: the inner border
1079 internalBorder and the outer border borderWidth, managed by the
1080 X Toolkit.
1081 Normally xterm fills the inner border using the VT100 window's
1083 background color. If the colorInnerBorder resource is enabled,
1084 then xterm may fill the inner border using the borderColor
1085 resource.
1086 -bg color
1088 This option specifies the color to use for the background of
1089 the window. The corresponding resource name is background.
1090 The default is “XtDefaultBackground”.
1091 -bw number
1093 This option specifies the width in pixels of the border
1094 surrounding the window.
1095 This appears to be a legacy of older X releases. It sets the
1097 borderWidth resource of the shell widget, and may provide
1098 advice to your window manager to set the thickness of the
1099 window frame. Most window managers do not use this
1100 information. See the -b option, which controls the inner
1101 border of the xterm window.
1102 -display display
1104 This option specifies the X server to contact; see X(7).
1105 -fg color
1107 This option specifies the color to use for displaying text.
1108 The corresponding resource name is foreground. The default is
1109 “XtDefaultForeground”.
1110 -fn font
1112 This option specifies the font to be used for displaying normal
1113 text. The corresponding resource name is font. The resource
1114 value default is fixed.
1115 -font font
1117 This is the same as -fn.
1118 -geometry geometry
1120 This option specifies the preferred size and position of the
1121 VTxxx window; see X(7).
1122 The normal geometry specification can be suffixed with @
1124 followed by a Xinerama screen specification; it can be either g
1125 for the global screen (default), c for the current screen or a
1126 screen number.
1127 -iconic
1129 This option indicates that xterm should ask the window manager
1130 to start it as an icon rather than as the normal window. The
1131 corresponding resource name is iconic.
1132 -name name
1134 This option specifies the application name under which
1135 resources are to be obtained, rather than the default
1136 executable file name. Name should not contain “.” or “*”
1137 characters.
1138 -rv This option indicates that reverse video should be simulated by
1140 swapping the foreground and background colors. The
1141 corresponding resource name is reverseVideo.
1142 +rv Disable the simulation of reverse video by swapping foreground
1144 and background colors.
1145 -title string
1147 This option specifies the window title string, which may be
1148 displayed by window managers if the user so chooses. It is
1149 shorthand for specifying the “title” resource. The default
1150 title is the command line specified after the -e option, if
1151 any, otherwise the application name.
1152 X Toolkit sets the WM_NAME property using this value.
1154 -xrm resourcestring
1156 This option specifies a resource string to be used. This is
1157 especially useful for setting resources that do not have
1158 separate command line options.
1159 X Toolkit accepts alternate names for a few of these options, e.g.,
1161 · “-background” for “-bg”
1163 · “-font” for “-fn”
1165 · “-foreground” for “-fg”
1167 Abbreviated options also are supported, e.g., “-v” for “-version.”
1169
1171 Xterm understands all of the core X Toolkit resource names and classes.
1172 It also uses the X Toolkit resource types (such as booleans, colors,
1173 fonts, integers, and strings) along with their respective converters.
1174 Those resource types are not always sufficient:
1175 · Xterm's resource values may be lists of names. X Toolkit resource
1177 types do not include lists. Xterm uses a string for the resource,
1178 and parses it.
1179 Comma-separated lists of names ignore case.
1181 · Xterm may defer processing a resource until it is needed. For
1183 example, font2 through font7 are loaded as needed, to start faster.
1184 Again, the actual resource type is a string, parsed and used when
1185 needed.
1186 Application specific resources (e.g., “XTerm.NAME”) follow:
1188 Application Resources
1190 backarrowKeyIsErase (class BackarrowKeyIsErase)
1191 Tie the VTxxx backarrowKey and ptyInitialErase resources
1192 together by setting the DECBKM state according to whether the
1193 initial erase character is a backspace (8) or delete (127)
1194 character. A “false” value disables this feature. The default
1195 is “False”.
1196 Here are tables showing how the initial settings for
1198 · backarrowKeyIsErase (BKIE),
1200 · backarrowKey (BK), and
1202 · ptyInitialErase (PIE), along with the
1204 · stty erase character (^H for backspace, ^? for delete)
1206 will affect DECBKM. First, xterm obtains the initial erase
1208 character:
1209 · xterm's internal value is ^H
1211 · xterm asks the operating system for the value which stty
1213 shows
1214 · the ttyModes resource may override erase
1216 · if ptyInitialErase is false, xterm will look in the
1218 terminal database
1219 Summarizing that as a table:
1221 PIE stty termcap erase
1223 ───────────────────────────────
1225 false ^H ^H ^H
1226 false ^H ^? ^?
1227 false ^? ^H ^H
1228 false ^? ^? ^?
1229 true ^H ^H ^H
1230 true ^H ^? ^H
1231 true ^? ^H ^?
1232 true ^? ^? ^?
1233 Using that erase character, xterm allows further choices:
1235 · if backarrowKeyIsErase is true, xterm uses the erase
1237 character for the initial state of DECBKM
1238 · if backarrowKeyIsErase is false, xterm sets DECBKM to 2
1240 (internal). This ties together backarrowKey and the
1241 control sequence for DECBKM.
1242 · applications can send a control sequence to set/reset
1244 DECBKM control set
1245 · the “Backarrow Key (BS/DEL)” menu entry toggles DECBKM
1247 Summarizing the initialization details:
1249 erase BKIE BK DECBKM result
1251 ────────────────────────────────────────
1252 ^? false false 2 ^H
1253 ^? false true 2 ^?
1254 ^? true false 0 ^?
1255 ^? true true 1 ^?
1256 ^H false false 2 ^H
1257 ^H false true 2 ^?
1258 ^H true false 0 ^H
1259 ^H true true 1 ^H
1260 buffered (class Buffered)
1262 Normally xterm is built with double-buffer support. This
1263 resource can be used to turn it on or off. Setting the
1264 resource to “true” turns double-buffering on. The default
1265 value is “False”.
1266 bufferedFPS (class BufferedFPS)
1268 When xterm is built with double-buffer support, this gives the
1269 maximum number of frames/second. The default is “40” and is
1270 limited to the range 1 through 100.
1271 fullscreen (class Fullscreen)
1273 Specifies whether or not xterm should ask the window manager to
1274 use a fullscreen layout on startup. Xterm accepts either a
1275 keyword (ignoring case) or the number shown in parentheses:
1276 false (0)
1278 Fullscreen layout is not used initially, but may be later
1279 via menu-selection or control sequence.
1280 true (1)
1282 Fullscreen layout is used initially, but may be disabled
1283 later via menu-selection or control sequence.
1284 always (2)
1286 Fullscreen layout is used initially, and cannot be disabled
1287 later via menu-selection or control sequence.
1288 never (3)
1290 Fullscreen layout is not used, and cannot be enabled later
1291 via menu-selection or control sequence.
1292 The default is “false”.
1294 hold (class Hold)
1296 If true, xterm will not immediately destroy its window when the
1297 shell command completes. It will wait until you use the window
1298 manager to destroy/kill the window, or if you use the menu
1299 entries that send a signal, e.g., HUP or KILL. You may scroll
1300 back, select text, etc., to perform most graphical operations.
1301 Resizing the display will lose data, however, since this
1302 involves interaction with the shell which is no longer running.
1303 hpFunctionKeys (class HpFunctionKeys)
1305 Specifies whether or not HP function key escape codes should be
1306 generated for function keys. The default is “false”, i.e.,
1307 this feature is disabled.
1308 The keyboardType resource is the preferred mechanism for
1310 selecting this mode.
1311 iconGeometry (class IconGeometry)
1313 Specifies the preferred size and position of the application
1314 when iconified. It is not necessarily obeyed by all window
1315 managers.
1316 iconHint (class IconHint)
1318 Specifies an icon which will be added to the window manager
1319 hints. Xterm provides no default value.
1320 Set this resource to “none” to omit the hint entirely, using
1322 whatever the window manager may decide.
1323 If the iconHint resource is given (or is set via the -n option)
1325 xterm searches for a pixmap file with that name, in the current
1326 directory as well as in /usr/share/pixmaps. if the resource
1327 does not specify an absolute pathname. In each case, xterm
1328 adds “_48x48” and/or “.xpm” to the filename after trying
1329 without those suffixes. If it is able to load the file, xterm
1330 sets the window manager hint for the icon-pixmap. These
1331 pixmaps are distributed with xterm, and can optionally be
1332 compiled-in:
1333 · mini.xterm_16x16, mini.xterm_32x32, mini.xterm_48x48
1335 · filled-xterm_16x16, filled-xterm_32x32, filled-xterm_48x48
1337 · xterm_16x16, xterm_32x32, xterm_48x48
1339 · xterm-color_16x16, xterm-color_32x32, xterm-color_48x48
1341 In either case, xterm allows for adding a “_48x48” to specify
1343 the largest of the pixmaps as a default. That is, “mini.xterm”
1344 is the same as “mini.xterm_48x48”.
1345 If no explicit iconHint resource is given (or if none of the
1347 compiled-in names matches), xterm uses “mini.xterm” (which is
1348 always compiled-in).
1349 The iconHint resource has no effect on “desktop” files,
1351 including “panel” and “menu”. Those are typically set via a
1352 “.desktop” file; xterm provides samples for itself (and the
1353 uxterm script). The more capable desktop systems allow
1354 changing the icon on a per-user basis.
1355 iconName (class IconName)
1357 Specifies a label for xterm when iconified. Xterm provides no
1358 default value; some window managers may assume the application
1359 name, e.g., “xterm”.
1360 Setting the iconName resource sets the icon label unless
1362 overridden by zIconBeep or the control sequences which change
1363 the window and icon labels.
1364 keyboardType (class KeyboardType)
1366 Enables one (or none) of the various keyboard-type resources:
1367 hpFunctionKeys, scoFunctionKeys, sunFunctionKeys,
1368 tcapFunctionKeys, oldXtermFKeys and sunKeyboard.
1369 The resource's value should be one of the corresponding strings
1371 “hp”, “sco”, “sun”, “tcap”, “legacy” or “vt220”, respectively.
1372 The individual resources are provided for legacy support; this
1374 resource is simpler to use. Xterm will use only one keyboard-
1375 type, but if multiple resources are set, it warns and uses the
1376 last one it checks.
1377 The default is “unknown”, i.e., none of the associated
1379 resources are set via this resource.
1380 maxBufSize (class MaxBufSize)
1382 Specify the maximum size of the input buffer. The default is
1383 “32768”. You cannot set this to a value less than the
1384 minBufSize resource. It will be increased as needed to make
1385 that value evenly divide this one.
1386 On some systems you may want to increase one or both of the
1388 maxBufSize and minBufSize resource values to achieve better
1389 performance if the operating system prefers larger buffer
1390 sizes.
1391 maximized (class Maximized)
1393 Specifies whether or not xterm should ask the window manager to
1394 maximize its layout on startup. The default is “false”.
1395 menuHeight (class MenuHeight)
1397 Specifies the height of the toolbar, which may be increased by
1398 the X toolkit layout widget depending upon the fontsize used.
1399 The default is “25”.
1400 menuLocale (class MenuLocale)
1402 Specify the locale used for character-set computations when
1403 loading the popup menus. Use this to improve initialization
1404 performance of the Athena popup menus, which may load
1405 unnecessary (and very large) fonts, e.g., in a locale having
1406 UTF-8 encoding. The default is “C” (POSIX).
1407 To use the current locale (only useful if you have localized
1409 the resource settings for the menu entries), set the resource
1410 to an empty string.
1411 messages (class Messages)
1413 Specifies whether write access to the terminal is allowed
1414 initially. See mesg(1). The default is “true”.
1415 minBufSize (class MinBufSize)
1417 Specify the minimum size of the input buffer, i.e., the amount
1418 of data that xterm requests on each read. The default is
1419 “4096”. You cannot set this to a value less than 64.
1420 omitTranslation (class OmitTranslation)
1422 Selectively omit one or more parts of xterm's default
1423 translations at startup. The resource value is a comma-
1424 separated list of keywords, which may be abbreviated:
1425 default
1427 ignore (mouse) button-down events which were not handled
1428 by other translations
1429 fullscreen
1431 assigns a key-binding to the fullscreen() action.
1432 keypress
1434 assigns keypresses by default to the insert-seven-bit()
1435 and insert-eight-bit() actions.
1436 paging assigns key bindings to the scroll-back() and
1438 scroll-forw() actions.
1439 pointer
1441 assigns pointer motion and button events to the
1442 pointer-motion() and pointer-button() actions
1443 respectively.
1444 popup-menu
1446 assigns mouse-buttons with the control modifier to the
1447 popup-menus.
1448 reset assigns mouse-button 2 with the meta modifier to the
1450 clear-saved-lines action.
1451 scroll-lock
1453 assigns a key-binding to the scroll-lock() action.
1454 select assigns mouse- and keypress-combinations to actions
1456 which manipulate the selection.
1457 Xterm also uses these actions to capture mouse button
1459 and motion events which can be manipulated with the
1460 mouse protocol control sequences. If the select
1461 translations are omitted, then the pointer-motion and
1462 pointer-button handle these mouse protocol control
1463 sequences instead.
1464 shift-fonts
1466 assigns key-bindings to larger-vt-font() and
1467 smaller-vt-font() actions.
1468 wheel-mouse
1470 assigns buttons 4 and 5 with different modifiers to the
1471 scroll-back() and scroll-forw() actions.
1472 ptyHandshake (class PtyHandshake)
1474 If “true”, xterm will perform handshaking during initialization
1475 to ensure that the parent and child processes update the utmp
1476 and stty state.
1477 See also waitForMap which waits for the pseudo-terminal's
1479 notion of the screen size, and ptySttySize which resets the
1480 screen size after other terminal initialization is complete.
1481 The default is “true”.
1482 ptyInitialErase (class PtyInitialErase)
1484 If “true”, xterm will use the pseudo-terminal's sense of the
1485 stty erase value. If “false”, xterm will set the stty erase
1486 value to match its own configuration, using the kb string from
1487 the termcap entry as a reference, if available.
1488 In either case, the result is applied to the TERMCAP variable
1490 which xterm sets, if the system uses TERMCAP.
1491 See also the ttyModes resource, which may override this. The
1493 default is “False”.
1494 ptySttySize (class PtySttySize)
1496 If “true”, xterm will reset the screen size after terminal
1497 initialization is complete. This is needed for some systems
1498 whose pseudo-terminals cannot propagate terminal
1499 characteristics. Where it is not needed, it can interfere with
1500 other methods for setting the initial screen size, e.g., via
1501 window manager interaction.
1502 See also waitForMap which waits for a handshake-message giving
1504 the pseudo-terminal's notion of the screen size. The default
1505 is “false” on Linux and macOS systems, “true” otherwise.
1506 reportColors (class ReportColors)
1508 If true, xterm will print to the standard output a summary of
1509 colors as it allocates them. The default is “false”.
1510 reportFonts (class ReportFonts)
1512 If true, xterm will print to the standard output a summary of
1513 each font's metrics (size, number of glyphs, etc.), as it loads
1514 them. The default is “false”.
1515 reportIcons (class ReportIcons)
1517 If true, xterm will print to the standard output a summary of
1518 each pixmap icon as it loads them. The default is “false”.
1519 reportXRes (class ReportXRes)
1521 If true, xterm will print to the standard output a list of the
1522 boolean, numeric and string X resources for the VT100 widget
1523 after initialization. The default is “false”.
1524 sameName (class SameName)
1526 If the value of this resource is “true”, xterm does not send
1527 title and icon name change requests when the request would have
1528 no effect: the name is not changed. This has the advantage of
1529 preventing flicker and the disadvantage of requiring an extra
1530 round trip to the server to find out the previous value. In
1531 practice this should never be a problem. The default is
1532 “true”.
1533 scaleHeight (class ScaleHeight)
1535 Scale line-height values by the resource value, which is
1536 limited to “0.9” to “1.5”. The default value is “1.0”,
1537 While this resource applies to either bitmap or TrueType fonts,
1539 its main purpose is to help work around incompatible changes in
1540 the Xft library's font metrics. Xterm checks the font metrics
1541 to find what the library claims are the bounding boxes for each
1542 glyph (character). However, some of Xft's features (such as
1543 the autohinter) can cause the glyphs to be scaled larger than
1544 the bounding boxes, and be partly overwritten by the next row.
1545 See useClipping for a related resource.
1547 scoFunctionKeys (class ScoFunctionKeys)
1549 Specifies whether or not SCO function key escape codes should
1550 be generated for function keys. The default is “false”, i.e.,
1551 this feature is disabled.
1552 The keyboardType resource is the preferred mechanism for
1554 selecting this mode.
1555 sessionMgt (class SessionMgt)
1557 If the value of this resource is “true”, xterm sets up session
1558 manager callbacks for XtNdieCallback and XtNsaveCallback. The
1559 default is “true”.
1560 sunFunctionKeys (class SunFunctionKeys)
1562 Specifies whether or not Sun function key escape codes should
1563 be generated for function keys. The default is “false”, i.e.,
1564 this feature is disabled.
1565 The keyboardType resource is the preferred mechanism for
1567 selecting this mode.
1568 sunKeyboard (class SunKeyboard)
1570 Xterm translates certain key symbols based on its assumptions
1571 about your keyboard. This resource specifies whether or not
1572 Sun/PC keyboard layout (i.e., the PC keyboard's numeric keypad
1573 together with 12 function keys) should be assumed rather than
1574 DEC VT220. This causes the keypad “+” to be mapped to “,”.
1575 and CTRL F1-F10 to F11-F20, depending on the setting of the
1576 ctrlFKeys resource, so xterm emulates a DEC VT220 more
1577 accurately. Otherwise (the default, with sunKeyboard set to
1578 “false”), xterm uses PC-style bindings for the function keys
1579 and keypad.
1580 PC-style bindings use the Shift, Alt, Control and Meta keys as
1582 modifiers for function-keys and keypad (see Xterm Control
1583 Sequences for details). The PC-style bindings are analogous to
1584 PCTerm, but not the same thing. Normally these bindings do not
1585 conflict with the use of the Meta key as described for the
1586 eightBitInput resource. If they do, note that the PC-style
1587 bindings are evaluated first.
1588 See also the keyboardType resource.
1590 tcapFunctionKeys (class TcapFunctionKeys)
1592 Specifies whether or not function key escape codes read from
1593 the termcap/terminfo entry corresponding to the TERM
1594 environment variable should be generated for function keys
1595 instead of those configured using sunKeyboard and keyboardType.
1596 The default is “false”, i.e., this feature is disabled.
1597 The keyboardType resource is the preferred mechanism for
1599 selecting this mode.
1600 termName (class TermName)
1602 Specifies the terminal type name to be set in the TERM
1603 environment variable.
1604 title (class Title)
1606 Specifies a string that may be used by the window manager when
1607 displaying this application.
1608 toolBar (class ToolBar)
1610 Specifies whether or not the toolbar should be displayed. The
1611 default is “true”.
1612 ttyModes (class TtyModes)
1614 Specifies a string containing terminal setting keywords.
1615 Except where noted, they may be bound to characters. Other
1616 keywords set modes. Not all keywords are supported on a given
1617 system. Allowable keywords include:
1618 Keyword POSIX? Notes
1620 ────────────────────────────────────────────────────────────────
1621 brk no CHAR may send an “interrupt” signal, as well
1622 as ending the input-line.
1623 dsusp no CHAR will send a terminal “stop” signal
1624 after input is flushed.
1625 eof yes CHAR will terminate input (i.e., an end of
1626 file).
1627 eol yes CHAR will end the line.
1628 eol2 no alternate CHAR for ending the line.
1629 erase yes CHAR will erase the last character typed.
1630 erase2 no alternate CHAR for erasing the last input-
1631 character.
1632 flush no CHAR will cause output to be discarded until
1633 another flush character is typed.
1634 intr yes CHAR will send an “interrupt” signal.
1635 kill yes CHAR will erase the current line.
1636 lnext no CHAR will enter the next character quoted.
1637 quit yes CHAR will send a “quit” signal.
1638 rprnt no CHAR will redraw the current line.
1639 start yes CHAR will restart the output after stopping
1640 it.
1641 status no CHAR will cause a system-generated status
1644 line to be printed.
1645 stop yes CHAR will stop the output.
1646 susp yes CHAR will send a terminal “stop” signal
1647 swtch no CHAR will switch to a different shell layer.
1648 tabs yes Mode disables tab-expansion.
1649 -tabs yes Mode enables tab-expansion.
1650 weras no CHAR will erase the last word typed.
1651 Control characters may be specified as ^char (e.g., ^c or ^u)
1653 and ^? may be used to indicate delete (127). Use ^- to denote
1654 undef. Use \034 to represent ^\, since a literal backslash in
1655 an X resource escapes the next character.
1656 This is very useful for overriding the default terminal
1658 settings without having to run stty every time an xterm is
1659 started. Note, however, that the stty program on a given host
1660 may use different keywords; xterm's table is built in. The
1661 POSIX column in the table indicates which keywords are
1662 supported by a standard stty program.
1663 If the ttyModes resource specifies a value for erase, that
1665 overrides the ptyInitialErase resource setting, i.e., xterm
1666 initializes the terminal to match that value.
1667 useInsertMode (class UseInsertMode)
1669 Force use of insert mode by adding appropriate entries to the
1670 TERMCAP environment variable. This is useful if the system
1671 termcap is broken. (This resource is ignored on most systems,
1672 because TERMCAP is not used). The default is “false”.
1673 utmpDisplayId (class UtmpDisplayId)
1675 Specifies whether or not xterm should try to record the display
1676 identifier (display number and screen number) as well as the
1677 hostname in the system utmp log file. The default is “true”.
1678 utmpInhibit (class UtmpInhibit)
1680 Specifies whether or not xterm should try to record the user's
1681 terminal in the system utmp log file. If true, xterm will not
1682 try. The default is “false”.
1683 validShells (class ValidShells)
1685 Augment (add to) the system's /etc/shells, when determining
1686 whether to set the “SHELL” environment variable when running a
1687 given program.
1688 The resource value is a list of lines (separated by newlines).
1690 Each line holds one pathname. Xterm ignores any line beginning
1691 with “#” after trimming leading/trailing whitespace from each
1692 line.
1693 The default is an empty string.
1695 waitForMap (class WaitForMap)
1697 Specifies whether or not xterm should wait for the initial
1698 window map before starting the subprocess. This is part of the
1699 ptyHandshake logic. When xterm is directed to wait in this
1700 fashion, it passes the terminal size from the display end of
1701 the pseudo-terminal to the terminal I/O connection, e.g., using
1702 the size according to the window manager. Otherwise, it uses
1703 the size as given in resource values or command-line option
1704 -geometry. The default is “false”.
1705 zIconBeep (class ZIconBeep)
1707 Same as -ziconbeep command line argument. If the value of this
1708 resource is non-zero, xterms that produce output while
1709 iconified will cause an XBell sound at the given volume and
1710 have “*** ” prepended to their icon titles. Most window
1711 managers will detect this change immediately, showing you which
1712 window has the output. (A similar feature was in x10 xterm.)
1713 The default is “false”.
1714 zIconTitleFormat (class ZIconTitleFormat)
1716 Allow customization of the string used in the zIconBeep
1717 feature. The default value is “*** %s”.
1718 If the resource value contains a “%s”, then xterm inserts the
1720 icon title at that point rather than prepending the string to
1721 the icon title. (Only the first “%s” is used).
1722 VT100 Widget Resources
1724 The following resources are specified as part of the vt100 widget
1725 (class VT100). They are specified by patterns such as
1726 “XTerm.vt100.NAME”.
1727 If your xterm is configured to support the “toolbar”, then those
1729 patterns need an extra level for the form-widget which holds the
1730 toolbar and vt100 widget. A wildcard between the top-level “XTerm” and
1731 the “vt100” widget makes the resource settings work for either, e.g.,
1732 “XTerm*vt100.NAME”.
1733 activeIcon (class ActiveIcon)
1735 Specifies whether or not active icon windows are to be used
1736 when the xterm window is iconified, if this feature is compiled
1737 into xterm. The active icon is a miniature representation of
1738 the content of the window and will update as the content
1739 changes. Not all window managers necessarily support
1740 application icon windows. Some window managers will allow you
1741 to enter keystrokes into the active icon window. The default
1742 is “default”.
1743 Xterm accepts either a keyword (ignoring case) or the number
1745 shown in parentheses:
1746 false (0)
1748 No active icon is shown.
1749 true (1)
1751 The active icon is shown. If you are using twm, use
1752 this setting to enable active-icons.
1753 default (2)
1755 Xterm checks at startup, and shows an active icon only
1756 for window managers which it can identify and which are
1757 known to support the feature. These are fvwm (full
1758 support), and window maker (limited). A few other
1759 windows managers (such as twm and ctwm) support active
1760 icons, but do not support the extensions which allow
1761 xterm to identify the window manager.
1762 allowBoldFonts (class AllowBoldFonts)
1764 When set to “false”, xterm will not use bold fonts. This
1765 overrides both the alwaysBoldMode and the boldMode resources.
1766 allowC1Printable (class AllowC1Printable)
1768 If true, overrides the mapping of C1 controls (codes 128–159)
1769 to make them be treated as if they were printable characters.
1770 Although this corresponds to no particular standard, some users
1771 insist it is a VT100. The default is “false”.
1772 allowColorOps (class AllowColorOps)
1774 Specifies whether control sequences that set/query the dynamic
1775 colors should be allowed. ANSI colors are unaffected by this
1776 resource setting. The default is “true”.
1777 allowFontOps (class AllowFontOps)
1779 Specifies whether control sequences that set/query the font
1780 should be allowed. The default is “true”.
1781 allowMouseOps (class AllowMouseOps)
1783 Specifies whether control sequences that enable xterm to send
1784 escape sequences to the host on mouse-clicks and movement. The
1785 default is “true”.
1786 allowPasteControls (class AllowPasteControls)
1788 If true, allow control characters such as BEL and CAN to be
1789 pasted. Formatting characters (tab, newline) are always
1790 allowed. Other C0 control characters are suppressed unless
1791 this resource is enabled. The exact set of control characters
1792 (C0 and C1) depends upon whether UTF-8 encoding is used, as
1793 well as the allowC1Printable resource. The default is “false”.
1794 allowScrollLock (class AllowScrollLock)
1796 Specifies whether control sequences that set/query the Scroll
1797 Lock key should be allowed, as well as whether the Scroll Lock
1798 key responds to user's keypress. The default is “false”.
1799 When this feature is enabled, xterm will sense the state of the
1801 Scroll Lock key each time it acquires focus. Pressing the
1802 Scroll Lock key toggles xterm's internal state, as well as
1803 toggling the associated LED. While the Scroll Lock is active,
1804 xterm attempts to keep a viewport on the same set of lines. If
1805 the current viewport is scrolled past the limit set by the
1806 saveLines resource, then Scroll Lock has no further effect.
1807 The reason for setting the default to “false” is to avoid user
1809 surprise. This key is generally unused in keyboard
1810 configurations, and has not acquired a standard meaning even
1811 when it is used in that manner. Consequently, users have
1812 assigned it for ad hoc purposes.
1813 allowSendEvents (class AllowSendEvents)
1815 Specifies whether or not synthetic key and button events
1816 (generated using the X protocol SendEvent request) should be
1817 interpreted or discarded. The default is “false” meaning they
1818 are discarded. Note that allowing such events would create a
1819 very large security hole, therefore enabling this resource
1820 forcefully disables the allowXXXOps resources. The default is
1821 “false”.
1822 allowTcapOps (class AllowTcapOps)
1824 Specifies whether control sequences that query the terminal's
1825 notion of its function-key strings, as termcap or terminfo
1826 capabilities should be allowed. The default is “true”.
1827 A few programs, e.g., vim, use this feature to get an accurate
1829 description of the terminal's capabilities, independent of the
1830 termcap/terminfo setting:
1831 · Xterm can tell the querying program how many colors it
1833 supports. This is a constant, depending on how it is
1834 compiled, typically 16. It does not change if you alter
1835 resource settings, e.g., the boldColors resource.
1836 · Xterm can tell the querying program what strings are sent
1838 by modified (shift-, control-, alt-) function- and keypad-
1839 keys. Reporting control- and alt-modifiers is a feature
1840 that relies on the ncurses extended naming.
1841 allowTitleOps (class AllowTitleOps)
1843 Specifies whether control sequences that modify the window
1844 title or icon name should be allowed. The default is “true”.
1845 allowWindowOps (class AllowWindowOps)
1847 Specifies whether extended window control sequences (as used in
1848 dtterm) should be allowed. These include several control
1849 sequences which manipulate the window size or position, as well
1850 as reporting these values and the title or icon name. Each of
1851 these can be abused in a script; curiously enough most terminal
1852 emulators that implement these restrict only a small part of
1853 the repertoire. For fine-tuning, see disallowedWindowOps. The
1854 default is “false”.
1855 altIsNotMeta (class AltIsNotMeta)
1857 If “true”, treat the Alt-key as if it were the Meta-key. Your
1858 keyboard may happen to be configured so they are the same. But
1859 if they are not, this allows you to use the same prefix- and
1860 shifting operations with the Alt-key as with the Meta-key. See
1861 altSendsEscape and metaSendsEscape. The default is “false”.
1862 altSendsEscape (class AltSendsEscape)
1864 This is an additional keyboard operation that may be processed
1865 after the logic for metaSendsEscape. It is only available if
1866 the altIsNotMeta resource is set.
1867 · If “true”, Alt characters (a character combined with the
1869 modifier associated with left/right Alt-keys) are converted
1870 into a two-character sequence with the character itself
1871 preceded by ESC. This applies as well to function key
1872 control sequences, unless xterm sees that Alt is used in
1873 your key translations.
1874 · If “false”, Alt characters input from the keyboard cause a
1876 shift to 8-bit characters (just like metaSendsEscape). By
1877 combining the Alt- and Meta-modifiers, you can create
1878 corresponding combinations of ESC-prefix and 8-bit
1879 characters.
1880 The default is “False”. Xterm provides a menu option for
1882 toggling this resource.
1883 alternateScroll (class ScrollCond)
1885 If “true”, the scroll-back and scroll-forw actions send
1886 cursor-up and -down keys when xterm is displaying the alternate
1887 screen. The default is “false”.
1888 The alternateScroll state can also be set using a control
1890 sequence.
1891 alwaysBoldMode (class AlwaysBoldMode)
1893 Specifies whether xterm should check if the normal and bold
1894 fonts are distinct before deciding whether to use overstriking
1895 to simulate bold fonts. If this resource is true, xterm does
1896 not make the check for distinct fonts when deciding how to
1897 handle the boldMode resource. The default is “false”.
1898 boldMode alwaysBoldMode Comparison Action
1900 ────────────────────────────────────────────────────
1901 false false ignored use font
1902 false true ignored use font
1903 true false same overstrike
1904 true false different use font
1905 true true ignored overstrike
1906 This resource is used only for bitmap fonts:
1908 · When using bitmap fonts, it is possible that the font
1910 server will approximate the bold font by rescaling it from
1911 a different font size than expected. The alwaysBoldMode
1912 resource allows the user to override the (sometimes poor)
1913 resulting bold font with overstriking (which is at least
1914 consistent).
1915 · The problem does not occur with TrueType fonts (though
1917 there can be other unnecessary issues such as different
1918 coverage of the normal and bold fonts).
1919 As an alternative, setting the allowBoldFonts resource to false
1921 overrides both the alwaysBoldMode and the boldMode resources.
1922 alwaysHighlight (class AlwaysHighlight)
1924 Specifies whether or not xterm should always display a
1925 highlighted text cursor. By default (if this resource is
1926 false), a hollow text cursor is displayed whenever the pointer
1927 moves out of the window or the window loses the input focus.
1928 The default is “false”.
1929 alwaysUseMods (class AlwaysUseMods)
1931 Override the numLock resource, telling xterm to use the Alt and
1932 Meta modifiers to construct parameters for function key
1933 sequences even if those modifiers appear in the translations
1934 resource. Normally xterm checks if Alt or Meta is used in a
1935 translation that would conflict with function key modifiers,
1936 and will ignore these modifiers in that special case. The
1937 default is “false”.
1938 answerbackString (class AnswerbackString)
1940 Specifies the string that xterm sends in response to an ENQ
1941 (control/E) character from the host. The default is a blank
1942 string, i.e., “”. A hardware VT100 implements this feature as
1943 a setup option.
1944 appcursorDefault (class AppcursorDefault)
1946 If “true”, the cursor keys are initially in application mode.
1947 This is the same as the VT102 private DECCKM mode, The default
1948 is “false”.
1949 appkeypadDefault (class AppkeypadDefault)
1951 If “true”, the keypad keys are initially in application mode.
1952 The default is “false”.
1953 assumeAllChars (class AssumeAllChars)
1955 If “true”, this enables a special case in bitmap fonts to allow
1956 the font server to choose how to display missing glyphs. The
1957 default is “true”.
1958 The reason for this resource is to help with certain quasi-
1960 automatically generated fonts (such as the ISO-10646-1 encoding
1961 of Terminus) which have incorrect font-metrics.
1962 autoWrap (class AutoWrap)
1964 Specifies whether or not auto-wraparound should be enabled.
1965 This is the same as the VT102 DECAWM. The default is “true”.
1966 awaitInput (class AwaitInput)
1968 Specifies whether or not xterm uses a 50 millisecond timeout to
1969 await input (i.e., to support the Xaw3d arrow scrollbar). The
1970 default is “false”.
1971 backarrowKey (class BackarrowKey)
1973 Specifies whether the backarrow key transmits a backspace (8)
1974 or delete (127) character. This corresponds to the DECBKM
1975 control sequence. A “true” value specifies backspace. The
1976 default is “False”. Pressing the control key toggles this
1977 behavior.
1978 background (class Background)
1980 Specifies the color to use for the background of the window.
1981 The default is “XtDefaultBackground”.
1982 bellIsUrgent (class BellIsUrgent)
1984 Specifies whether to set the Urgency hint for the window
1985 manager when making a bell sound. The default is “false”.
1986 bellOnReset (class BellOnReset)
1988 Specifies whether to sound a bell when doing a hard reset. The
1989 default is “true”.
1990 bellSuppressTime (class BellSuppressTime)
1992 Number of milliseconds after a bell command is sent during
1993 which additional bells will be suppressed. Default is 200. If
1994 set non-zero, additional bells will also be suppressed until
1995 the server reports that processing of the first bell has been
1996 completed; this feature is most useful with the visible bell.
1997 boldColors (class ColorMode)
1999 Specifies whether to combine bold attribute with colors like
2000 the IBM PC, i.e., map colors 0 through 7 to colors 8 through
2001 15. These normally are the brighter versions of the first 8
2002 colors, hence bold. The default is “true”.
2003 boldFont (class BoldFont)
2005 Specifies the name of the bold font to use instead of
2006 overstriking. There is no default for this resource.
2007 This font must be the same height and width as the normal font,
2009 otherwise it is ignored. If only one of the normal or bold
2010 fonts is specified, it will be used as the normal font and the
2011 bold font will be produced by overstriking this font.
2012 See also the discussion of boldMode and alwaysBoldMode
2014 resources.
2015 boldMode (class BoldMode)
2017 This specifies whether or not text with the bold attribute
2018 should be overstruck to simulate bold fonts if the resolved
2019 bold font is the same as the normal font. It may be desirable
2020 to disable bold fonts when color is being used for the bold
2021 attribute.
2022 Note that xterm has one bold font which you may set explicitly.
2024 Xterm attempts to derive a bold font for the other font
2025 selections (font1 through font7). If it cannot find a bold
2026 font, it will use the normal font. In each case (whether the
2027 explicit resource or the derived font), if the normal and bold
2028 fonts are distinct, this resource has no effect. The default
2029 is “true”.
2030 See the alwaysBoldMode resource which can modify the behavior
2032 of this resource.
2033 Although xterm attempts to derive a bold font for other font
2035 selections, the font server may not cooperate. Since X11R6,
2036 bitmap fonts have been scaled. The font server claims to
2037 provide the bold font that xterm requests, but the result is
2038 not always readable. XFree86 introduced a feature which can be
2039 used to suppress the scaling. In the X server's configuration
2040 file (e.g., “/etc/X11/xorg.conf”), you can add “:unscaled” to
2041 the end of the directory specification for the “misc” fonts,
2042 which comprise the fixed-pitch fonts that are used by xterm.
2043 For example
2044 FontPath "/usr/share/X11/fonts/misc/"
2046 would become
2048 FontPath "/usr/share/X11/fonts/misc/:unscaled"
2050 Depending on your configuration, the font server may have its
2052 own configuration file. The same “:unscaled” can be added to
2053 its configuration file at the end of the directory
2054 specification for “misc”.
2055 The bitmap scaling feature is also used by xterm to implement
2057 VT102 double-width and double-height characters.
2058 brokenLinuxOSC (class BrokenLinuxOSC)
2060 If true, xterm applies a workaround to ignore malformed control
2061 sequences that a Linux script might send. Compare the palette
2062 control sequences documented in console_codes with ECMA-48.
2063 The default is “true”.
2064 brokenSelections (class BrokenSelections)
2066 If true, xterm in 8-bit mode will interpret STRING selections
2067 as carrying text in the current locale's encoding. Normally
2068 STRING selections carry ISO-8859-1 encoded text. Setting this
2069 resource to “true” violates the ICCCM; it may, however, be
2070 useful for interacting with some broken X clients. The default
2071 is “false”.
2072 brokenStringTerm (class BrokenStringTerm)
2074 provides a work-around for some ISDN routers which start an
2075 application control string without completing it. Set this to
2076 “true” if xterm appears to freeze when connecting. The default
2077 is “false”.
2078 Xterm's state parser recognizes several types of control
2080 strings which can contain text, e.g.,
2081 APC (Application Program Command),
2083 DCS (Device Control String),
2084 OSC (Operating System Command),
2085 PM (Privacy Message), and
2086 SOS (Start of String),
2087 Each should end with a string-terminator (a special character
2089 which cannot appear in these strings). Ordinary control
2090 characters found within the string are not ignored; they are
2091 processed without interfering with the process of accumulating
2092 the control string's content. Xterm recognizes these controls
2093 in all modes, although some of the functions may be suppressed
2094 after parsing the control.
2095 When enabled, this feature allows the user to exit from an
2097 unterminated control string when any of these ordinary control
2098 characters are found:
2099 control/D (used as an end of file in many shells),
2101 control/H (backspace),
2102 control/I (tab-feed),
2103 control/J (line feed aka newline),
2104 control/K (vertical tab),
2105 control/L (form feed),
2106 control/M (carriage return),
2107 control/N (shift-out),
2108 control/O (shift-in),
2109 control/Q (XOFF),
2110 control/X (cancel)
2111 c132 (class C132)
2113 Specifies whether or not the VT102 DECCOLM escape sequence,
2114 used to switch between 80 and 132 columns, should be honored.
2115 The default is “false”.
2116 cacheDoublesize (class CacheDoublesize)
2118 Tells whether to cache double-sized fonts by xterm. Set this
2119 to zero to disable double-sized fonts altogether.
2120 cdXtraScroll (class CdXtraScroll)
2122 Specifies whether xterm should scroll to a new page when
2123 clearing the whole screen. Like tiXtraScroll, the intent of
2124 this option is to provide a picture of the full-screen
2125 application's display on the scrollback before wiping out the
2126 text. The default for this resource is “false”.
2127 charClass (class CharClass)
2129 Specifies comma-separated lists of character class bindings of
2130 the form
2131 low[-high][:value].
2133 These are used in determining which sets of characters should
2135 be treated the same when doing cut and paste. See the
2136 CHARACTER CLASSES section.
2137 checksumExtension (class ChecksumExtension)
2139 DEC VT420 and up support a control sequence DECRQCRA which
2140 reports the checksum of the characters in a rectangle. Xterm
2141 supports this, with extensions that can be configured with bits
2142 of the checksumExtension:
2143 0 do not negate the result.
2145 1 do not report the VT100 video attributes.
2147 2 do not omit checksum for blanks.
2149 3 omit checksum for cells not explicitly initialized.
2151 4 do not mask cell value to 8 bits or ignore combining
2153 characters.
2154 5 do not mask cell value to 7 bits.
2156 With the default value (0), xterm matches the behavior of DEC's
2158 terminals. To use all extensions, set all bits, “-1” for
2159 example.
2160 cjkWidth (class CjkWidth)
2162 Specifies whether xterm should follow the traditional East
2163 Asian width convention. When turned on, characters with East
2164 Asian Ambiguous (A) category in UTR 11 have a column width of
2165 2. You may have to set this option to “true” if you have some
2166 old East Asian terminal based programs that assume that line-
2167 drawing characters have a column width of 2. If this resource
2168 is false, the mkWidth resource controls the choice between the
2169 system's wcwidth and xterm's built-in tables. The default is
2170 “false”.
2171 color0 (class Color0)
2173 color1 (class Color1)
2175 color2 (class Color2)
2177 color3 (class Color3)
2179 color4 (class Color4)
2181 color5 (class Color5)
2183 color6 (class Color6)
2185 color7 (class Color7)
2187 These specify the colors for the ISO-6429 extension. The
2188 defaults are, respectively, black, red3, green3, yellow3, a
2189 customizable dark blue, magenta3, cyan3, and gray90. The
2190 default shades of color are chosen to allow the colors 8–15 to
2191 be used as brighter versions.
2192 color8 (class Color8)
2194 color9 (class Color9)
2196 color10 (class Color10)
2198 color11 (class Color11)
2200 color12 (class Color12)
2202 color13 (class Color13)
2204 color14 (class Color14)
2206 color15 (class Color15)
2208 These specify the colors for the ISO-6429 extension if the bold
2209 attribute is also enabled. The default resource values are
2210 respectively, gray50, red, green, yellow, a customized light
2211 blue, magenta, cyan, and white.
2212 color16 (class Color16)
2214 through
2216 color255 (class Color255)
2218 These specify the colors for the 256-color extension. The
2219 default resource values are for
2220 · colors 16 through 231 to make a 6x6x6 color cube, and
2222 · colors 232 through 255 to make a grayscale ramp.
2224 Resources past color15 are available as a compile-time option.
2226 Due to a hardcoded limit in the X libraries on the total number
2227 of resources (to 400), the resources for 256-colors are omitted
2228 when wide-character support and luit are enabled. Besides
2229 inconsistent behavior if only part of the resources were
2230 allowed, determining the exact cutoff is difficult, and the X
2231 libraries tend to crash if the number of resources exceeds the
2232 limit. The color palette is still initialized to the same
2233 default values, and can be modified via control sequences.
2234 On the other hand, the resource limit does permit including the
2236 entire range for 88-colors.
2237 colorAttrMode (class ColorAttrMode)
2239 Specifies whether colorBD, colorBL, colorRV, and colorUL should
2240 override ANSI colors. If not, these are displayed only when no
2241 ANSI colors have been set for the corresponding position. The
2242 default is “false”.
2243 colorBD (class ColorBD)
2245 This specifies the color to use to display bold characters if
2246 the “colorBDMode” resource is enabled. The default is
2247 “XtDefaultForeground”.
2248 See also the veryBoldColors resource which allows combining
2250 bold and color.
2251 colorBDMode (class ColorAttrMode)
2253 Specifies whether characters with the bold attribute should be
2254 displayed in color or as bold characters. Note that setting
2255 colorMode off disables all colors, including bold. The default
2256 is “false”.
2257 colorBL (class ColorBL)
2259 This specifies the color to use to display blink characters if
2260 the “colorBLMode” resource is enabled. The default is
2261 “XtDefaultForeground”.
2262 See also the veryBoldColors resource which allows combining
2264 underline and color.
2265 colorBLMode (class ColorAttrMode)
2267 Specifies whether characters with the blink attribute should be
2268 displayed in color. Note that setting colorMode off disables
2269 all colors, including this. The default is “false”.
2270 colorIT (class ColorIT)
2272 This specifies the color to use to display italic characters if
2273 the “colorITMode” resource is enabled. The default is
2274 “XtDefaultForeground”.
2275 See also the veryBoldColors resource which allows combining
2277 attributes and color.
2278 colorITMode (class ColorAttrMode)
2280 Specifies whether characters with the italic attribute should
2281 be displayed in color or as italic characters. The default is
2282 “false”.
2283 Note that:
2285 · Setting colorMode off disables all colors, including
2287 italic.
2288 · The italicULMode resource overrides colorITMode.
2290 colorInnerBorder (class ColorInnerBorder)
2292 Normally, xterm fills the VT100 window's inner border using the
2293 background color.
2294 If the colorInnerBorder resource is enabled, at startup xterm
2296 will compare the borderColor and the window's background color.
2297 If those are different, xterm will use the borderColor resource
2298 to fill the inner border. Otherwise, it will use the window's
2299 background color.
2300 The default is “false”.
2302 colorMode (class ColorMode)
2304 Specifies whether or not recognition of ANSI (ISO-6429) color
2305 change escape sequences should be enabled. The default is
2306 “true”.
2307 colorRV (class ColorRV)
2309 This specifies the color to use to display reverse characters
2310 if the “colorRVMode” resource is enabled. The default is
2311 “XtDefaultForeground”.
2312 See also the veryBoldColors resource which allows combining
2314 reverse and color.
2315 colorRVMode (class ColorAttrMode)
2317 Specifies whether characters with the reverse attribute should
2318 be displayed in color. Note that setting colorMode off
2319 disables all colors, including this. The default is “false”.
2320 colorUL (class ColorUL)
2322 This specifies the color to use to display underlined
2323 characters if the “colorULMode” resource is enabled. The
2324 default is “XtDefaultForeground”.
2325 See also the veryBoldColors resource which allows combining
2327 underline and color.
2328 colorULMode (class ColorAttrMode)
2330 Specifies whether characters with the underline attribute
2331 should be displayed in color or as underlined characters. Note
2332 that setting colorMode off disables all colors, including
2333 underlining. The default is “false”.
2334 combiningChars (class CombiningChars)
2336 Specifies the number of wide-characters which can be stored in
2337 a cell to overstrike (combine) with the base character of the
2338 cell. This can be set to values in the range 0 to 5. The
2339 default is “2”.
2340 ctrlFKeys (class CtrlFKeys)
2342 In VT220 keyboard mode (see sunKeyboard resource), specifies
2343 the amount by which to shift F1-F12 given a control modifier
2344 (CTRL). This allows you to generate key symbols for F10-F20 on
2345 a Sun/PC keyboard. The default is “10”, which means that CTRL
2346 F1 generates the key symbol for F11.
2347 curses (class Curses)
2349 Specifies whether or not the last column bug in more(1) should
2350 be worked around. See the -cu option for details. The default
2351 is “false”.
2352 cursorBlink (class CursorBlink)
2354 Specifies whether to make the cursor blink. Xterm accepts
2355 either a keyword (ignoring case) or the number shown in
2356 parentheses:
2357 false (0)
2359 The cursor will not blink, but may be combined with escape
2360 sequences according to the cursorBlinkXOR resource.
2361 true (1)
2363 The cursor will blink, but may be combined with escape
2364 sequences according to the cursorBlinkXOR resource.
2365 always (2)
2367 The cursor will always blink, ignoring escape sequences.
2368 The menu entry will be disabled.
2369 never (3)
2371 The cursor will never blink, ignoring escape sequences. The
2372 menu entry will be disabled.
2373 The default is “false”.
2375 cursorBlinkXOR (class CursorBlinkXOR)
2377 Xterm uses two inputs to determine whether the cursor blinks:
2378 · The cursorBlink resource (which can be altered with a menu
2380 entry).
2381 · Control sequences (private mode 12 and DECSCUSR).
2383 The cursorBlinkXOR resource determines how those inputs are
2385 combined:
2386 false
2388 Xterm uses the logical-OR of the two variables. If either
2389 is set, xterm makes the cursor blink.
2390 true
2392 Xterm uses the logical-XOR of the two variables. If only
2393 one is set, xterm makes the cursor blink.
2394 The default is “true”.
2396 cursorColor (class CursorColor)
2398 Specifies the color to use for the text cursor. The default is
2399 “XtDefaultForeground”. By default, xterm attempts to keep this
2400 color from being the same as the background color, since it
2401 draws the cursor by filling the background of a text cell. The
2402 same restriction applies to control sequences which may change
2403 this color.
2404 Setting this resource overrides most of xterm's adjustments to
2406 cursor color. It will still use reverse-video to disallow some
2407 cases, such as a black cursor on a black background.
2408 cursorOffTime (class CursorOffTime)
2410 Specifies the duration of the “off” part of the cursor blink
2411 cycle-time in milliseconds. The same timer is used for text
2412 blinking. The default is “300”.
2413 cursorOnTime (class CursorOnTime)
2415 Specifies the duration of the “on” part of the cursor blink
2416 cycle-time, in milliseconds. The same timer is used for text
2417 blinking. The default is “600”.
2418 cursorUnderLine (class CursorUnderLine)
2420 Specifies whether to make the cursor underlined or a box. The
2421 default is “false”.
2422 cutNewline (class CutNewline)
2424 If “false”, triple clicking to select a line does not include
2425 the newline at the end of the line. If “true”, the Newline is
2426 selected. The default is “true”.
2427 cutToBeginningOfLine (class CutToBeginningOfLine)
2429 If “false”, triple clicking to select a line selects only from
2430 the current word forward. If “true”, the entire line is
2431 selected. The default is “true”.
2432 decGraphicsID (class DecGraphicsID)
2434 Allows a way to combine the graphics feature from certain DEC
2435 terminals (125, 240, 241, 330, 340 or 382) with other emulation
2436 levels which did not provide the graphics feature. As in
2437 decTerminalID, leading non-digit characters are ignored, e.g.,
2438 “vt340” and “340” are the same.
2439 If the resource value is nonzero, xterm uses that emulation
2441 level when initializing the drawing region and decoding control
2442 sequences to draw graphics.
2443 The default is “0”.
2445 decTerminalID (class DecTerminalID)
2447 Specifies the emulation level (100=VT100, 220=VT220, etc.),
2448 used to determine the type of response to a DA control
2449 sequence. Leading non-digit characters are ignored, e.g.,
2450 “vt100” and “100” are the same. The default is “420”.
2451 defaultString (class DefaultString)
2453 Specify the character (or string) which xterm will substitute
2454 when pasted text includes a character which cannot be
2455 represented in the current encoding. For instance, pasting
2456 UTF-8 text into a display of ISO-8859-1 characters will only be
2457 able to display codes 0–255, while UTF-8 text can include
2458 Unicode values above 255. The default is “#” (a single pound
2459 sign).
2460 If the undisplayable text would be double-width, xterm will add
2462 a space after the “#” character, to give roughly the same
2463 layout on the screen as the original text.
2464 deleteIsDEL (class DeleteIsDEL)
2466 Specifies what the Delete key on the editing keypad should send
2467 when pressed. The resource value is a string, evaluated as a
2468 boolean after startup. Xterm uses it in conjunction with the
2469 keyboardType resource:
2470 · If the keyboard type is “default”, or “vt220” and the
2472 resource is either “true” or “maybe” send the VT220-style
2473 Remove escape sequence. Otherwise, send DEL (127).
2474 · If the keyboard type is “legacy”, and the resource is
2476 “true” send DEL. Otherwise, send the Remove sequence.
2477 · Otherwise, if the keyboard type is none of these special
2479 cases, send DEL (127).
2480 The default is “Maybe”. The resource is allowed to be a non-
2482 boolean “maybe” so that the popup menu Delete is DEL entry does
2483 not override the keyboard type.
2484 directColor (class DirectColor)
2486 Specifies whether to handle direct-color control sequences
2487 using the X server's available colors, or to approximate those
2488 using a color map with 256 entries. A “true” value enables the
2489 former. The default is “true”.
2490 disallowedColorOps (class DisallowedColorOps)
2492 Specify which features will be disabled if allowColorOps is
2493 false. This is a comma-separated list of names. The default
2494 value is
2495 SetColor,GetColor,GetAnsiColor
2496 The names are listed below. Xterm ignores capitalization, but
2498 they are shown in mixed-case for clarity.
2499 SetColor
2501 Set a specific dynamic color.
2502 GetColor
2504 Report the current setting of a given dynamic color.
2505 GetAnsiColor
2507 Report the current setting of a given ANSI color (actually
2508 any of the colors set via ANSI-style controls).
2509 disallowedFontOps (class DisallowedFontOps)
2511 Specify which features will be disabled if allowFontOps is
2512 false. This is a comma-separated list of names. The default
2513 value is
2514 SetFont,GetFont
2516 The names are listed below. Xterm ignores capitalization, but
2518 they are shown in mixed-case for clarity.
2519 SetFont
2521 Set the specified font.
2522 GetFont
2524 Report the specified font.
2525 disallowedMouseOps (class DisallowedMouseOps)
2527 Specify which features will be disabled if allowMouseOps is
2528 false. This is a comma-separated list of names. The default
2529 value is “*” which matches all names. The names are listed
2530 below. Xterm ignores capitalization, but they are shown in
2531 mixed-case for clarity.
2532 X10 The original X10 mouse protocol.
2534 Locator
2536 DEC locator mode
2537 VT200Click
2539 X11 mouse-clicks only.
2540 VT200Hilite
2542 X11 mouse-clicks and highlighting.
2543 AnyButton
2545 XFree86 xterm any-button mode sends button-clicks as well
2546 as motion events while the button is pressed.
2547 AnyEvent
2549 XFree86 xterm any-event mode sends button-clicks as well
2550 as motion events whether or not a button is pressed.
2551 FocusEvent
2553 Send FocusIn/FocusOut events.
2554 Extended
2556 The first extension beyond X11 mouse protocol, this
2557 encodes the coordinates in UTF-8. It is deprecated in
2558 favor of SGR, but provided for compatibility.
2559 SGR This is the recommended extension for mouse-coordinates
2561 URXVT
2563 Like Extended, this is provided for compatibility.
2564 AlternateScroll
2566 This overrides the alternateScroll resource.
2567 disallowedPasteControls (class DisallowedPasteControls)
2569 The allowPasteControls resource is normally used to prevent
2570 pasting C1 controls, as well as non-formatting C0 controls such
2571 as the ASCII escape character. Those characters are simply
2572 ignored. This resource further extends the set of control
2573 characters which cannot be pasted, converting each into a
2574 space.
2575 The resource value is a comma-separated list of names. Xterm
2577 ignores capitalization. The default value is
2578 BS,DEL,ENQ,EOT,ESC,NUL
2580 The names are listed below:
2582 C0 all ASCII control characters.
2584 Individual C0 characters
2586 NUL, SOH, STX, ETX, EOT, ENQ, ACK, BEL, BS, HT, LF, VT,
2587 FF, CR, SO, SI, DLE, DC1, DC2, DC3, DC4, NAK, SYN, ETB,
2588 CAN, EM, SUB, ESC, FS, GS, RS, US
2589 DEL ASCII delete
2591 NL ASCII line-feed, i.e., “newline” is the same as LF.
2593 disallowedTcapOps (class DisallowedTcapOps)
2595 Specify which features will be disabled if allowTcapOps is
2596 false. This is a comma-separated list of names. The default
2597 value is
2598 SetTcap,GetTcap
2600 The names are listed below. Xterm ignores capitalization, but
2602 they are shown in mixed-case for clarity.
2603 SetTcap
2605 (not implemented)
2606 GetTcap
2608 Report specified function- and other special keys.
2609 disallowedWindowOps (class DisallowedWindowOps)
2611 Specify which features will be disabled if allowWindowOps is
2612 false. This is a comma-separated list of names, or (for the
2613 controls adapted from dtterm the operation number). The
2614 default value is
2615 20,21,SetXprop,SetSelection
2617 (i.e., all except a few “dangerous” operations are allowed).
2618 The names are listed below. Xterm ignores capitalization, but
2620 they are shown in mixed-case for clarity. Where a number can
2621 be used as an alternative, it is given in parentheses after the
2622 name.
2623 GetChecksum
2625 Report checksum of characters in a rectangular region.
2626 GetIconTitle (20)
2628 Report xterm window's icon label as a string.
2629 GetScreenSizeChars (19)
2631 Report the size of the screen in characters as numbers.
2632 GetSelection
2634 Report selection data as a base64 string.
2635 GetWinPosition (13)
2637 Report xterm window position as numbers.
2638 GetWinSizeChars (18)
2640 Report the size of the text area in characters as numbers.
2641 GetWinSizePixels (14)
2643 Report xterm window in pixels as numbers.
2644 GetWinState (11)
2646 Report xterm window state as a number.
2647 GetWinTitle (21)
2649 Report xterm window's title as a string.
2650 LowerWin (6)
2652 Lower the xterm window to the bottom of the stacking
2653 order.
2654 MaximizeWin (9)
2656 Maximize window (i.e., resize to screen size).
2657 FullscreenWin (10)
2659 Use full screen (i.e., resize to screen size, without
2660 window decorations).
2661 MinimizeWin (2)
2663 Iconify window.
2664 PopTitle (23)
2666 Pop title from internal stack.
2667 PushTitle (22)
2669 Push title to internal stack.
2670 RaiseWin (5)
2672 Raise the xterm window to the front of the stacking order.
2673 RefreshWin (7)
2675 Refresh the xterm window.
2676 RestoreWin (1)
2678 De-iconify window.
2679 SetChecksum
2681 Modify algorithm for reporting checksum of characters in a
2682 rectangular region.
2683 SetSelection
2685 Set selection data.
2686 SetWinLines
2688 Resize to a given number of lines, at least 24.
2689 SetWinPosition (3)
2691 Move window to given coordinates.
2692 SetWinSizeChars (8)
2694 Resize the text area to given size in characters.
2695 SetWinSizePixels (4)
2697 Resize the xterm window to given size in pixels.
2698 SetXprop
2700 Set X property on top-level window.
2701 dynamicColors (class DynamicColors)
2703 Specifies whether or not escape sequences to change colors
2704 assigned to different attributes are recognized.
2705 eightBitControl (class EightBitControl)
2707 Specifies whether or not control sequences sent by the terminal
2708 should be eight-bit characters or escape sequences. The
2709 default is “false”.
2710 eightBitInput (class EightBitInput)
2712 If “true”, Meta characters (a single-byte character combined
2713 with the Meta modifier key) input from the keyboard are
2714 presented as a single character, modified according to the
2715 eightBitMeta resource. If “false”, Meta characters are
2716 converted into a two-character sequence with the character
2717 itself preceded by ESC. The default is “true”.
2718 The metaSendsEscape and altSendsEscape resources may override
2720 this feature. Generally keyboards do not have a key labeled
2721 “Meta”, but “Alt” keys are common, and they are conventionally
2722 used for “Meta”. If they were synonymous, it would have been
2723 reasonable to name this resource “altSendsEscape”, reversing
2724 its sense. For more background on this, see the meta(3x)
2725 function in curses.
2726 Note that the Alt key is not necessarily the same as the Meta
2728 modifier. The xmodmap utility lists your key modifiers. X
2729 defines modifiers for shift, (caps) lock and control, as well
2730 as 5 additional modifiers which are generally used to configure
2731 key modifiers. Xterm inspects the same information to find the
2732 modifier associated with either Meta key (left or right), and
2733 uses that key as the Meta modifier. It also looks for the
2734 NumLock key, to recognize the modifier which is associated with
2735 that.
2736 If your xmodmap configuration uses the same keycodes for Alt-
2738 and Meta-keys, xterm will only see the Alt-key definitions,
2739 since those are tested before Meta-keys. NumLock is tested
2740 first. It is important to keep these keys distinct; otherwise
2741 some of xterm's functionality is not available.
2742 The eightBitInput resource is tested at startup time. If
2744 “true”, the xterm tries to put the terminal into 8-bit mode.
2745 If “false”, on startup, xterm tries to put the terminal into
2746 7-bit mode. For some configurations this is unsuccessful;
2747 failure is ignored. After startup, xterm does not change the
2748 terminal between 8-bit and 7-bit mode.
2749 As originally implemented in X11, the resource value did not
2751 change after startup. However (since patch #216 in 2006) xterm
2752 can modify eightBitInput after startup via a control sequence.
2753 The corresponding terminfo capabilities smm (set meta mode) and
2754 rmm (reset meta mode) have been recognized by bash for some
2755 time. Interestingly enough, bash's notion of “meta mode”
2756 differs from the standard definition (in the terminfo manual),
2757 which describes the change to the eighth bit of a character.
2758 It happens that bash views “meta mode” as the ESC character
2759 that xterm puts before a character when a special meta key is
2760 pressed. bash's early documentation talks about the ESC
2761 character and ignores the eighth bit.
2762 eightBitMeta (class EightBitMeta)
2764 This controls the way xterm modifies the eighth bit of a
2765 single-byte key when the eightBitInput resource is set. The
2766 default is “locale”.
2767 The resource value is a string, evaluated as a boolean after
2769 startup.
2770 false
2772 The key is sent unmodified.
2773 locale
2775 The key is modified only if the locale uses eight-bit
2776 encoding.
2777 true The key is sent modified.
2779 never
2781 The key is always sent unmodified.
2782 Except for the never choice, xterm honors the terminfo
2784 capabilities smm (set meta mode) and rmm (reset meta mode),
2785 allowing the feature to be turned on or off dynamically.
2786 If eightBitMeta is enabled when the locale uses UTF-8, xterm
2788 encodes the value as UTF-8 (since patch #183 in 2003).
2789 eightBitOutput (class EightBitOutput)
2791 Specifies whether or not eight-bit characters sent from the
2792 host should be accepted as is or stripped when printed. The
2793 default is “true”, which means that they are accepted as is.
2794 eightBitSelectTypes (class EightBitSelectTypes)
2796 Override xterm's default selection target list (see
2797 SELECT/PASTE) for selections in normal (ISO-8859-1) mode. The
2798 default is an empty string, i.e., “”, which does not override
2799 anything.
2800 eraseSavedLines (class EraseSavedLines)
2802 Specifies whether or not to allow xterm extended ED/DECSED
2803 control sequences to erase the saved-line buffer. The default
2804 is “true”.
2805 faceName (class FaceName)
2807 Specify the pattern for scalable fonts selected from the
2808 FreeType library if support for that library was compiled into
2809 xterm. There is no default value.
2810 One or more fonts can be specified, separated by commas. If
2812 prefixed with “x:” or “x11:” the specification applies to the
2813 XLFD font resource. A “xft:” prefix is accepted but
2814 unnecessary since a missing prefix for faceName means that it
2815 will be used for TrueType. For example,
2816 XTerm*faceName: x:fixed,xft:Bitstream Vera Sans Mono
2818 If no faceName resource is specified, or if there is no match
2820 for both TrueType normal and bold fonts, xterm uses the XLFD
2821 (bitmap) font and related resources.
2822 It is possible to select suitable bitmap fonts using a script
2824 such as this:
2825 #!/bin/sh
2827 FONT=`xfontsel -print`
2828 test -n "$FONT" && xfd -fn "$FONT"
2829 However (even though xfd accepts a “-fa” option to denote
2831 FreeType fonts), xfontsel has not been similarly extended. As
2832 a workaround, you may try
2833 fc-list :scalable=true:spacing=mono: family
2835 to find a list of scalable fixed-pitch fonts which may be used
2837 for the faceName resource value.
2838 faceNameDoublesize (class FaceNameDoublesize)
2840 Specify a double-width scalable font for cases where an
2841 application requires this, e.g., in CJK applications. There is
2842 no default value.
2843 Like the faceName resource, this allows one or more comma-
2845 separated font specifications to be applied to the wide
2846 TrueType or XLFD fonts.
2847 If the application uses double-wide characters and this
2849 resource is not given, xterm will use a scaled version of the
2850 font given by faceName.
2851 faceSize (class FaceSize)
2853 Specify the pointsize for fonts selected from the FreeType
2854 library if support for that library was compiled into xterm.
2855 The default is “8.0” On the VT Fonts menu, this corresponds to
2856 the Default entry.
2857 Although the default is “8.0”, this may not be the same as the
2859 pointsize for the default bitmap font, i.e., that assigned with
2860 the -fn option, or the font resource. The default value of
2861 faceSize is chosen to match the size of the “fixed” font,
2862 making switching between bitmap and TrueType fonts via the font
2863 menu give comparable sizes for the window. If your -fn option
2864 uses a different pointsize, you might want to adjust the
2865 faceSize resource to match.
2866 You can specify the pointsize for TrueType fonts selected with
2868 the other size-related menu entries such as Medium, Huge, etc.,
2869 by using one of the following resource values. If you do not
2870 specify a value, they default to “0.0”, which causes xterm to
2871 use the ratio of font sizes from the corresponding bitmap font
2872 resources to obtain a TrueType pointsize.
2873 If all of the faceSize resources are set, then xterm will use
2875 this information to determine the next smaller/larger TrueType
2876 font for the larger-vt-font() and smaller-vt-font() actions.
2877 If any are not set, xterm will use only the areas of the bitmap
2878 fonts.
2879 faceSize1 (class FaceSize1)
2881 Specifies the pointsize of the first alternative font.
2882 faceSize2 (class FaceSize2)
2884 Specifies the pointsize of the second alternative font.
2885 faceSize3 (class FaceSize3)
2887 Specifies the pointsize of the third alternative font.
2888 faceSize4 (class FaceSize4)
2890 Specifies the pointsize of the fourth alternative font.
2891 faceSize5 (class FaceSize5)
2893 Specifies the pointsize of the fifth alternative font.
2894 faceSize6 (class FaceSize6)
2896 Specifies the pointsize of the sixth alternative font.
2897 fastScroll (class FastScroll)
2899 Modifies the effect of jump scroll (jumpScroll) by suppressing
2900 screen refreshes for the special case when output to the screen
2901 has completely shifted the contents off-screen. For instance,
2902 cat'ing a large file to the screen does this.
2903 font (class Font)
2905 Specifies the name of the normal font. The default is “fixed”.
2906 See the discussion of the locale resource, which describes how
2908 this font may be overridden.
2909 NOTE: some resource files use patterns such as
2911 *font: fixed
2913 which are overly broad, affecting both
2915 xterm.vt100.font
2917 and
2919 xterm.vt100.utf8Fonts.font
2921 which is probably not what you intended.
2923 font1 (class Font1)
2925 Specifies the name of the first alternative font, corresponding
2926 to “Unreadable” in the standard menu.
2927 font2 (class Font2)
2929 Specifies the name of the second alternative font,
2930 corresponding to “Tiny” in the standard menu.
2931 font3 (class Font3)
2933 Specifies the name of the third alternative font, corresponding
2934 to “Small” in the standard menu.
2935 font4 (class Font4)
2937 Specifies the name of the fourth alternative font,
2938 corresponding to “Medium” in the standard menu.
2939 font5 (class Font5)
2941 Specifies the name of the fifth alternative font, corresponding
2942 to “Large” in the standard menu.
2943 font6 (class Font6)
2945 Specifies the name of the sixth alternative font, corresponding
2946 to “Huge” in the standard menu.
2947 font7 (class Font7)
2949 Specifies the name of the seventh alternative font,
2950 corresponding to “Enormous” in the standard menu.
2951 fontDoublesize (class FontDoublesize)
2953 Specifies whether xterm should attempt to use font scaling to
2954 draw double-sized characters. Some older font servers cannot
2955 do this properly, will return misleading font metrics. The
2956 default is “true”. If disabled, xterm will simulate double-
2957 sized characters by drawing normal characters with spaces
2958 between them.
2959 fontWarnings (class FontWarnings)
2961 Specify whether xterm should report an error if it fails to
2962 load a font:
2963 0 Never report an error (though the X libraries may).
2965 1 Report an error if the font name was given as a resource
2967 setting.
2968 2 Always report an error on failure to load a font.
2970 The default is “1”.
2972 forceBoxChars (class ForceBoxChars)
2974 Specifies whether xterm should assume the normal and bold fonts
2975 have VT100 line-drawing characters:
2976 · The fixed-pitch ISO-8859-*-encoded fonts used by xterm
2978 normally have the VT100 line-drawing glyphs in cells 1–31.
2979 Other fixed-pitch fonts may be more attractive, but lack
2980 these glyphs.
2981 · When using an ISO-10646-1 font and the wideChars resource
2983 is true, xterm uses the Unicode glyphs which match the
2984 VT100 line-drawing glyphs.
2985 If “false”, xterm checks for missing glyphs in the font and
2987 makes line-drawing characters directly as needed. If “true”,
2988 xterm assumes the font does not contain the line-drawing
2989 characters, and draws them directly. The default is “false”.
2990 The VT100 line-drawing character set (also known as the DEC
2992 Special Character and Line Drawing Set) is shown in this table.
2993 It includes a few special characters which are not used for
2994 drawing lines:
2995 Cell Unicode Description
2997 ────────────────────────────────────────────────────────────
2998 0 U+25AE black vertical rectangle
2999 1 U+25C6 black diamond
3000 2 U+2592 medium shade
3001 3 U+2409 symbol for horizontal tabulation
3002 4 U+240C symbol for form feed
3003 5 U+240D symbol for carriage return
3004 6 U+240A symbol for line feed
3005 7 U+00B0 degree sign
3006 8 U+00B1 plus-minus sign
3007 9 U+2424 symbol for newline
3008 10 U+240B symbol for vertical tabulation
3009 11 U+2518 box drawings light up and left
3010 12 U+2510 box drawings light down and left
3011 13 U+250C box drawings light down and right
3012 14 U+2514 box drawings light up and right
3013 15 U+253C box drawings light vertical and horizontal
3014 16 U+23BA box drawings scan 1
3015 17 U+23BB box drawings scan 3
3016 18 U+2500 box drawings light horizontal
3017 19 U+23BC box drawings scan 7
3018 20 U+23BD box drawings scan 9
3019 21 U+251C box drawings light vertical and right
3020 22 U+2524 box drawings light vertical and left
3021 23 U+2534 box drawings light up and horizontal
3022 24 U+252C box drawings light down and horizontal
3023 25 U+2502 box drawings light vertical
3024 26 U+2264 less-than or equal to
3025 27 U+2265 greater-than or equal to
3026 28 U+03C0 greek small letter pi
3027 29 U+2260 not equal to
3028 30 U+00A3 pound sign
3029 31 U+00B7 middle dot
3030 ────────────────────────────────────────────────────────────
3031 forcePackedFont (class ForcePackedFont)
3033 Specifies whether xterm should use the maximum or minimum glyph
3034 width when displaying using a bitmap font. Use the maximum
3035 width to help with proportional fonts. The default is “true”,
3036 denoting the minimum width.
3037 forceXftHeight (class ForceXftHeight)
3039 Specifies whether xterm should use the given font metrics for
3040 TrueType fonts, or amend the ascent/descent to total no more
3041 than the given font-height. This optional feature is used to
3042 work around inconsistencies in FreeType's rounding computation.
3043 The default is “false”, denoting the given metrics.
3044 foreground (class Foreground)
3046 Specifies the color to use for displaying text in the window.
3047 Setting the class name instead of the instance name is an easy
3048 way to have everything that would normally appear in the text
3049 color change color. The default is “XtDefaultForeground”.
3050 formatOtherKeys (class FormatOtherKeys)
3052 Overrides the format of the escape sequence used to report
3053 modified keys with the modifyOtherKeys resource.
3054 0 send modified keys as parameters for function-key 27
3056 (default).
3057 1 send modified keys as parameters for CSI u.
3059 freeBoldBox (class FreeBoldBox)
3061 Specifies whether xterm should assume the bounding boxes for
3062 normal and bold fonts are compatible. If “false”, xterm
3063 compares them and will reject choices of bold fonts that do not
3064 match the size of the normal font. The default is “false”,
3065 which means that the comparison is performed.
3066 geometry (class Geometry)
3068 Specifies the preferred size and position of the VTxxx window.
3069 There is no default for this resource.
3070 highlightColor (class HighlightColor)
3072 Specifies the color to use for the background of selected
3073 (highlighted) text. If not specified (i.e., matching the
3074 default foreground), reverse video is used. The default is
3075 “XtDefaultForeground”.
3076 highlightColorMode (class HighlightColorMode)
3078 Specifies whether xterm should use highlightTextColor and
3079 highlightColor to override the reversed foreground/background
3080 colors in a selection. The default is unspecified: at startup,
3081 xterm checks if those resources are set to something other than
3082 the default foreground and background colors. Setting this
3083 resource disables the check.
3084 The following table shows the interaction of the highlighting
3086 resources, abbreviated as shown to fit in this page:
3087 HCM
3089 highlightColorMode
3090 HR highlightReverse
3092 HBG
3094 highlightColor
3095 HFG
3097 highlightTextColor
3098 HCM HR HBG HFG Highlight
3100 ────────────────────────────────────────────────
3101 false false default default bg/fg
3102 false false default set bg/fg
3103 false false set default fg/HBG
3104 false false set set fg/HBG
3105 ────────────────────────────────────────────────
3106 false true default default bg/fg
3107 false true default set bg/fg
3108 false true set default fg/HBG
3109 false true set set fg/HBG
3110 ────────────────────────────────────────────────
3111 true false default default bg/fg
3112 true false default set HFG/fg
3113 true false set default bg/HBG
3114 true false set set HFG/HBG
3115 ────────────────────────────────────────────────
3116 true true default default bg/fg
3117 true true default set HFG/fg
3118 true true set default fg/HBG
3119 true true set set HFG/HBG
3120 ────────────────────────────────────────────────
3121 default false default default bg/fg
3122 default false default set bg/fg
3123 default false set default fg/HBG
3124 default false set set HFG/HBG
3125 ────────────────────────────────────────────────
3126 default true default default bg/fg
3127 default true default set bg/fg
3128 default true set default fg/HBG
3129 default true set set HFG/HBG
3130 ────────────────────────────────────────────────
3131 highlightReverse (class HighlightReverse)
3133 Specifies whether xterm should reverse the selection foreground
3134 and background colors when selecting text with reverse-video
3135 attribute. This applies only to the highlightColor and
3136 highlightTextColor resources, e.g., to match the color scheme
3137 of xwsh. If “true”, xterm reverses the colors, If “false”,
3138 xterm does not reverse colors, The default is “true”.
3139 highlightSelection (class HighlightSelection)
3141 Tells xterm whether to highlight all of the selected positions,
3142 or only the selected text:
3143 · If “false”, selecting with the mouse highlights all
3145 positions on the screen between the beginning of the
3146 selection and the current position.
3147 · If “true”, xterm highlights only the positions that contain
3149 text that can be selected.
3150 The default is “false”.
3152 Depending on the way your applications write to the screen,
3154 there may be trailing blanks on a line. Xterm stores data as
3155 it is shown on the screen. Erasing the display changes the
3156 internal state of each cell so it is not considered a blank for
3157 the purpose of selection. Blanks written since the last erase
3158 are selectable. If you do not wish to have trailing blanks in
3159 a selection, use the trimSelection resource.
3160 highlightTextColor (class HighlightTextColor)
3162 Specifies the color to use for the foreground of selected
3163 (highlighted) text. If not specified (i.e., matching the
3164 default background), reverse video is used. The default is
3165 “XtDefaultBackground”.
3166 hpLowerleftBugCompat (class HpLowerleftBugCompat)
3168 Specifies whether to work around a bug in HP's xdb, which
3169 ignores termcap and always sends ESC F to move to the lower
3170 left corner. “true” causes xterm to interpret ESC F as a
3171 request to move to the lower left corner of the screen. The
3172 default is “false”.
3173 i18nSelections (class I18nSelections)
3175 If false, xterm will not request the targets COMPOUND_TEXT or
3176 TEXT. The default is “true”. It may be set to false in order
3177 to work around ICCCM violations by other X clients.
3178 iconBorderColor (class BorderColor)
3180 Specifies the border color for the active icon window if this
3181 feature is compiled into xterm. Not all window managers will
3182 make the icon border visible.
3183 iconBorderWidth (class BorderWidth)
3185 Specifies the border width for the active icon window if this
3186 feature is compiled into xterm. The default is “2”. Not all
3187 window managers will make the border visible.
3188 iconFont (class IconFont)
3190 Specifies the font for the miniature active icon window, if
3191 this feature is compiled into xterm. The default is “nil2”.
3192 initialFont (class InitialFont)
3194 Specifies which of the VT100 fonts to use initially. Values
3195 are the same as for the set-vt-font action. The default is
3196 “d”, i.e., “default”.
3197 inputMethod (class InputMethod)
3199 Tells xterm which type of input method to use. There is no
3200 default method.
3201 internalBorder (class BorderWidth)
3203 Specifies the number of pixels between the characters and the
3204 window border. The default is “2”.
3205 italicULMode (class ColorAttrMode)
3207 Specifies whether characters with the underline attribute
3208 should be displayed in an italic font or as underlined
3209 characters. It is implemented only for TrueType fonts.
3210 jumpScroll (class JumpScroll)
3212 Specifies whether or not jump scroll should be used. This
3213 corresponds to the VT102 DECSCLM private mode. The default is
3214 “true”. See fastScroll for a variation.
3215 keepClipboard (class KeepClipboard)
3217 Specifies whether xterm will reuse the selection data which it
3218 copied to the clipboard rather than asking the clipboard for
3219 its current contents when told to provide the selection. The
3220 default is “false”.
3221 If compiled into xterm, the menu entry Keep Clipboard allows
3223 you to change this at runtime.
3224 keepSelection (class KeepSelection)
3226 Specifies whether xterm will keep the selection even after the
3227 selected area was touched by some output to the terminal. The
3228 default is “true”.
3229 The menu entry Keep Selection allows you to change this at
3231 runtime.
3232 keyboardDialect (class KeyboardDialect)
3234 Specifies the initial keyboard dialect, as well as the default
3235 value when the terminal is reset. The value given is the same
3236 as the final character in the control sequences which change
3237 character sets. The default is “B”, which corresponds to US
3238 ASCII.
3239 limitFontsets (class LimitFontsets)
3241 Limits the number of TrueType fallback fonts (i.e., fontset)
3242 which can be used. The default is “50”.
3243 This limits the number of fallback fonts which xterm uses to
3245 display characters. Because TrueType fonts typically are
3246 small, xterm may open several fonts for good coverage, and may
3247 open additional fonts to obtain information. You can see which
3248 font-files xterm opens by setting the environment variable
3249 XFT_DEBUG to 3. The Xft library and xterm write this debugging
3250 trace to the standard output.
3251 Set this to “0” to disable fallbacks entirely.
3253 limitResize (class LimitResize)
3255 Limits resizing of the screen via control sequence to a given
3256 multiple of the display dimensions. The default is “1”.
3257 limitResponse (class LimitResponse)
3259 Limits the buffer-size used when xterm replies to various
3260 control sequences. The default is “1024”. The minimum value
3261 is “256”.
3262 locale (class Locale)
3264 Specifies how to use luit, an encoding converter between UTF-8
3265 and locale encodings. The resource value (ignoring case) may
3266 be:
3267 true
3269 Xterm will use the encoding specified by the users'
3270 LC_CTYPE locale (i.e., LC_ALL, LC_CTYPE, or LANG variables)
3271 as far as possible. This is realized by always enabling
3272 UTF-8 mode and invoking luit in non-UTF-8 locales.
3273 medium
3275 Xterm will follow users' LC_CTYPE locale only for UTF-8,
3276 east Asian, and Thai locales, where the encodings were not
3277 supported by conventional 8bit mode with changing fonts.
3278 For other locales, xterm will use conventional 8bit mode.
3279 checkfont
3281 If mini-luit is compiled-in, xterm will check if a Unicode
3282 font has been specified. If so, it checks if the character
3283 encoding for the current locale is POSIX, Latin-1 or
3284 Latin-9, uses the appropriate mapping to support those with
3285 the Unicode font. For other encodings, xterm assumes that
3286 UTF-8 encoding is required.
3287 false
3289 Xterm will use conventional 8bit mode or UTF-8 mode
3290 according to utf8 resource or -u8 option.
3291 Any other value, e.g., “UTF-8” or “ISO8859-2”, is assumed to be
3293 an encoding name; luit will be invoked to support the encoding.
3294 The actual list of supported encodings depends on luit. The
3295 default is “medium”.
3296 Regardless of your locale and encoding, you need an ISO-10646-1
3298 font to display the result. Your configuration may not include
3299 this font, or locale-support by xterm may not be needed.
3300 At startup, xterm uses a mechanism equivalent to the
3302 load-vt-fonts(utf8Fonts, Utf8Fonts) action to load font name
3303 subresources of the VT100 widget. That is, resource patterns
3304 such as “*vt100.utf8Fonts.font” will be loaded, and (if this
3305 resource is enabled), override the normal fonts. If no
3306 subresources are found, the normal fonts such as “*vt100.font”,
3307 etc., are used.
3308 For instance, you could have this in your resource file:
3310 *VT100.font: 12x24
3312 *VT100.utf8Fonts.font:9x15
3313 When started with a UTF-8 locale, xterm would use 9x15, but
3315 allow you to switch to the 12x24 font using the menu entry
3316 “UTF-8 Fonts”.
3317 The resource files distributed with xterm use ISO-10646-1
3319 fonts, but do not rely on them unless you are using the locale
3320 mechanism.
3321 localeFilter (class LocaleFilter)
3323 Specifies the file name for the encoding converter from/to
3324 locale encodings and UTF-8 which is used with the -lc option or
3325 locale resource. The help message shown by “xterm -help” lists
3326 the default value, which depends on your system configuration.
3327 If the encoding converter requires command-line parameters, you
3329 can add those after the command, e.g.,
3330 *localeFilter: xterm-filter -p
3332 Alternatively, you may put those parameter within a shell
3334 script to execute the converter, and set this resource to point
3335 to the shell script.
3336 When using a locale-filter, e.g., with the -e option, or the
3338 shell, xterm first tries passing control via that filter. If
3339 it fails, xterm will retry without the locale-filter. Xterm
3340 warns about the failure before retrying.
3341 logFile (class Logfile)
3343 Specify the name for xterm's log file. If no name is
3344 specified, xterm will generate a name when logging is enabled,
3345 as described in the -l option.
3346 logInhibit (class LogInhibit)
3348 If “true”, prevent the logging feature from being enabled,
3349 whether by the command-line option -l, or the menu entry Log to
3350 File. The default is “false”.
3351 logging (class Logging)
3353 If “true”, (and if logInhibit is not set) enable the logging
3354 feature. This resource is set/updated by the -l option and the
3355 menu entry Log to File. The default is “false”.
3356 loginShell (class LoginShell)
3358 Specifies whether or not the shell to be run in the window
3359 should be started as a login shell. The default is “false”.
3360 marginBell (class MarginBell)
3362 Specifies whether or not the bell should be rung when the user
3363 types near the right margin. The default is “false”.
3364 maxGraphicSize (class MaxGraphicSize)
3366 If xterm is configured to support ReGIS or SIXEL graphics, this
3367 resource controls the maximum size of a graph which can be
3368 displayed.
3369 The default is “1000x1000” (given as width by height).
3371 If the resource is “auto” then xterm will use the decGraphicsID
3373 resource (or decTerminalID if that is not set):
3374 Result decGraphicsID
3376 ────────────────────────
3377 768x400 125
3378 800x460 240
3379 800x460 241
3380 800x480 330
3381 800x480 340
3382 860x750 382
3383 800x480 other
3384 metaSendsEscape (class MetaSendsEscape)
3386 Tells xterm what to do with input-characters modified by Meta:
3387 · If “true”, Meta characters (a character combined with the
3389 Meta modifier key) are converted into a two-character
3390 sequence with the character itself preceded by ESC. This
3391 applies as well to function key control sequences, unless
3392 xterm sees that Meta is used in your key translations.
3393 · If “false”, Meta characters input from the keyboard are
3395 handled according to the eightBitInput resource.
3396 The default is “True”.
3398 mkSamplePass (class MkSamplePass)
3400 If mkSampleSize is nonzero, and mkWidth (and cjkWidth) are
3401 false, on startup xterm compares its built-in tables to the
3402 system's wide character width data to decide if it will use the
3403 system's data. It tests the first mkSampleSize character
3404 values, and allows up to mkSamplePass mismatches before the
3405 test fails. The default (for the allowed number of mismatches)
3406 is 655 (one percent of the default value for mkSampleSize).
3407 mkSampleSize (class MkSampleSize)
3409 With mkSamplePass, this specifies a startup test used for
3410 initializing wide character width calculations. The default
3411 (number of characters to check) is 65536.
3412 mkWidth (class MkWidth)
3414 Specifies whether xterm should use a built-in version of the
3415 wide character width calculation. See also the cjkWidth
3416 resource which can override this. The default is “false”.
3417 Here is a summary of the resources which control the choice of
3419 wide character width calculation:
3420 cjkWidth mkWidth Action
3422 ───────────────────────────────────────────────────────────────
3423 false false use system tables subject to mkSamplePass
3424 false true use built-in tables
3425 true false use built-in CJK tables
3426 true true use built-in CJK tables
3427 To disable mkWidth, and use the system's tables, set both
3429 mkSampleSize and mkSamplePass to “0”. Doing that may make
3430 xterm more consistent with applications running in xterm, but
3431 may omit some font glyphs whose width correctly differs from
3432 the system's character tables.
3433 modifyCursorKeys (class ModifyCursorKeys)
3435 Tells how to handle the special case where Control-, Shift-,
3436 Alt- or Meta-modifiers are used to add a parameter to the
3437 escape sequence returned by a cursor-key. The default is “2”:
3438 -1 disables the feature.
3440 0 uses the old/obsolete behavior, i.e., the modifier is the
3442 first parameter.
3443 1 prefixes modified sequences with CSI.
3445 2 forces the modifier to be the second parameter if it would
3447 otherwise be the first.
3448 3 marks the sequence with a “>” to hint that it is private.
3450 modifyFunctionKeys (class ModifyFunctionKeys)
3452 Tells how to handle the special case where Control-, Shift-,
3453 Alt- or Meta-modifiers are used to add a parameter to the
3454 escape sequence returned by a (numbered) function-key. The
3455 default is “2”. The resource values are similar to
3456 modifyCursorKeys:
3457 -1 permits the user to use shift- and control-modifiers to
3459 construct function-key strings using the normal encoding
3460 scheme.
3461 0 uses the old/obsolete behavior, i.e., the modifier is the
3463 first parameter.
3464 1 prefixes modified sequences with CSI.
3466 2 forces the modifier to be the second parameter if it would
3468 otherwise be the first.
3469 3 marks the sequence with a “>” to hint that it is private.
3471 If modifyFunctionKeys is zero, xterm uses Control- and Shift-
3473 modifiers to allow the user to construct numbered function-keys
3474 beyond the set provided by the keyboard:
3475 Control
3477 adds the value given by the ctrlFKeys resource.
3478 Shift
3480 adds twice the value given by the ctrlFKeys resource.
3481 Control/Shift
3483 adds three times the value given by the ctrlFKeys
3484 resource.
3485 modifyKeyboard (class ModifyKeyboard)
3487 Normally xterm makes a special case regarding modifiers (shift,
3488 control, etc.) to handle special keyboard layouts (legacy and
3489 vt220). This is done to provide compatible keyboards for DEC
3490 VT220 and related terminals that implement user-defined keys
3491 (UDK).
3492 The bits of the resource value selectively enable modification
3494 of the given category when these keyboards are selected. The
3495 default is “0”:
3496 0 The legacy/vt220 keyboards interpret only the Control-
3498 modifier when constructing numbered function-keys. Other
3499 special keys are not modified.
3500 1 allows modification of the numeric keypad
3502 2 allows modification of the editing keypad
3504 4 allows modification of function-keys, overrides use of
3506 Shift-modifier for UDK.
3507 8 allows modification of other special keys
3509 modifyOtherKeys (class ModifyOtherKeys)
3511 Like modifyCursorKeys, tells xterm to construct an escape
3512 sequence for ordinary (i.e., “other”) keys (such as “2”) when
3513 modified by Shift-, Control-, Alt- or Meta-modifiers. This
3514 feature does not apply to special keys, i.e., cursor-, keypad-,
3515 function- or control-keys which are labeled on your keyboard.
3516 Those have key symbols which XKB identifies uniquely.
3517 For example, this feature does not apply to special control-
3519 keys (e.g., Escape, Tab, Enter, Backspace) Other control keys
3520 (e.g., Control-I, Control-M, Control-H) may send escape
3521 sequences when this feature is enabled.
3522 The default is “0”:
3524 0 disables this feature.
3526 1 enables this feature for keys except for those with well-
3528 known behavior, e.g., Tab, Backarrow and some special
3529 control character cases which are built into the X11
3530 library, e.g., Control-Space to make a NUL, or Control-3
3531 to make an Escape character.
3532 Except for those special cases built into the X11 library,
3534 the Shift- and Control- modifiers are treated normally.
3535 The Alt- and Meta- modifiers do not cause xterm to send
3536 escape sequences. Those modifier keys are interpreted
3537 according to other resources, e.g., the metaSendsEscape
3538 resource.
3539 2 enables this feature for keys including the exceptions
3541 listed. Xterm ignores the special cases built into the
3542 X11 library. Any shifted (modified) ordinary key sends an
3543 escape sequence. The Alt- and Meta- modifiers cause xterm
3544 to send escape sequences.
3545 The Xterm FAQ has an extended discussion of this feature, with
3547 examples:
3548 https://invisible-island.net/xterm/modified-keys.html
3550 multiClickTime (class MultiClickTime)
3552 Specifies the maximum time in milliseconds between multi-click
3553 select events. The default is “250” milliseconds.
3554 multiScroll (class MultiScroll)
3556 Specifies whether or not scrolling should be done
3557 asynchronously. The default is “false”.
3558 nMarginBell (class Column)
3560 Specifies the number of characters from the right margin at
3561 which the margin bell should be rung, when enabled by the
3562 marginBell resource. The default is “10”.
3563 nameKeymap (class NameKeymap)
3565 See the discussion of the keymap() action.
3566 nextEventDelay (class NextEventDelay)
3568 Specifies a delay time in milliseconds before checking for new
3569 X events. The default is “1”.
3570 numColorRegisters (class NumColorRegisters)
3572 If xterm is configured to support ReGIS or SIXEL graphics, this
3573 specifies the number of color-registers which are available.
3574 If this resource is not specified, xterm uses a value
3576 determined by the decTerminalID resource:
3577 Result decTerminalID
3579 ───────────────────────
3580 4 125
3581 4 240
3582 4 241
3583 4 330
3584 16 340
3585 2 382
3586 1024 other
3587 numLock (class NumLock)
3589 If “true”, xterm checks if NumLock is used as a modifier (see
3590 xmodmap(1)). If so, this modifier is used to simplify the
3591 logic when implementing special NumLock for the sunKeyboard
3592 resource. Also (when sunKeyboard is false), similar logic is
3593 used to find the modifier associated with the left and right
3594 Alt keys. The default is “true”.
3595 oldXtermFKeys (class OldXtermFKeys)
3597 If “true”, xterm will use old-style (X11R5) escape sequences
3598 for function keys F1 to F4, for compatibility with X Consortium
3599 xterm. Otherwise, it uses the VT100 codes for PF1 to PF4. The
3600 default is “false”.
3601 Setting this resource has the same effect as setting the
3603 keyboardType to legacy. The keyboardType resource is the
3604 preferred mechanism for selecting this mode.
3605 The old-style escape sequences resemble VT220 keys, but appear
3607 to have been invented for xterm in X11R4.
3608 on2Clicks (class On2Clicks)
3610 on3Clicks (class On3Clicks)
3612 on4Clicks (class On4Clicks)
3614 on5Clicks (class On5Clicks)
3616 Specify selection behavior in response to multiple mouse
3617 clicks. A single mouse click is always interpreted as
3618 described in the Selection Functions section (see POINTER
3619 USAGE). Multiple mouse clicks (using the button which
3620 activates the select-start action) are interpreted according to
3621 the resource values of on2Clicks, etc. The resource value can
3622 be one of these:
3623 word
3625 Select a “word” as determined by the charClass resource.
3626 See the CHARACTER CLASSES section.
3627 If the pointer is on a “word” then xterm searches back to
3629 the beginning of the word, and then to the end.
3630 If the pointer is not on a “word” then the result depends on
3632 whether it is on whitespace (including a newline), or past
3633 the end of the line. In the latter case xterm may select a
3634 “word” beginning after the newline, if there is no
3635 additional whitespace.
3636 line
3638 Select a line (counting wrapping).
3639 group
3641 Select a group of adjacent lines (counting wrapping). The
3642 selection stops on a blank line, and does not extend outside
3643 the current page.
3644 page
3646 Select all visible lines, i.e., the page.
3647 all
3649 Select all lines, i.e., including the saved lines.
3650 regex
3652 Select the best match for the POSIX extended regular
3653 expression (ERE) which follows in the resource value:
3654 · Xterm matches the regular expression against a byte
3656 array for the entire (possibly wrapped) line. That byte
3657 array may be UTF-8 or ISO-8859-1, depending on the mode
3658 in which xterm is running.
3659 · Xterm steps through each byte-offset in this array,
3661 keeping track of the best (longest) match. If more than
3662 one match ties for the longest length, the first is
3663 used.
3664 Xterm does this to make it convenient to click anywhere
3666 in the area of interest and cause the regular expression
3667 to match the entire word, etc.
3668 · The “^” and “$” anchors in a regular expression denote
3670 the ends of the entire line.
3671 · If the regular expression contains backslashes “\” those
3673 should be escaped “\\” because the X libraries interpret
3674 backslashes in resource strings.
3675 none
3677 No selection action is associated with this resource. Xterm
3678 interprets it as the end of the list. For example, you may
3679 use it to disable triple (and higher) clicking by setting
3680 on3Clicks to “none”.
3681 The default values for on2Clicks and on3Clicks are “word” and
3683 “line”, respectively. There is no default value for on4Clicks
3684 or on5Clicks, making those inactive. On startup, xterm
3685 determines the maximum number of clicks by the onXClicks
3686 resource values which are set.
3687 openIm (class OpenIm)
3689 Tells xterm whether to open the input method at startup. The
3690 default is “true”.
3691 pointerColor (class PointerColor)
3693 Specifies the foreground color of the pointer. The default is
3694 “XtDefaultForeground”.
3695 pointerColorBackground (class PointerColorBackground)
3697 Specifies the background color of the pointer. The default is
3698 “XtDefaultBackground”.
3699 pointerFont (class PointerFont)
3701 Specifies the font to be used for the pointer. The shapes
3702 specified by pointerShape are glyphs in this font. The
3703 resource value default is cursor.
3704 pointerMode (class PointerMode)
3706 Specifies when the pointer may be hidden as the user types. It
3707 will be redisplayed if the user moves the mouse, or clicks one
3708 of its buttons.
3709 0 never
3711 1 the application running in xterm has not activated mouse
3713 mode. This is the default.
3714 2 always.
3716 pointerShape (class Cursor)
3718 Specifies the name of the shape of the pointer. The default is
3719 “xterm”.
3720 popOnBell (class PopOnBell)
3722 Specifies whether the window would be raised when Control-G is
3723 received. The default is “false”.
3724 If the window is iconified, this has no effect. However, the
3726 zIconBeep resource provides you with the ability to see which
3727 iconified windows have sounded a bell.
3728 precompose (class Precompose)
3730 Tells xterm whether to precompose UTF-8 data into Normalization
3731 Form C, which combines commonly-used accents onto base
3732 characters. If it does not do this, accents are left as
3733 separate characters. The default is “true”.
3734 preeditType (class PreeditType)
3736 Tells xterm which types of preedit (preconversion) string to
3737 display. The default is “OverTheSpot,Root”.
3738 printAttributes (class PrintAttributes)
3740 Specifies whether to print graphic attributes along with the
3741 text. A real DEC VTxxx terminal will print the underline,
3742 highlighting codes but your printer may not handle these.
3743 · “0” disables the attributes.
3745 · “1” prints the normal set of attributes (bold, underline,
3747 inverse and blink) as VT100-style control sequences.
3748 · “2” prints ANSI color attributes as well.
3750 The default is “1”.
3752 printFileImmediate (class PrintFileImmediate)
3754 When the print-immediate action is invoked, xterm prints the
3755 screen contents directly to a file. Set this resource to the
3756 prefix of the filename (a timestamp will be appended to the
3757 actual name).
3758 The default is an empty string, i.e., “”, However, when the
3760 print-immediate action is invoked, if the string is empty, then
3761 “XTerm” is used.
3762 printFileOnXError (class PrintFileOnXError)
3764 If xterm exits with an X error, e.g., your connection is broken
3765 when the server crashes, it can be told to write the contents
3766 of the screen to a file. To enable the feature, set this
3767 resource to the prefix of the filename (a timestamp will be
3768 appended to the actual name).
3769 The default is an empty string, i.e., “”, which disables this
3771 feature. However, when the print-on-error action is invoked,
3772 if the string is empty, then “XTermError” is used.
3773 These error codes are handled: ERROR_XERROR, ERROR_XIOERROR and
3775 ERROR_ICEERROR.
3776 printModeImmediate (class PrintModeImmediate)
3778 When the print-immediate action is invoked, xterm prints the
3779 screen contents directly to a file. You can use the
3780 printModeImmediate resource to tell it to use escape sequences
3781 to reconstruct the video attributes and colors. This uses the
3782 same values as the printAttributes resource. The default is
3783 “0”.
3784 printModeOnXError (class PrintModeOnXError)
3786 Xterm implements the printFileOnXError feature using the
3787 printer feature, although the output is written directly to a
3788 file. You can use the printModeOnXError resource to tell it to
3789 use escape sequences to reconstruct the video attributes and
3790 colors. This uses the same values as the printAttributes
3791 resource. The default is “0”.
3792 printOptsImmediate (class PrintOptsImmediate)
3794 Specify the range of text which is printed to a file when the
3795 print-immediate action is invoked.
3796 · If zero (0), then this selects the current (visible screen)
3798 plus the saved lines, except if the alternate screen is
3799 being used. In that case, only the alternate screen is
3800 selected.
3801 · If nonzero, the bits of this resource value (checked in
3803 descending order) select the range:
3804 8 selects the saved lines.
3806 4 selects the alternate screen.
3808 2 selects the normal screen.
3810 1 selects the current screen, which can be either the
3812 normal or alternate screen.
3813 The default is “9”, which selects the current visible screen
3815 plus saved lines, with no special case for the alternated
3816 screen.
3817 printOptsOnXError (class PrintOptsOnXError)
3819 Specify the range of text which is printed to a file when the
3820 print-on-error action is invoked. The resource value is
3821 interpreted the same as in printOptsImmediate.
3822 The default is “9”, which selects the current visible screen
3824 plus saved lines, with no special case for the alternated
3825 screen.
3826 printerAutoClose (class PrinterAutoClose)
3828 If “true”, xterm will close the printer (a pipe) when the
3829 application switches the printer offline with a Media Copy
3830 command. The default is “false”.
3831 printerCommand (class PrinterCommand)
3833 Specifies a shell command to which xterm will open a pipe when
3834 the first MC (Media Copy) command is initiated. The default is
3835 an empty string, i.e., “”. If the resource value is given as
3836 an empty string, the printer is disabled.
3837 printerControlMode (class PrinterControlMode)
3839 Specifies the printer control mode. A “1” selects autoprint
3840 mode, which causes xterm to print a line from the screen when
3841 · you move the cursor off that line with a line feed, form
3843 feed or vertical tab character, or
3844 · an autowrap occurs.
3846 Autoprint mode is overridden by printer controller mode (a
3848 “2”), which causes all of the output to be directed to the
3849 printer. The default is “0”.
3850 printerExtent (class PrinterExtent)
3852 Controls whether a print page function will print the entire
3853 page (true), or only the portion within the scrolling margins
3854 (false). The default is “false”.
3855 printerFormFeed (class PrinterFormFeed)
3857 Controls whether a form feed is sent to the printer at the end
3858 of a print page function. The default is “false”.
3859 printerNewLine (class PrinterNewLine)
3861 Controls whether a newline is sent to the printer at the end of
3862 a print page function. The default is “true”.
3863 privateColorRegisters (class PrivateColorRegisters)
3865 If xterm is configured to support ReGIS or SIXEL graphics, this
3866 controls whether xterm allocates separate color registers for
3867 each sixel device control string, e.g., for DECGCI. If not
3868 true, color registers are allocated only once, when the
3869 terminal is reset, and color changes in any graphic affect
3870 all graphics. The default is “true”.
3871 quietGrab (class QuietGrab)
3873 Controls whether the cursor is repainted when NotifyGrab and
3874 NotifyUngrab event types are received during change of focus.
3875 The default is “false”.
3876 regisDefaultFont (class RegisDefaultFont)
3878 If xterm is configured to support ReGIS graphics, this resource
3879 tells xterm which font to use if the ReGIS data does not
3880 specify one. No default value is specified; xterm accepts a
3881 TrueType font specification as in the faceName resource.
3882 If no value is specified, xterm draws a bitmap indicating a
3884 missing character.
3885 regisScreenSize (class RegisScreenSize)
3887 If xterm is configured to support ReGIS graphics, this resource
3888 tells xterm the default size (in pixels) for these graphics,
3889 which also sets the default coordinate space to [0,0] (upper-
3890 left) and [width,height] (lower-right).
3891 The application using ReGIS may use the “A” option of the “S”
3893 command to adjust the coordinate space or change the
3894 addressable portion of the screen.
3895 Xterm accepts a special resource value “auto”, which tells
3897 xterm to use the decGraphicsID and decTerminalID resources to
3898 set the default size based on the hardware terminal's limits.
3899 Those limits are the same as for the maxGraphicSize resource.
3900 The default is “auto”.
3902 renderFont (class RenderFont)
3904 If xterm is built with the Xft library, this controls whether
3905 the faceName resource is used. The default is “default”.
3906 The resource values are strings, evaluated as booleans after
3908 startup.
3909 false
3911 disable the feature and use the normal (bitmap) font.
3912 true
3914 startup using the TrueType font specified by the faceName
3915 and faceSize resource settings. If there is no value for
3916 faceName, disable the feature and use the normal (bitmap)
3917 font.
3918 After startup, you can still switch to/from the bitmap
3920 font using the “TrueType Fonts” menu entry.
3921 default
3923 Enable the “TrueType Fonts” menu entry to allow runtime
3924 switching to/from TrueType fonts. The initial font used
3925 depends upon whether the faceName resource is set:
3926 · If the faceName resource is not set, start by using
3928 the normal (bitmap) font. Xterm has a separate
3929 compiled-in value for faceName for this special case.
3930 That is normally “mono”.
3931 · If the faceName resource is set, then start by using
3933 the TrueType font rather than the bitmap font.
3934 resizeGravity (class ResizeGravity)
3936 Affects the behavior when the window is resized to be taller or
3937 shorter. NorthWest specifies that the top line of text on the
3938 screen stay fixed. If the window is made shorter, lines are
3939 dropped from the bottom; if the window is made taller, blank
3940 lines are added at the bottom. This is compatible with the
3941 behavior in X11R4. SouthWest (the default) specifies that the
3942 bottom line of text on the screen stay fixed. If the window is
3943 made taller, additional saved lines will be scrolled down onto
3944 the screen; if the window is made shorter, lines will be
3945 scrolled off the top of the screen, and the top saved lines
3946 will be dropped.
3947 retryInputMethod (class RetryInputMethod)
3949 Tells xterm how many times to retry, in case the input-method
3950 server is not responding. This is a different issue than
3951 unsupported preedit type, etc. You may encounter retries if
3952 your X configuration (and its libraries) are missing pieces.
3953 Setting this resource to zero “0” will cancel the retrying.
3954 The default is “3”.
3955 reverseVideo (class ReverseVideo)
3957 Specifies whether or not reverse video should be simulated.
3958 The default is “false”.
3959 There are several aspects to reverse video in xterm:
3961 · The command-line -rv option tells the X libraries to
3963 reverse the foreground and background colors. Xterm's
3964 command-line options set resource values. In particular,
3965 the X Toolkit sets the reverseVideo resource when the -rv
3966 option is used.
3967 · If the user has also used command-line options -fg or -bg
3969 to set the foreground and background colors, xterm does not
3970 see these options directly. Instead, it examines the
3971 resource values to reconstruct the command-line options,
3972 and determine which of the colors is the user's intended
3973 foreground, etc. Their actual values are irrelevant to the
3974 reverse video function; some users prefer the X defaults
3975 (black text on a white background), others prefer white
3976 text on a black background.
3977 · After startup, the user can toggle the “Enable Reverse
3979 Video” menu entry. This exchanges the current foreground
3980 and background colors of the VT100 widget, and repaints the
3981 screen. Because of the X resource hierarchy, the
3982 reverseVideo resource applies to more than the VT100
3983 widget.
3984 Programs running in an xterm can also use control sequences to
3986 enable the VT100 reverse video mode. These are independent of
3987 the reverseVideo resource and the menu entry. Xterm exchanges
3988 the current foreground and background colors when drawing text
3989 affected by these control sequences.
3990 Other control sequences can alter the foreground and background
3992 colors which are used:
3993 · Programs can also use the ANSI color control sequences to
3995 set the foreground and background colors.
3996 · Extensions to the ANSI color controls (such as 16-, 88- or
3998 256-colors) are treated similarly to the ANSI control.
3999 · Using other control sequences (the “dynamic colors”
4001 feature), a program can change the foreground and
4002 background colors.
4003 reverseWrap (class ReverseWrap)
4005 Specifies whether or not reverse-wraparound should be enabled.
4006 This corresponds to xterm's private mode 45. The default is
4007 “false”.
4008 rightScrollBar (class RightScrollBar)
4010 Specifies whether or not the scrollbar should be displayed on
4011 the right rather than the left. The default is “false”.
4012 saveLines (class SaveLines)
4014 Specifies the number of lines to save beyond the top of the
4015 screen when a scrollbar is turned on. The default is “1024”.
4016 scrollBar (class ScrollBar)
4018 Specifies whether or not the scrollbar should be displayed.
4019 The default is “false”.
4020 scrollBarBorder (class ScrollBarBorder)
4022 Specifies the width of the scrollbar border. Note that this is
4023 drawn to overlap the border of the xterm window. Modifying the
4024 scrollbar's border affects only the line between the VT100
4025 widget and the scrollbar. The default value is 1.
4026 scrollKey (class ScrollCond)
4028 Specifies whether or not pressing a key should automatically
4029 cause the scrollbar to go to the bottom of the scrolling
4030 region. This corresponds to xterm's private mode 1011. The
4031 default is “false”.
4032 scrollLines (class ScrollLines)
4034 Specifies the number of lines that the scroll-back and
4035 scroll-forw actions should use as a default. The default value
4036 is 1.
4037 scrollTtyOutput (class ScrollCond)
4039 Specifies whether or not output to the terminal should
4040 automatically cause the scrollbar to go to the bottom of the
4041 scrolling region. The default is “true”.
4042 selectToClipboard (class SelectToClipboard)
4044 Tells xterm whether to use the PRIMARY or CLIPBOARD for SELECT
4045 tokens in the selection mechanism. The set-select action can
4046 change this at runtime, allowing the user to work with programs
4047 that handle only one of these mechanisms. The default is
4048 “false”, which tells it to use PRIMARY.
4049 shiftEscape (class ShiftEscape)
4051 Xterm uses the translations resource to determine how to invoke
4052 actions for selecting and copying text using the pointer (e.g.,
4053 a mouse). It also provides a mouse protocol which can be used
4054 by applications running in an xterm to detect mouse button
4055 clicks.
4056 The mouse protocol causes xterm to send special escape
4058 sequences which allow an application to determine if modifiers
4059 (i.e., one or more of shift, control, alt, and meta) were used.
4060 Xterm provides this mouse protocol by interpreting button- and
4062 motion-events in the functions which the translations resource
4063 calls for selecting and copying text:
4064 insert-selection
4066 select-end
4067 select-extend
4068 select-start
4069 start-extend
4070 While the mouse protocol is active, xterm reserves most of the
4072 mouse button events for sending special escape sequences to the
4073 application. Xterm normally allows you to use the shift-key to
4074 temporarily override this mouse protocol, permitting the
4075 selection and copying actions to be used.
4076 The shiftEscape resource setting allows you to tell xterm
4078 whether to use the shift-key in this way (i.e., overriding the
4079 mouse protocol). Xterm accepts either a keyword (ignoring
4080 case) or the number shown in parentheses:
4081 false (0)
4083 Mouse protocol does not send special escapes when shift-key
4084 is used.
4085 true (1)
4087 Mouse protocol may send special escapes when shift-key is
4088 used.
4089 At startup, xterm analyzes the translations to see which
4091 buttons are used in the (mouse) button-related bindings for
4092 selection and copying text. If the shift-key is not
4093 mentioned explicitly in a button's binding, xterm allows
4094 that button with shift-key for overriding the mouse
4095 protocol.
4096 always (2)
4098 Mouse protocol can always send special escapes when shift-
4099 key is used.
4100 never (3)
4102 Mouse protocol will never send special escapes when shift-
4103 key is used.
4104 Xterm interprets a control sequence which can change this
4106 setting between “true” and “false”. The default is “false”.
4107 shiftFonts (class ShiftFonts)
4109 Specifies whether to enable the actions larger-vt-font() and
4110 smaller-vt-font(), which are normally bound to the shifted
4111 KP_Add and KP_Subtract. The default is “true”.
4112 showBlinkAsBold (class ShowBlinkAsBold)
4114 Tells xterm whether to display text with blink-attribute the
4115 same as bold. If xterm has not been configured to support
4116 blinking text, the default is “true”, which corresponds to
4117 older versions of xterm, otherwise the default is “false”.
4118 showMissingGlyphs (class ShowMissingGlyphs)
4120 Tells xterm whether to display a box outlining places where a
4121 character has been used that the font does not represent. The
4122 default is “false”.
4123 showWrapMarks (class ShowWrapMarks)
4125 For debugging xterm and applications that may manipulate the
4126 wrapped-line flag by writing text at the right margin, show a
4127 mark on the right inner-border of the window. The mark shows
4128 which lines have the flag set.
4129 signalInhibit (class SignalInhibit)
4131 Specifies whether or not the entries in the Main Options menu
4132 for sending signals to xterm should be disallowed. The default
4133 is “false”.
4134 sixelScrolling (class SixelScrolling)
4136 If xterm is configured to support SIXEL graphics, this resource
4137 tells it whether to scroll up one line at a time when sixels
4138 would be written past the bottom line on the window. The
4139 default is “false”.
4140 sixelScrollsRight (class SixelScrollsRight)
4142 If xterm is configured to support SIXEL graphics, this resource
4143 tells it whether to scroll to the right as needed to keep the
4144 current position visible rather than truncate the plot on the
4145 on the right. The default is “false”.
4146 tekGeometry (class Geometry)
4148 Specifies the preferred size and position of the Tektronix
4149 window. There is no default for this resource.
4150 tekInhibit (class TekInhibit)
4152 Specifies whether or not the escape sequence to enter Tektronix
4153 mode should be ignored. The default is “false”.
4154 tekSmall (class TekSmall)
4156 Specifies whether or not the Tektronix mode window should start
4157 in its smallest size if no explicit geometry is given. This is
4158 useful when running xterm on displays with small screens. The
4159 default is “false”.
4160 tekStartup (class TekStartup)
4162 Specifies whether or not xterm should start up in Tektronix
4163 mode. The default is “false”.
4164 tiXtraScroll (class TiXtraScroll)
4166 Specifies whether xterm should scroll to a new page when
4167 processing the ti termcap entry, i.e., the private modes 47,
4168 1047 or 1049. This is only in effect if titeInhibit is “true”,
4169 because the intent of this option is to provide a picture of
4170 the full-screen application's display on the scrollback without
4171 wiping out the text that would be shown before the application
4172 was initialized. The default for this resource is “false”.
4173 titeInhibit (class TiteInhibit)
4175 Originally specified whether or not xterm should remove ti and
4176 te termcap entries (used to switch between alternate screens on
4177 startup of many screen-oriented programs) from the TERMCAP
4178 string.
4179 TERMCAP is used rarely now, but xterm supports the feature on
4181 modern systems:
4182 · If set, xterm also ignores the escape sequence to switch to
4184 the alternate screen.
4185 · Xterm supports terminfo in a different way, supporting
4187 composite control sequences (also known as private modes)
4188 1047, 1048 and 1049 which have the same effect as the
4189 original 47 control sequence.
4190 The default for this resource is “false”.
4192 titleModes (class TitleModes)
4194 Tells xterm whether to accept or return window- and icon-labels
4195 in ISO-8859-1 (the default) or UTF-8. Either can be encoded in
4196 hexadecimal:
4197 · UTF-8 titles require special treatment, because they may
4199 contain bytes which can be mistaken for control characters.
4200 Hexadecimal-encoding is supported to eliminate that
4201 possibility.
4202 · As an alternative, you could use the allowC1Printable
4204 resource, which suppresses xterm's parsing of the relevant
4205 control characters (and as a result, treats those bytes as
4206 data).
4207 The default for this resource is “0”.
4209 Each bit (bit “0” is 1, bit “1” is 2, etc.) corresponds to one
4211 of the parameters set by the title modes control sequence:
4212 0 Set window/icon labels using hexadecimal
4214 1 Query window/icon labels using hexadecimal
4216 2 Set window/icon labels using UTF-8 (gives the same effect
4218 as the utf8Title resource).
4219 3 Query window/icon labels using UTF-8
4221 translations (class Translations)
4223 Specifies the key and button bindings for menus, selections,
4224 “programmed strings”, etc. The translations resource, which
4225 provides much of xterm's configurability, is a feature of the X
4226 Toolkit Intrinsics library (Xt). See the Actions section.
4227 trimSelection (class TrimSelection)
4229 If you set highlightSelection, you can see the text which is
4230 selected, including any trailing spaces. Clearing the screen
4231 (or a line) resets it to a state containing no spaces. Some
4232 lines may contain trailing spaces when an application writes
4233 them to the screen. However, you may not wish to paste lines
4234 with trailing spaces. If this resource is true, xterm will
4235 trim trailing spaces from text which is selected. It does not
4236 affect spaces which result in a wrapped line, nor will it trim
4237 the trailing newline from your selection. The default is
4238 “false”.
4239 underLine (class UnderLine)
4241 This specifies whether or not text with the underline attribute
4242 should be underlined. It may be desirable to disable
4243 underlining when color is being used for the underline
4244 attribute. The default is “true”.
4245 useBorderClipping (class UseBorderClipping)
4247 Tell xterm whether to apply clipping when useClipping is false.
4248 Unlike useClipping, this simply limits text to keep it within
4249 the window borders, e.g., as a refinement to the scaleHeight
4250 workaround. The default is “false”.
4251 useClipping (class UseClipping)
4253 Tell xterm whether to use clipping to keep from producing dots
4254 outside the text drawing area. Originally used to work around
4255 for overstriking effects, this is also needed to work with some
4256 incorrectly-sized fonts. The default is “true”.
4257 utf8 (class Utf8)
4259 This specifies whether xterm will run in UTF-8 mode. If you
4260 set this resource, xterm also sets the wideChars resource as a
4261 side-effect. The resource can be set via the menu entry “UTF-8
4262 Encoding”. The default is “default”.
4263 Xterm accepts either a keyword (ignoring case) or the number
4265 shown in parentheses:
4266 false (0)
4268 UTF-8 mode is initially off. The command-line option +u8
4269 sets the resource to this value. Escape sequences for
4270 turning UTF-8 mode on/off are allowed.
4271 true (1)
4273 UTF-8 mode is initially on. Escape sequences for turning
4274 UTF-8 mode on/off are allowed.
4275 always (2)
4277 The command-line option -u8 sets the resource to this value.
4278 Escape sequences for turning UTF-8 mode on/off are ignored.
4279 default (3)
4281 This is the default value of the resource. It is changed
4282 during initialization depending on whether the locale
4283 resource was set, to false (0) or always (2). See the
4284 locale resource for additional discussion of non-UTF-8
4285 locales.
4286 If you want to set the value of utf8, it should be in this
4288 range. Other nonzero values are treated the same as “1”, i.e.,
4289 UTF-8 mode is initially on, and escape sequences for turning
4290 UTF-8 mode on/off are allowed.
4291 utf8Fonts (class Utf8Fonts)
4293 See the discussion of the locale resource. This specifies
4294 whether xterm will use UTF-8 fonts specified via resource
4295 patterns such as “*vt100.utf8Fonts.font” or normal (ISO-8859-1)
4296 fonts via patterns such as “*vt100.font”. The resource can be
4297 set via the menu entry “UTF-8 Fonts”. The default is
4298 “default”.
4299 Xterm accepts either a keyword (ignoring case) or the number
4301 shown in parentheses:
4302 false (0)
4304 Use the ISO-8859-1 fonts. The menu entry is enabled,
4305 allowing the choice of fonts to be changed at runtime.
4306 true (1)
4308 Use the UTF-8 fonts. The menu entry is enabled,
4309 allowing the choice of fonts to be changed at runtime.
4310 always (2)
4312 Always use the UTF-8 fonts. This also disables the menu
4313 entry.
4314 default (3)
4316 At startup, the resource is set to true or false,
4317 according to the effective value of the utf8 resource.
4318 utf8Latin1 (class Utf8Latin1)
4320 If true, allow an ISO-8859-1 normal font to be combined with an
4321 ISO-10646-1 font if the latter is given via the -fw option or
4322 its corresponding resource value. The default is “false”.
4323 utf8SelectTypes (class Utf8SelectTypes)
4325 Override xterm's default selection target list (see
4326 SELECT/PASTE) for selections in wide-character (UTF-8) mode.
4327 The default is an empty string, i.e., “”, which does not
4328 override anything.
4329 utf8Title (class Utf8Title)
4331 Applications can set xterm's title by writing a control
4332 sequence. Normally this control sequence follows the VT220
4333 convention, which encodes the string in ISO-8859-1 and allows
4334 for an 8-bit string terminator. If xterm is started in a UTF-8
4335 locale, it translates the ISO-8859-1 string to UTF-8 to work
4336 with the X libraries which assume the string is UTF-8.
4337 However, some users may wish to write a title string encoded in
4339 UTF-8. The window manager is responsible for drawing window
4340 titles. Some window managers (not all) support UTF-8 encoding
4341 of window titles. Set this resource to “true” to also set
4342 UTF-8 encoded title strings using the EWMH properties.
4343 This feature is available as a menu entry, since it is related
4345 to the particular applications you are running within xterm.
4346 You can also use a control sequence (see the discussion of
4347 “Title Modes” in Xterm Control Sequences), to set an equivalent
4348 flag (which can also be set using the titleModes resource).
4349 Xterm accepts either a keyword (ignoring case) or the number
4351 shown in parentheses:
4352 false (0)
4354 Set only ISO-8859-1 title strings, e.g., using the ICCCM
4355 WM_NAME STRING property. The menu entry is enabled,
4356 allowing the choice of title-strings to be changed at
4357 runtime.
4358 true (1)
4360 Set both the EWMH (UTF-8 strings) and the ICCCM WM_NAME,
4361 etc. The menu entry is enabled, allowing the choice to
4362 be changed at runtime.
4363 always (2)
4365 Always set both the EWMH (UTF-8 strings) and the ICCCM
4366 WM_NAME, etc. This also disables the menu entry.
4367 default (3)
4369 At startup, the resource is set to true or false,
4370 according to the effective value of the utf8 resource.
4371 The default is “default”.
4373 utf8Weblike (class Utf8Weblike)
4375 Provide an alternate error-handling scheme for ill-formed UTF-8
4376 as recommended in a W3C document. The Unicode standard does
4377 not require this for conformance. Some additional information
4378 can be found here:
4379 https://invisible-island.net/xterm/bad-utf8/
4381 The default is “false”.
4383 veryBoldColors (class VeryBoldColors)
4385 Specifies whether to combine video attributes with colors
4386 specified by colorBD, colorBL, colorIT, colorRV, and colorUL.
4387 The resource value is the sum of values for each attribute:
4388 1 for reverse,
4389 2 for underline,
4390 4 for bold,
4391 8 for blink, and
4392 512 for italic
4393 The default is “0”.
4395 visualBell (class VisualBell)
4397 Specifies whether or not a visible bell (i.e., flashing) should
4398 be used instead of an audible bell when Control-G is received.
4399 The default is “false”, which tells xterm to use an audible
4400 bell.
4401 visualBellDelay (class VisualBellDelay)
4403 Number of milliseconds to delay when displaying a visual bell.
4404 Default is 100. If set to zero, no visual bell is displayed.
4405 This is useful for very slow displays, e.g., an LCD display on
4406 a laptop.
4407 visualBellLine (class VisualBellLine)
4409 Specifies whether to flash only the current line when
4410 displaying a visual bell rather than flashing the entire
4411 screen: The default is “false”, which tells xterm to flash the
4412 entire screen.
4413 vt100Graphics (class VT100Graphics)
4415 This specifies whether xterm will interpret VT100 graphic
4416 character escape sequences while in UTF-8 mode. This feature
4417 also applies to code-pages (e.g., for VT320 and VT520) and
4418 National Replacement Character Sets (VT220 and up), but not US-
4419 ASCII (the initially selected character set), to avoid conflict
4420 with UTF-8. The default is “true”, to provide support for
4421 various legacy applications.
4422 wideBoldFont (class WideBoldFont)
4424 This option specifies the font to be used for displaying bold
4425 wide text. By default, it will attempt to use a font twice as
4426 wide as the font that will be used to draw bold text. If no
4427 double-width font is found, it will improvise, by stretching
4428 the bold font.
4429 wideChars (class WideChars)
4431 Specifies if xterm should respond to control sequences that
4432 process 16-bit characters. The default is “false”.
4433 wideFont (class WideFont)
4435 This option specifies the font to be used for displaying wide
4436 text. By default, it will attempt to use a font twice as wide
4437 as the font that will be used to draw normal text. If no
4438 double-width font is found, it will improvise, by stretching
4439 the normal font.
4440 ximFont (class XimFont)
4442 This option specifies the font to be used for displaying the
4443 preedit string in the “OverTheSpot” input method.
4444 In “OverTheSpot” preedit type, the preedit (preconversion)
4446 string is displayed at the position of the cursor. It is the
4447 XIM server's responsibility to display the preedit string. The
4448 XIM client must inform the XIM server of the cursor position.
4449 For best results, the preedit string must be displayed with a
4450 proper font. Therefore, xterm informs the XIM server of the
4451 proper font. The font is be supplied by a "fontset", whose
4452 default value is “*”. This matches every font, the X library
4453 automatically chooses fonts with proper charsets. The ximFont
4454 resource is provided to override this default font setting.
4455 Tek4014 Widget Resources
4457 The following resources are specified as part of the tek4014 widget
4458 (class Tek4014). These are specified by patterns such as
4459 “XTerm.tek4014.NAME”:
4460 font2 (class Font)
4462 Specifies font number 2 to use in the Tektronix window.
4463 font3 (class Font)
4465 Specifies font number 3 to use in the Tektronix window.
4466 fontLarge (class Font)
4468 Specifies the large font to use in the Tektronix window.
4469 fontSmall (class Font)
4471 Specifies the small font to use in the Tektronix window.
4472 ginTerminator (class GinTerminator)
4474 Specifies what character(s) should follow a GIN report or
4475 status report. The possibilities are “none”, which sends no
4476 terminating characters, “CRonly”, which sends CR, and “CR&EOT”,
4477 which sends both CR and EOT. The default is “none”.
4478 height (class Height)
4480 Specifies the height of the Tektronix window in pixels.
4481 initialFont (class InitialFont)
4483 Specifies which of the four Tektronix fonts to use initially.
4484 Values are the same as for the set-tek-text action. The
4485 default is “large”.
4486 width (class Width)
4488 Specifies the width of the Tektronix window in pixels.
4489 Menu Resources
4491 The resources that may be specified for the various menus are described
4492 in the documentation for the Athena SimpleMenu widget. The name and
4493 classes of the entries in each of the menus are listed below.
4494 Resources named “lineN” where N is a number are separators with class
4495 SmeLine.
4496 As with all X resource-based widgets, the labels mentioned are
4498 customary defaults for the application.
4499 The Main Options menu (widget name mainMenu) has the following entries:
4501 toolbar (class SmeBSB)
4503 This entry invokes the set-toolbar(toggle) action.
4504 securekbd (class SmeBSB)
4506 This entry invokes the secure() action.
4507 allowsends (class SmeBSB)
4509 This entry invokes the allow-send-events(toggle) action.
4510 redraw (class SmeBSB)
4512 This entry invokes the redraw() action.
4513 logging (class SmeBSB)
4515 This entry invokes the logging(toggle) action.
4516 print-immediate (class SmeBSB)
4518 This entry invokes the print-immediate() action.
4519 print-on-error (class SmeBSB)
4521 This entry invokes the print-on-error() action.
4522 print (class SmeBSB)
4524 This entry invokes the print() action.
4525 print-redir (class SmeBSB)
4527 This entry invokes the print-redir() action.
4528 dump-html (class SmeBSB)
4530 This entry invokes the dump-html() action.
4531 dump-svg (class SmeBSB)
4533 This entry invokes the dump-svg() action.
4534 8-bit-control (class SmeBSB)
4536 This entry invokes the set-8-bit-control(toggle) action.
4537 backarrow key (class SmeBSB)
4539 This entry invokes the set-backarrow(toggle) action.
4540 num-lock (class SmeBSB)
4542 This entry invokes the set-num-lock(toggle) action.
4543 alt-esc (class SmeBSB)
4545 This entry invokes the alt-sends-escape(toggle) action.
4546 meta-esc (class SmeBSB)
4548 This entry invokes the meta-sends-escape(toggle) action.
4549 delete-is-del (class SmeBSB)
4551 This entry invokes the delete-is-del(toggle) action.
4552 oldFunctionKeys (class SmeBSB)
4554 This entry invokes the set-old-function-keys(toggle) action.
4555 hpFunctionKeys (class SmeBSB)
4557 This entry invokes the set-hp-function-keys(toggle) action.
4558 scoFunctionKeys (class SmeBSB)
4560 This entry invokes the set-sco-function-keys(toggle) action.
4561 sunFunctionKeys (class SmeBSB)
4563 This entry invokes the set-sun-function-keys(toggle) action.
4564 sunKeyboard (class SmeBSB)
4566 This entry invokes the sunKeyboard(toggle) action.
4567 suspend (class SmeBSB)
4569 This entry invokes the send-signal(tstp) action on systems that
4570 support job control.
4571 continue (class SmeBSB)
4573 This entry invokes the send-signal(cont) action on systems that
4574 support job control.
4575 interrupt (class SmeBSB)
4577 This entry invokes the send-signal(int) action.
4578 hangup (class SmeBSB)
4580 This entry invokes the send-signal(hup) action.
4581 terminate (class SmeBSB)
4583 This entry invokes the send-signal(term) action.
4584 kill (class SmeBSB)
4586 This entry invokes the send-signal(kill) action.
4587 quit (class SmeBSB)
4589 This entry invokes the quit() action.
4590 The VT Options menu (widget name vtMenu) has the following entries:
4592 scrollbar (class SmeBSB)
4594 This entry invokes the set-scrollbar(toggle) action.
4595 jumpscroll (class SmeBSB)
4597 This entry invokes the set-jumpscroll(toggle) action.
4598 reversevideo (class SmeBSB)
4600 This entry invokes the set-reverse-video(toggle) action.
4601 autowrap (class SmeBSB)
4603 This entry invokes the set-autowrap(toggle) action.
4604 reversewrap (class SmeBSB)
4606 This entry invokes the set-reversewrap(toggle) action.
4607 autolinefeed (class SmeBSB)
4609 This entry invokes the set-autolinefeed(toggle) action.
4610 appcursor (class SmeBSB)
4612 This entry invokes the set-appcursor(toggle) action.
4613 appkeypad (class SmeBSB)
4615 This entry invokes the set-appkeypad(toggle) action.
4616 scrollkey (class SmeBSB)
4618 This entry invokes the set-scroll-on-key(toggle) action.
4619 scrollttyoutput (class SmeBSB)
4621 This entry invokes the set-scroll-on-tty-output(toggle) action.
4622 allow132 (class SmeBSB)
4624 This entry invokes the set-allow132(toggle) action.
4625 cursesemul (class SmeBSB)
4627 This entry invokes the set-cursesemul(toggle) action.
4628 keepSelection (class SmeBSB)
4630 This entry invokes the set-keep-selection(toggle) action.
4631 selectToClipboard (class SmeBSB)
4633 This entry invokes the set-keep-clipboard(toggle) action.
4634 visualbell (class SmeBSB)
4636 This entry invokes the set-visual-bell(toggle) action.
4637 bellIsUrgent (class SmeBSB)
4639 This entry invokes the set-bellIsUrgent(toggle) action.
4640 poponbell (class SmeBSB)
4642 This entry invokes the set-pop-on-bell(toggle) action.
4643 cursorblink (class SmeBSB)
4645 This entry invokes the set-cursorblink(toggle) action.
4646 titeInhibit (class SmeBSB)
4648 This entry invokes the set-titeInhibit(toggle) action.
4649 activeicon (class SmeBSB)
4651 This entry toggles active icons on and off if this feature was
4652 compiled into xterm. It is enabled only if xterm was started
4653 with the command line option +ai or the activeIcon resource is
4654 set to “true”.
4655 softreset (class SmeBSB)
4657 This entry invokes the soft-reset() action.
4658 hardreset (class SmeBSB)
4660 This entry invokes the hard-reset() action.
4661 clearsavedlines (class SmeBSB)
4663 This entry invokes the clear-saved-lines() action.
4664 tekshow (class SmeBSB)
4666 This entry invokes the set-visibility(tek,toggle) action.
4667 tekmode (class SmeBSB)
4669 This entry invokes the set-terminal-type(tek) action.
4670 vthide (class SmeBSB)
4672 This entry invokes the set-visibility(vt,off) action.
4673 altscreen (class SmeBSB)
4675 This entry invokes the set-altscreen(toggle) action.
4676 sixelScrolling (class SmeBSB)
4678 This entry invokes the set-sixel-scrolling(toggle) action.
4679 privateColorRegisters (class SmeBSB)
4681 This entry invokes the set-private-colors(toggle) action.
4682 The VT Fonts menu (widget name fontMenu) has the following entries:
4684 fontdefault (class SmeBSB)
4686 This entry invokes the set-vt-font(d) action, setting the font
4687 using the font (default) resource, e.g., “Default” in the menu.
4688 font1 (class SmeBSB)
4690 This entry invokes the set-vt-font(1) action, setting the font
4691 using the font1 resource, e.g., “Unreadable” in the menu.
4692 font2 (class SmeBSB)
4694 This entry invokes the set-vt-font(2) action, setting the font
4695 using the font2 resource, e.g., “Tiny” in the menu.
4696 font3 (class SmeBSB)
4698 This entry invokes the set-vt-font(3) action, setting the font
4699 using the font3 resource, e.g., “Small” in the menu.
4700 font4 (class SmeBSB)
4702 This entry invokes the set-vt-font(4) action, letting the font
4703 using the font4 resource, e.g., “Medium” in the menu.
4704 font5 (class SmeBSB)
4706 This entry invokes the set-vt-font(5) action, letting the font
4707 using the font5 resource, e.g., “Large” in the menu.
4708 font6 (class SmeBSB)
4710 This entry invokes the set-vt-font(6) action, letting the font
4711 using the font6 resource, e.g., “Huge” in the menu.
4712 font7 (class SmeBSB)
4714 This entry invokes the set-vt-font(7) action, letting the font
4715 using the font7 resource, e.g., “Enormous” in the menu.
4716 fontescape (class SmeBSB)
4718 This entry invokes the set-vt-font(e) action.
4719 fontsel (class SmeBSB)
4721 This entry invokes the set-vt-font(s) action.
4722 allow-bold-fonts (class SmeBSB)
4724 This entry invokes the allow-bold-fonts(toggle) action.
4725 font-linedrawing (class SmeBSB)
4727 This entry invokes the set-font-linedrawing(s) action.
4728 font-packed (class SmeBSB)
4730 This entry invokes the set-font-packed(s) action.
4731 font-doublesize (class SmeBSB)
4733 This entry invokes the set-font-doublesize(s) action.
4734 render-font (class SmeBSB)
4736 This entry invokes the set-render-font(s) action.
4737 utf8-fonts (class SmeBSB)
4739 This entry invokes the set-utf8-fonts(s) action.
4740 utf8-mode (class SmeBSB)
4742 This entry invokes the set-utf8-mode(s) action.
4743 utf8-title (class SmeBSB)
4745 This entry invokes the set-utf8-title(s) action.
4746 allow-color-ops (class SmeBSB)
4748 This entry invokes the allow-color-ops(toggle) action.
4749 allow-font-ops (class SmeBSB)
4751 This entry invokes the allow-fonts-ops(toggle) action.
4752 allow-tcap-ops (class SmeBSB)
4754 This entry invokes the allow-tcap-ops(toggle) action.
4755 allow-title-ops (class SmeBSB)
4757 This entry invokes the allow-title-ops(toggle) action.
4758 allow-window-ops (class SmeBSB)
4760 This entry invokes the allow-window-ops(toggle) action.
4761 The Tek Options menu (widget name tekMenu) has the following entries:
4763 tektextlarge (class SmeBSB)
4765 This entry invokes the set-tek-text(large) action.
4766 tektext2 (class SmeBSB)
4768 This entry invokes the set-tek-text(2) action.
4769 tektext3 (class SmeBSB)
4771 This entry invokes the set-tek-text(3) action.
4772 tektextsmall (class SmeBSB)
4774 This entry invokes the set-tek-text(small) action.
4775 tekpage (class SmeBSB)
4777 This entry invokes the tek-page() action.
4778 tekreset (class SmeBSB)
4780 This entry invokes the tek-reset() action.
4781 tekcopy (class SmeBSB)
4783 This entry invokes the tek-copy() action.
4784 vtshow (class SmeBSB)
4786 This entry invokes the set-visibility(vt,toggle) action.
4787 vtmode (class SmeBSB)
4789 This entry invokes the set-terminal-type(vt) action.
4790 tekhide (class SmeBSB)
4792 This entry invokes the set-visibility(tek,toggle) action.
4793 Scrollbar Resources
4795 The following resources are useful when specified for the Athena
4796 Scrollbar widget:
4797 background (class Background)
4799 Specifies the color to use for the background of the scrollbar.
4800 foreground (class Foreground)
4802 Specifies the color to use for the foreground of the scrollbar.
4803 thickness (class Thickness)
4805 Specifies the width in pixels of the scrollbar (default: 14).
4806 This may be overridden by the width resource.
4808 thumb (class Thumb)
4810 The default “thumb” pixmap used for the scrollbar is a simple
4811 checkerboard pattern alternating pixels for foreground and
4812 background color.
4813 width (class Width)
4815 Specifies the width in pixels of the scrollbar (default: 0).
4816 The widget checks the width resource first, using the thickness
4818 value if the width is zero.
4819
4821 Once the VTxxx window is created, xterm allows you to select text and
4822 copy it within the same or other windows using the pointer or the
4823 keyboard.
4824 A “pointer” could be a mouse, touchpad or similar device. X
4826 applications generally do not care, since they see only button events
4827 which have
4828 · position and
4830 · button up/down state
4832 Xterm can see these events as long as it has focus.
4834 The keyboard also supplies events, but it is less flexible than the
4836 pointer for selecting/copying text.
4837 Events are applied to actions using the translations resource. See
4839 Actions for a complete list, and Default Key Bindings for the built-in
4840 set of translations resources.
4841 Selection Functions
4843 By default, the selection functions are invoked when the pointer
4844 buttons are used with no modifiers, and when they are used with the
4845 “shift” key. The “shift” key is special, because xterm uses that to
4846 ensure that selection functions are still available when it is
4847 programmed to send escape sequences in one of the mouse modes (see
4848 Xterm Control Sequences, as well as the resource disallowedMouseOps).
4849 At startup, xterm inspects the translations resource to see which
4851 pointer buttons may be used in this way, and remembers these buttons
4852 when deciding whether to send escape sequences or perform selection
4853 when those buttons are used with the “shift” modifier. Other pointer
4854 buttons, e.g., typically those sent for wheel mouse events, are not
4855 affected.
4856 The assignment of the functions described below to keys and buttons may
4858 be changed through the resource database; see Actions below.
4859 Pointer button one (usually left)
4861 is used to save text into the cut buffer:
4862 ~Meta <Btn1Down>:select-start()
4864 Move the cursor to beginning of the text, and then hold the button
4866 down while moving the cursor to the end of the region and
4867 releasing the button. The selected text is highlighted and is
4868 saved in the global cut buffer and made the selection when the
4869 button is released:
4870 <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n
4872 Normally (but see the discussion of on2Clicks, etc):
4874 · Double-clicking selects by words.
4876 · Triple-clicking selects by lines.
4878 · Quadruple-clicking goes back to characters, etc.
4880 Multiple-click is determined by the time from button up to button
4882 down, so you can change the selection unit in the middle of a
4883 selection. Logical words and lines selected by double- or triple-
4884 clicking may wrap across more than one screen line if lines were
4885 wrapped by xterm itself rather than by the application running in
4886 the window. If the key/button bindings specify that an X
4887 selection is to be made, xterm will leave the selected text
4888 highlighted for as long as it is the selection owner.
4889 Pointer button two (usually middle)
4891 “types” (pastes) the text from the given selection, if any,
4892 otherwise from the cut buffer, inserting it as keyboard input:
4893 ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0)
4895 Pointer button three (usually right)
4897 extends the current selection.
4898 ~Ctrl ~Meta <Btn3Down>:start-extend()
4900 (Without loss of generality, you can swap “right” and “left”
4902 everywhere in the rest of this paragraph.) If pressed while
4903 closer to the right edge of the selection than the left, it
4904 extends/contracts the right edge of the selection. If you
4905 contract the selection past the left edge of the selection, xterm
4906 assumes you really meant the left edge, restores the original
4907 selection, then extends/contracts the left edge of the selection.
4908 Extension starts in the selection unit mode that the last
4909 selection or extension was performed in; you can multiple-click to
4910 cycle through them.
4911 By cutting and pasting pieces of text without trailing new lines, you
4913 can take text from several places in different windows and form a
4914 command to the shell, for example, or take output from a program and
4915 insert it into your favorite editor. Since cut buffers are globally
4916 shared among different applications, you may regard each as a “file”
4917 whose contents you know. The terminal emulator and other text programs
4918 should be treating it as if it were a text file, i.e., the text is
4919 delimited by new lines.
4920 Scrolling
4922 The scroll region displays the position and amount of text currently
4923 showing in the window (highlighted) relative to the amount of text
4924 actually saved. As more text is saved (up to the maximum), the size of
4925 the highlighted area decreases.
4926 Clicking button one with the pointer in the scroll region moves the
4928 adjacent line to the top of the display window.
4929 Clicking button three moves the top line of the display window down to
4931 the pointer position.
4932 Clicking button two moves the display to a position in the saved text
4934 that corresponds to the pointer's position in the scrollbar.
4935 Tektronix Pointer
4937 Unlike the VTxxx window, the Tektronix window does not allow the
4938 copying of text. It does allow Tektronix GIN mode, and in this mode
4939 the cursor will change from an arrow to a cross. Pressing any key will
4940 send that key and the current coordinate of the cross cursor. Pressing
4941 button one, two, or three will return the letters “l”, “m”, and “r”,
4942 respectively. If the “shift” key is pressed when a pointer button is
4943 pressed, the corresponding upper case letter is sent. To distinguish a
4944 pointer button from a key, the high bit of the character is set (but
4945 this is bit is normally stripped unless the terminal mode is RAW; see
4946 tty(4) for details).
4947
4949 X clients provide select and paste support by responding to requests
4950 conveyed by the X server. The X server holds data in “atoms” which
4951 correspond to the different types of selection (PRIMARY, SECONDARY,
4952 CLIPBOARD) as well as the similar cut buffer mechanism (CUT_BUFFER0 to
4953 CUT_BUFFER7). Those are documented in the ICCCM.
4954 The ICCCM deals with the underlying mechanism for select/paste. It
4956 does not mention highlighting. The selection is not the same as
4957 highlighting. Xterm (like many applications) uses highlighting to show
4958 you the currently selected text. An X application may own a selection,
4959 which allows it to be the source of data copied using a given selection
4960 atom Xterm may continue owning a selection after it stops highlighting
4961 (see keepSelection).
4962 PRIMARY
4964 When configured to use the primary selection (the default), xterm can
4965 provide the selection data in ways which help to retain character
4966 encoding information as it is pasted.
4967 The PRIMARY token is a standard X feature, documented in the ICCCM
4969 (Inter-Client Communication Conventions Manual), which states
4970 The selection named by the atom PRIMARY is used for all commands
4972 that take only a single argument and is the principal means of
4973 communication between clients that use the selection mechanism.
4974 A user “selects” text on xterm, which highlights the selected text. A
4976 subsequent “paste” to another client forwards a request to the client
4977 owning the selection. If xterm owns the primary selection, it makes
4978 the data available in the form of one or more “selection targets”. If
4979 it does not own the primary selection, e.g., if it has released it or
4980 another client has asserted ownership, it relies on cut-buffers to pass
4981 the data. But cut-buffers handle only ISO-8859-1 data (officially -
4982 some clients ignore the rules).
4983 CLIPBOARD
4985 When configured to use the clipboard (using the selectToClipboard
4986 resource), the problem with persistence of ownership is bypassed.
4987 Otherwise, there is no difference regarding the data which can be
4988 passed via selection.
4989 The selectToClipboard resource is a compromise, allowing CLIPBOARD to
4991 be treated almost like PRIMARY, unlike the ICCCM, which describes
4992 CLIPBOARD in different terms than PRIMARY or SECONDARY. Its lengthy
4993 explanation begins with the essential points:
4994 The selection named by the atom CLIPBOARD is used to hold data that
4996 is being transferred between clients, that is, data that usually is
4997 being cut and then pasted or copied and then pasted. Whenever a
4998 client wants to transfer data to the clipboard:
4999 · It should assert ownership of the CLIPBOARD.
5001 · If it succeeds in acquiring ownership, it should be prepared to
5003 respond to a request for the contents of the CLIPBOARD in the
5004 usual way (retaining the data to be able to return it). The
5005 request may be generated by the clipboard client described
5006 below.
5007 SELECT
5009 However, many applications use CLIPBOARD in imitation of other
5010 windowing systems. The selectToClipboard resource (and corresponding
5011 menu entry Select to Clipboard) introduce the SELECT token (known only
5012 to xterm) which chooses between the PRIMARY and CLIPBOARD tokens.
5013 Without using this feature, one can use workarounds such as the xclip
5015 program to show the contents of the X clipboard within an xterm window.
5016 SECONDARY
5018 This is used less often than PRIMARY or CLIPBOARD. According to the
5019 ICCCM, it is used
5020 · As the second argument to commands taking two arguments (for
5022 example, “exchange primary and secondary selections”)
5023 · As a means of obtaining data when there is a primary selection and
5025 the user does not want to disturb it
5026 Selection Targets
5028 The different types of data which are passed depend on what the
5029 receiving client asks for. These are termed selection targets.
5030 When asking for the selection data, xterm tries the following types in
5032 this order:
5033 UTF8_STRING
5035 This is an XFree86 extension, which denotes that the data is
5036 encoded in UTF-8. When xterm is built with wide-character
5037 support, it both accepts and provides this type.
5038 TEXT the text is in the encoding which corresponds to your current
5040 locale.
5041 COMPOUND_TEXT
5043 this is a format for multiple character set data, such as
5044 multi-lingual text. It can store UTF-8 data as a special
5045 case.
5046 STRING
5048 This is Latin 1 (ISO-8859-1) data.
5049 The middle two (TEXT and COMPOUND_TEXT) are added if xterm is
5051 configured with the i18nSelections resource set to “true”.
5052 UTF8_STRING is preferred (therefore first in the list) since xterm
5054 stores text as Unicode data when running in wide-character mode, and no
5055 translation is needed. On the other hand, TEXT and COMPOUND_TEXT may
5056 require translation. If the translation is incomplete, they will
5057 insert X's “defaultString” whose value cannot be set, and may simply be
5058 empty. Xterm's defaultString resource specifies the string to use for
5059 incomplete translations of the UTF8_STRING.
5060 You can alter the types which xterm tries using the eightBitSelectTypes
5062 or utf8SelectTypes resources. For instance, you might have some
5063 specific locale setting which does not use UTF-8 encoding. The
5064 resource value is a comma-separated list of the selection targets,
5065 which consist of the names shown. You can use the special name I18N to
5066 denote the optional inclusion of TEXT and COMPOUND_TEXT. The names are
5067 matched ignoring case, and can be abbreviated. The default list can be
5068 expressed in several ways, e.g.,
5069 UTF8_STRING,I18N,STRING
5071 utf8,i18n,string
5072 u,i,s
5073 Mouse Protocol
5075 Applications can send escape sequences to xterm to cause it to send
5076 escape sequences back to the computer when you press a pointer button,
5077 or even (depending on which escape sequence) send escape sequences back
5078 to the computer as you move the pointer.
5079 These escape sequences and the responses, called the mouse protocol,
5081 are documented in XTerm Control Sequences. They do not appear in the
5082 actions invoked by the translations resource because the resource does
5083 not change while you run xterm, whereas applications can change the
5084 mouse prototol (i.e., enable, disable, use different modes).
5085 However, the mouse protocol is interpreted within the actions that are
5087 usually associated with the pointer buttons. Xterm ignores the mouse
5088 protocol in the insert-selection action if the shift-key is pressed at
5089 the same time. It also modifies a few other actions if the shift-key
5090 is pressed, e.g., suppressing the response with the pointer position,
5091 though not eliminating changes to the selected text.
5092
5094 Xterm has four menus, named mainMenu, vtMenu, fontMenu, and tekMenu.
5095 Each menu pops up under the correct combinations of key and button
5096 presses. Each menu is divided into sections, separated by a horizontal
5097 line. Some menu entries correspond to modes that can be altered. A
5098 check mark appears next to a mode that is currently active. Selecting
5099 one of these modes toggles its state. Other menu entries are commands;
5100 selecting one of these performs the indicated function.
5101 All of the menu entries correspond to X actions. In the list below,
5103 the menu label is shown followed by the action's name in parenthesis.
5104 Main Options
5106 The xterm mainMenu pops up when the “control” key and pointer button
5107 one are pressed in a window. This menu contains items that apply to
5108 both the VTxxx and Tektronix windows. There are several sections:
5109 Commands for managing X events:
5111 Toolbar (resource toolbar)
5113 Clicking on the “Toolbar” menu entry hides the toolbar if
5114 it is visible, and shows it if it is not.
5115 Secure Keyboard (resource securekbd)
5117 The Secure Keyboard mode is helpful when typing in
5118 passwords or other sensitive data in an unsecure
5119 environment (see SECURITY below, but read the limitations
5120 carefully).
5121 Allow SendEvents (resource allowsends)
5123 Specifies whether or not synthetic key and button events
5124 generated using the X protocol SendEvent request should
5125 be interpreted or discarded. This corresponds to the
5126 allowSendEvents resource.
5127 Redraw Window (resource redraw)
5129 Forces the X display to repaint; useful in some
5130 environments.
5131 Commands for capturing output:
5133 Log to File (resource logging)
5135 Captures text sent to the screen in a log file, as in the
5136 -l logging option.
5137 Print-All Immediately (resource print-immediate)
5139 Invokes the print-immediate action, sending the text of
5140 the current window directly to a file, as specified by
5141 the printFileImmediate, printModeImmediate and
5142 printOptsImmediate resources.
5143 Print-All on Error (resource print-on-error)
5145 Invokes the print-on-error action, which toggles a flag
5146 telling xterm that if it exits with an X error, to send
5147 the text of the current window directly to a file, as
5148 specified by the printFileOnXError, printModeOnXError and
5149 printOptsOnXError resources.
5150 Print Window (resource print)
5152 Sends the text of the current window to the program given
5153 in the printerCommand resource.
5154 Redirect to Printer (resource print-redir)
5156 This sets the printerControlMode to 0 or 2. You can use
5157 this to turn the printer on as if an application had sent
5158 the appropriate control sequence. It is also useful for
5159 switching the printer off if an application turns it on
5160 without resetting the print control mode.
5161 XHTML Screen Dump (resource dump-html)
5163 Available only when compiled with screen dump support.
5164 Invokes the dump-html action. This creates an XHTML file
5165 matching the contents of the current screen, including
5166 the border, internal border, colors and most attributes:
5167 bold, italic, underline, faint, strikeout, reverse; blink
5168 is rendered as white-on-red; double underline is rendered
5169 the same as underline since there is no portable
5170 equivalent in CSS 2.2.
5171 The font is whatever your browser uses for preformatted
5173 (<pre>) elements. The XHTML file references a cascading
5174 style sheet (CSS) named “xterm.css” that you can create
5175 to select a font or override properties.
5176 The following CSS selectors are used with the expected
5178 default behavior in the XHTML file:
5179 .ul for underline,
5181 .bd for bold,
5182 .it for italic,
5183 .st for strikeout,
5184 .lu for strikeout combined with underline.
5185 In addition you may use
5187 .ev to affect even numbered lines and
5189 .od to affect odd numbered lines.
5190 Attributes faint, reverse and blink are implemented as
5192 style attributes setting color properties. All colors
5193 are specified as RGB percentages in order to support
5194 displays with 10 bits per RGB.
5195 The name of the file will be
5197 xterm.yyyy.MM.dd.hh.mm.ss.xhtml
5199 where yyyy, MM, dd, hh, mm and ss are the year, month,
5201 day, hour, minute and second when the screen dump was
5202 performed (the file is created in the directory xterm is
5203 started in, or the home directory for a login xterm).
5204 The dump-html action can also be triggered using the
5206 Media Copy control sequence CSI 1 0 i, for example from a
5207 shell script with
5208 printf '\033[10i'
5210 Only the UTF-8 encoding is supported.
5212 SVG Screen Dump (resource dump-svg)
5214 Available only when compiled with screen dump support.
5215 Invokes the dump-svg action. This creates a Scalable
5216 Vector Graphics (SVG) file matching the contents of the
5217 current screen, including the border, internal border,
5218 colors and most attributes: bold, italic, underline,
5219 double underline, faint, strikeout, reverse; blink is
5220 rendered as white-on-red. The font is whatever your
5221 renderer uses for the monospace font-family. All colors
5222 are specified as RGB percentages in order to support
5223 displays with 10 bits per RGB.
5224 The name of the file will be
5226 xterm.yyyy.MM.dd.hh.mm.ss.svg
5228 where yyyy, MM, dd, hh, mm and ss are the year, month,
5230 day, hour, minute and second when the screen dump was
5231 performed (the file is created in the directory xterm is
5232 started in, or the home directory for a login xterm).
5233 The dump-svg action can also be triggered using the Media
5235 Copy control sequence CSI 1 1 i, for example from a shell
5236 script with
5237 printf '\033[11i'
5239 Only the UTF-8 encoding is supported.
5241 Modes for setting keyboard style:
5243 8-Bit Controls (resource 8-bit-control)
5245 Enabled for VT220 emulation, this controls whether xterm
5246 will send 8-bit control sequences rather than using 7-bit
5247 (ASCII) controls, e.g., sending a byte in the range
5248 128–159 rather than the escape character followed by a
5249 second byte. Xterm always interprets both 8-bit and
5250 7-bit control sequences (see Xterm Control Sequences).
5251 This corresponds to the eightBitControl resource.
5252 Backarrow Key (BS/DEL) (resource backarrow key)
5254 Modifies the behavior of the backarrow key, making it
5255 transmit either a backspace (8) or delete (127)
5256 character. This corresponds to the backarrowKey
5257 resource.
5258 Alt/NumLock Modifiers (resource num-lock)
5260 Controls the treatment of Alt- and NumLock-key modifiers.
5261 This corresponds to the numLock resource.
5262 Meta Sends Escape (resource meta-esc)
5264 Controls whether Meta keys are converted into a two-
5265 character sequence with the character itself preceded by
5266 ESC. This corresponds to the metaSendsEscape resource.
5267 Delete is DEL (resource delete-is-del)
5269 Controls whether the Delete key on the editing keypad
5270 should send DEL (127) or the VT220-style Remove escape
5271 sequence. This corresponds to the deleteIsDEL resource.
5272 Old Function-Keys (resource oldFunctionKeys)
5274 HP Function-Keys (resource hpFunctionKeys)
5276 SCO Function-Keys (resource scoFunctionKeys)
5278 Sun Function-Keys (resource sunFunctionKeys)
5280 VT220 Keyboard (resource sunKeyboard)
5282 These act as a radio-button, selecting one style for the
5283 keyboard layout. The layout corresponds to more than one
5284 resource setting: sunKeyboard, sunFunctionKeys,
5285 scoFunctionKeys and hpFunctionKeys.
5286 Commands for process signalling:
5288 Send STOP Signal (resource suspend)
5290 Send CONT Signal (resource continue)
5292 Send INT Signal (resource interrupt)
5294 Send HUP Signal (resource hangup)
5296 Send TERM Signal (resource terminate)
5298 Send KILL Signal (resource kill)
5300 These send the SIGTSTP, SIGCONT, SIGINT, SIGHUP, SIGTERM
5301 and SIGKILL signals respectively, to the process group of
5302 the process running under xterm (usually the shell). The
5303 SIGCONT function is especially useful if the user has
5304 accidentally typed CTRL-Z, suspending the process.
5305 Quit (resource quit)
5307 Stop processing X events except to support the -hold
5308 option, and then send a SIGHUP signal to the process
5309 group of the process running under xterm (usually the
5310 shell).
5311 VT Options
5313 The xterm vtMenu sets various modes in the VTxxx emulation, and is
5314 popped up when the “control” key and pointer button two are pressed in
5315 the VTxxx window.
5316 VTxxx Modes:
5318 Enable Scrollbar (resource scrollbar)
5320 Enable (or disable) the scrollbar. This corresponds to
5321 the -sb option and the scrollBar resource.
5322 Enable Jump Scroll (resource jumpscroll)
5324 Enable (or disable) jump scrolling. This corresponds to
5325 the -j option and the jumpScroll resource.
5326 Enable Reverse Video (resource reversevideo)
5328 Enable (or disable) reverse-video. This corresponds to
5329 the -rv option and the reverseVideo resource.
5330 Enable Auto Wraparound (resource autowrap)
5332 Enable (or disable) auto-wraparound. This corresponds to
5333 the -aw option and the autoWrap resource.
5334 Enable Reverse Wraparound (resource reversewrap)
5336 Enable (or disable) reverse wraparound. This corresponds
5337 to the -rw option and the reverseWrap resource.
5338 Enable Auto Linefeed (resource autolinefeed)
5340 Enable (or disable) auto-linefeed. This is the VT102 NEL
5341 function, which causes the emulator to emit a line feed
5342 after each carriage return. There is no corresponding
5343 command-line option or resource setting.
5344 Enable Application Cursor Keys (resource appcursor)
5346 Enable (or disable) application cursor keys. This
5347 corresponds to the appcursorDefault resource. There is
5348 no corresponding command-line option.
5349 Enable Application Keypad (resource appkeypad)
5351 Enable (or disable) application keypad keys. This
5352 corresponds to the appkeypadDefault resource. There is
5353 no corresponding command-line option.
5354 Scroll to Bottom on Key Press (resource scrollkey)
5356 Enable (or disable) scrolling to the bottom of the
5357 scrolling region on a keypress. This corresponds to the
5358 -sk option and the scrollKey resource.
5359 As a special case, the XON / XOFF keys (control/S and
5361 control/Q) are ignored.
5362 Scroll to Bottom on Tty Output (resource scrollttyoutput)
5364 Enable (or disable) scrolling to the bottom of the
5365 scrolling region on output to the terminal. This
5366 corresponds to the -si option and the scrollTtyOutput
5367 resource.
5368 Allow 80/132 Column Switching (resource allow132)
5370 Enable (or disable) switching between 80 and 132 columns.
5371 This corresponds to the -132 option and the c132
5372 resource.
5373 Keep Selection (resource keepSelection)
5375 Tell xterm whether to disown the selection when it stops
5376 highlighting it, e.g., when an application modifies the
5377 display so that it no longer matches the text which has
5378 been highlighted. As long as xterm continues to own the
5379 selection for a given atom, it can provide the
5380 corresponding text to other clients which request the
5381 selection using that atom.
5382 This corresponds to the keepSelection resource. There is
5384 no corresponding command-line option.
5385 Telling xterm to not disown the selection does not
5387 prevent other applications from taking ownership of the
5388 selection. When that happens, xterm receives
5389 notification that this has happened, and removes its
5390 highlighting.
5391 See SELECT/PASTE for more information.
5393 Select to Clipboard (resource selectToClipboard)
5395 Tell xterm whether to use the PRIMARY or CLIPBOARD for
5396 SELECT tokens in the translations resource which maps
5397 keyboard and mouse actions to select/paste actions.
5398 This corresponds to the selectToClipboard resource.
5400 There is no corresponding command-line option.
5401 The keepSelection resource setting applies to CLIPBOARD
5403 selections just as it does for PRIMARY selections.
5404 However some window managers treat the clipboard
5405 specially. For instance, XQuartz's synchronization
5406 between the OSX pasteboard and the X11 clipboard causes
5407 applications to lose the selection ownership for that
5408 atom when a selection is copied to the clipboard.
5409 See SELECT/PASTE for more information.
5411 Enable Visual Bell (resource visualbell)
5413 Enable (or disable) visible bell (i.e., flashing) instead
5414 of an audible bell. This corresponds to the -vb option
5415 and the visualBell resource.
5416 Enable Bell Urgency (resource bellIsUrgent)
5418 Enable (or disable) Urgency window manager hint when
5419 Control-G is received. This corresponds to the
5420 bellIsUrgent resource.
5421 Enable Pop on Bell (resource poponbell)
5423 Enable (or disable) raising of the window when Control-G
5424 is received. This corresponds to the -pop option and the
5425 popOnBell resource.
5426 Enable Blinking Cursor (resource cursorblink)
5428 Enable (or disable) the blinking-cursor feature. This
5429 corresponds to the -bc option and the cursorBlink
5430 resource. There are also escape sequences (see Xterm
5431 Control Sequences):
5432 · If the cursorBlinkXOR resource is set, the menu entry
5434 and the escape sequence states will be XOR'd: if both
5435 are enabled, the cursor will not blink, if only one
5436 is enabled, the cursor will blink.
5437 · If the cursorBlinkXOR is not set; if either the menu
5439 entry or the escape sequence states are set, the
5440 cursor will blink.
5441 In either case, the checkbox for the menu shows the state
5443 of the cursorBlink resource, which may not correspond to
5444 what the cursor is actually doing.
5445 Enable Alternate Screen Switching (resource titeInhibit)
5447 Enable (or disable) switching between the normal and
5448 alternate screens. This corresponds to the titeInhibit
5449 resource. There is no corresponding command-line option.
5450 Enable Active Icon (resource activeicon)
5452 Enable (or disable) the active-icon feature. This
5453 corresponds to the -ai option and the activeIcon
5454 resource.
5455 Sixel Scrolling (resource sixelScrolling)
5457 When enabled, sixel graphics are positioned at the
5458 current text cursor location, scroll the image vertically
5459 if larger than the screen, and leave the text cursor at
5460 the start of the next complete line after the image when
5461 returning to text mode (this is the default). When
5462 disabled, sixel graphics are positioned at the upper left
5463 of the screen, are cropped to fit the screen, and do not
5464 affect the text cursor location. This corresponds to the
5465 sixelScrolling resource. There is no corresponding
5466 command-line option.
5467 Private Color Registers (resource privateColorRegisters)
5469 If xterm is configured to support ReGIS graphics, this
5470 controls whether a private color palette can be used.
5471 When enabled, each graphic image uses a separate set of
5473 color registers, so that it essentially has a private
5474 palette (this is the default). If it is not set, all
5475 graphics images share a common set of registers which is
5476 how sixel and ReGIS graphics worked on actual hardware.
5477 The default is likely a more useful mode on modern
5478 TrueColor hardware.
5479 This corresponds to the privateColorRegisters resource.
5481 There is no corresponding command-line option.
5482 VTxxx Commands:
5484 Do Soft Reset (resource softreset)
5486 Reset scroll regions. This can be convenient when some
5487 program has left the scroll regions set incorrectly
5488 (often a problem when using VMS or TOPS-20). This
5489 corresponds to the VT220 DECSTR control sequence.
5490 Do Full Reset (resource hardreset)
5492 The full reset entry will clear the screen, reset tabs to
5493 every eight columns, and reset the terminal modes (such
5494 as wrap and smooth scroll) to their initial states just
5495 after xterm has finished processing the command line
5496 options. This corresponds to the VT102 RIS control
5497 sequence, with a few obvious differences. For example,
5498 your session is not disconnected as a real VT102 would
5499 do.
5500 Reset and Clear Saved Lines (resource clearsavedlines)
5502 Perform a full reset, and also clear the saved lines.
5503 Commands for setting the current screen:
5505 Show Tek Window (resource tekshow)
5507 When enabled, pops the Tektronix 4014 window up (makes it
5508 visible). When disabled, hides the Tektronix 4014
5509 window.
5510 Switch to Tek Mode (resource tekmode)
5512 When enabled, pops the Tektronix 4014 window up if it is
5513 not already visible, and switches the input stream to
5514 that window. When disabled, hides the Tektronix 4014
5515 window and switches input back to the VTxxx window.
5516 Hide VT Window (resource vthide)
5518 When enabled, hides the VTxxx window, shows the Tektronix
5519 4014 window if it was not already visible and switches
5520 the input stream to that window. When disabled, shows
5521 the VTxxx window, and switches the input stream to that
5522 window.
5523 Show Alternate Screen (resource altscreen)
5525 When enabled, shows the alternate screen. When disabled,
5526 shows the normal screen. Note that the normal screen may
5527 have saved lines; the alternate screen does not.
5528 VT Fonts
5530 The xterm fontMenu pops up when the “control” key and pointer button
5531 three are pressed in a window. It sets the font used in the VTxxx
5532 window, or modifies the way the font is specified or displayed. There
5533 are several sections.
5534 The first section allows you to select the font from a set of
5536 alternatives:
5537 Default (resource fontdefault)
5539 Set the font to the default, i.e., that given by the
5540 *VT100.font resource.
5541 Unreadable (resource font1)
5543 Set the font to that given by the *VT100.font1 resource.
5544 Tiny (resource font2)
5546 Set the font to that given by the *VT100.font2 resource.
5547 Small (resource font3)
5549 Set the font to that given by the *VT100.font3 resource.
5550 Medium (resource font4)
5552 Set the font to that given by the *VT100.font4 resource.
5553 Large (resource font5)
5555 Set the font to that given by the *VT100.font5 resource.
5556 Huge (resource font6)
5558 Set the font to that given by the *VT100.font6 resource.
5559 Enormous (resource font7)
5561 Set the font to that given by the *VT100.font7 resource.
5562 Escape Sequence (resource fontescape)
5564 This allows you to set the font last specified by the Set
5565 Font escape sequence (see Xterm Control Sequences).
5566 Selection (resource fontsel)
5568 This allows you to set the font specified the current
5569 selection as a font name (if the PRIMARY selection is
5570 owned).
5571 The second section allows you to modify the way it is displayed:
5573 Bold Fonts (resource allow-bold-fonts)
5575 This is normally checked (enabled). When unchecked,
5576 xterm will not use bold fonts. The setting corresponds
5577 to the allowBoldFonts resource.
5578 Line-Drawing Characters (resource font-linedrawing)
5580 When set, tells xterm to draw its own line-drawing
5581 characters. Otherwise it relies on the font containing
5582 these. Compare to the forceBoxChars resource.
5583 Packed Font (resource font-packed)
5585 When set, tells xterm to use the minimum glyph-width from
5586 a font when displaying characters. Use the maximum width
5587 (unchecked) to help display proportional fonts. Compare
5588 to the forcePackedFont resource.
5589 Doublesized Characters (resource font-doublesize)
5591 When set, xterm may ask the font server to produce scaled
5592 versions of the normal font, for VT102 double-size
5593 characters.
5594 The third section allows you to modify the way it is specified:
5596 TrueType Fonts (resource render-font)
5598 If the renderFont and corresponding resources were set,
5599 this is a further control whether xterm will actually use
5600 the Xft library calls to obtain a font.
5601 UTF-8 Encoding (resource utf8-mode)
5603 This controls whether xterm uses UTF-8 encoding of
5604 input/output. It is useful for temporarily switching
5605 xterm to display text from an application which does not
5606 follow the locale settings. It corresponds to the utf8
5607 resource.
5608 UTF-8 Fonts (resource utf8-fonts)
5610 This controls whether xterm uses UTF-8 fonts for display.
5611 It is useful for temporarily switching xterm to display
5612 text from an application which does not follow the locale
5613 settings. It combines the utf8 and utf8Fonts resources,
5614 subject to the locale resource.
5615 UTF-8 Titles (resource utf8-title)
5617 This controls whether xterm accepts UTF-8 encoding for
5618 title control sequences. It corresponds to the utf8Fonts
5619 resource.
5620 Initially the checkmark is set according to both the utf8
5622 and utf8Fonts resource values. If the latter is set to
5623 “always”, the checkmark is disabled. Likewise, if there
5624 are no fonts given in the utf8Fonts subresources, then
5625 the checkmark also is disabled.
5626 The standard XTerm app-defaults file defines both sets of
5628 fonts, while the UXTerm app-defaults file defines only
5629 one set. Assuming the standard app-defaults files, this
5630 command will launch xterm able to switch between UTF-8
5631 and ISO-8859-1 encoded fonts:
5632 uxterm -class XTerm
5634 The fourth section allows you to enable or disable special operations
5636 which can be controlled by writing escape sequences to the terminal.
5637 These are disabled if the SendEvents feature is enabled:
5638 Allow Color Ops (resource allow-font-ops)
5640 This corresponds to the allowColorOps resource. Enable
5641 or disable control sequences that set/query the colors.
5642 Allow Font Ops (resource allow-font-ops)
5644 This corresponds to the allowFontOps resource. Enable or
5645 disable control sequences that set/query the font.
5646 Allow Mouse Ops (resource allow-mouse-ops)
5648 Enable or disable control sequences that cause the
5649 terminal to send escape sequences on pointer-clicks and
5650 movement. This corresponds to the allowMouseOps
5651 resource.
5652 Allow Tcap Ops (resource allow-tcap-ops)
5654 Enable or disable control sequences that query the
5655 terminal's notion of its function-key strings, as termcap
5656 or terminfo capabilities. This corresponds to the
5657 allowTcapOps resource.
5658 Allow Title Ops (resource allow-title-ops)
5660 Enable or disable control sequences that modify the
5661 window title or icon name. This corresponds to the
5662 allowTitleOps resource.
5663 Allow Window Ops (resource allow-window-ops)
5665 Enable or disable extended window control sequences (as
5666 used in dtterm). This corresponds to the allowWindowOps
5667 resource.
5668 Tek Options
5670 The xterm tekMenu sets various modes in the Tektronix emulation, and is
5671 popped up when the “control” key and pointer button two are pressed in
5672 the Tektronix window. The current font size is checked in the modes
5673 section of the menu.
5674 Large Characters (resource tektextlarge)
5676 #2 Size Characters (resource tektext2)
5678 #3 Size Characters (resource tektext3)
5680 Small Characters (resource tektextsmall)
5682 Commands:
5684 PAGE (resource tekpage)
5686 Simulates the Tektronix “PAGE” button by
5687 · clearing the window,
5689 · cancelling the graphics input-mode, and
5691 · moving the cursor to the home position.
5693 RESET (resource tekreset)
5695 Unlike the similarly-named Tektronix “RESET” button, this
5696 does everything that PAGE does as well as resetting the
5697 line-type and font-size to their default values.
5698 COPY (resource tekcopy)
5700 Simulates the Tektronix “COPY” button (which makes a
5701 hard-copy of the screen) by writing the information to a
5702 text file.
5703 Windows:
5705 Show VT Window (resource vtshow)
5707 Switch to VT Mode (resource vtmode)
5709 Hide Tek Window (resource tekhide)
5711
5713 X environments differ in their security consciousness.
5714 · Most servers, run under xdm, are capable of using a “magic cookie”
5716 authorization scheme that can provide a reasonable level of
5717 security for many people. If your server is only using a host-
5718 based mechanism to control access to the server (see xhost(1)),
5719 then if you enable access for a host and other users are also
5720 permitted to run clients on that same host, it is possible that
5721 someone can run an application which uses the basic services of the
5722 X protocol to snoop on your activities, potentially capturing a
5723 transcript of everything you type at the keyboard.
5724 · Any process which has access to your X display can manipulate it in
5726 ways that you might not anticipate, even redirecting your keyboard
5727 to itself and sending events to your application's windows. This
5728 is true even with the “magic cookie” authorization scheme. While
5729 the allowSendEvents provides some protection against rogue
5730 applications tampering with your programs, guarding against a
5731 snooper is harder.
5732 · The X input extension for instance allows an application to bypass
5734 all of the other (limited) authorization and security features,
5735 including the GrabKeyboard protocol.
5736 · The possibility of an application spying on your keystrokes is of
5738 particular concern when you want to type in a password or other
5739 sensitive data. The best solution to this problem is to use a
5740 better authorization mechanism than is provided by X.
5741 Subject to all of these caveats, a simple mechanism exists for
5743 protecting keyboard input in xterm.
5744 The xterm menu (see MENUS above) contains a Secure Keyboard entry
5746 which, when enabled, attempts to ensure that all keyboard input is
5747 directed only to xterm (using the GrabKeyboard protocol request). When
5748 an application prompts you for a password (or other sensitive data),
5749 you can enable Secure Keyboard using the menu, type in the data, and
5750 then disable Secure Keyboard using the menu again.
5751 · This ensures that you know which window is accepting your
5753 keystrokes.
5754 · It cannot ensure that there are no processes which have access to
5756 your X display that might be observing the keystrokes as well.
5757 Only one X client at a time can grab the keyboard, so when you attempt
5759 to enable Secure Keyboard it may fail. In this case, the bell will
5760 sound. If the Secure Keyboard succeeds, the foreground and background
5761 colors will be exchanged (as if you selected the Enable Reverse Video
5762 entry in the Modes menu); they will be exchanged again when you exit
5763 secure mode. If the colors do not switch, then you should be very
5764 suspicious that you are being spoofed. If the application you are
5765 running displays a prompt before asking for the password, it is safest
5766 to enter secure mode before the prompt gets displayed, and to make sure
5767 that the prompt gets displayed correctly (in the new colors), to
5768 minimize the probability of spoofing. You can also bring up the menu
5769 again and make sure that a check mark appears next to the entry.
5770 Secure Keyboard mode will be disabled automatically if your xterm
5772 window becomes iconified (or otherwise unmapped), or if you start up a
5773 reparenting window manager (that places a title bar or other decoration
5774 around the window) while in Secure Keyboard mode. (This is a feature
5775 of the X protocol not easily overcome.) When this happens, the
5776 foreground and background colors will be switched back and the bell
5777 will sound in warning.
5778
5780 Clicking the left pointer button twice in rapid succession (double-
5781 clicking) causes all characters of the same class (e.g., letters, white
5782 space, punctuation) to be selected as a “word”. Since different people
5783 have different preferences for what should be selected (for example,
5784 should filenames be selected as a whole or only the separate subnames),
5785 the default mapping can be overridden through the use of the charClass
5786 (class CharClass) resource.
5787 This resource is a series of comma-separated range:value pairs.
5789 · The range is either a single number or low-high in the range of 0
5791 to 65535, corresponding to the code for the character or characters
5792 to be set.
5793 · The value is arbitrary. For example, the default table uses the
5795 character number of the first character occurring in the set. When
5796 not in UTF-8 mode, only the first 256 entries of this table will be
5797 used.
5798 The default table starts as follows -
5800 static int charClass[256] = {
5802 /* NUL SOH STX ETX EOT ENQ ACK BEL */
5803 32, 1, 1, 1, 1, 1, 1, 1,
5804 /* BS HT NL VT NP CR SO SI */
5805 1, 32, 1, 1, 1, 1, 1, 1,
5806 /* DLE DC1 DC2 DC3 DC4 NAK SYN ETB */
5807 1, 1, 1, 1, 1, 1, 1, 1,
5808 /* CAN EM SUB ESC FS GS RS US */
5809 1, 1, 1, 1, 1, 1, 1, 1,
5810 /* SP ! " # $ % & ' */
5811 32, 33, 34, 35, 36, 37, 38, 39,
5812 /* ( ) * + , - . / */
5813 40, 41, 42, 43, 44, 45, 46, 47,
5814 /* 0 1 2 3 4 5 6 7 */
5815 48, 48, 48, 48, 48, 48, 48, 48,
5816 /* 8 9 : ; < = > ? */
5817 48, 48, 58, 59, 60, 61, 62, 63,
5818 /* @ A B C D E F G */
5819 64, 48, 48, 48, 48, 48, 48, 48,
5820 /* H I J K L M N O */
5821 48, 48, 48, 48, 48, 48, 48, 48,
5822 /* P Q R S T U V W */
5823 48, 48, 48, 48, 48, 48, 48, 48,
5824 /* X Y Z [ \ ] ^ _ */
5825 48, 48, 48, 91, 92, 93, 94, 48,
5826 /* ` a b c d e f g */
5827 96, 48, 48, 48, 48, 48, 48, 48,
5828 /* h i j k l m n o */
5829 48, 48, 48, 48, 48, 48, 48, 48,
5830 /* p q r s t u v w */
5831 48, 48, 48, 48, 48, 48, 48, 48,
5832 /* x y z { | } ~ DEL */
5833 48, 48, 48, 123, 124, 125, 126, 1,
5834 /* x80 x81 x82 x83 IND NEL SSA ESA */
5835 1, 1, 1, 1, 1, 1, 1, 1,
5836 /* HTS HTJ VTS PLD PLU RI SS2 SS3 */
5837 1, 1, 1, 1, 1, 1, 1, 1,
5838 /* DCS PU1 PU2 STS CCH MW SPA EPA */
5839 1, 1, 1, 1, 1, 1, 1, 1,
5840 /* x98 x99 x9A CSI ST OSC PM APC */
5841 1, 1, 1, 1, 1, 1, 1, 1,
5842 /* - i c/ L ox Y- | So */
5843 160, 161, 162, 163, 164, 165, 166, 167,
5844 /* .. c0 ip << _ R0 - */
5845 168, 169, 170, 171, 172, 173, 174, 175,
5846 /* o +- 2 3 ' u q| . */
5847 176, 177, 178, 179, 180, 181, 182, 183,
5848 /* , 1 2 >> 1/4 1/2 3/4 ? */
5849 184, 185, 186, 187, 188, 189, 190, 191,
5850 /* A` A' A^ A~ A: Ao AE C, */
5851 48, 48, 48, 48, 48, 48, 48, 48,
5852 /* E` E' E^ E: I` I' I^ I: */
5853 48, 48, 48, 48, 48, 48, 48, 48,
5854 /* D- N~ O` O' O^ O~ O: X */
5855 48, 48, 48, 48, 48, 48, 48, 215,
5856 /* O/ U` U' U^ U: Y' P B */
5857 48, 48, 48, 48, 48, 48, 48, 48,
5858 /* a` a' a^ a~ a: ao ae c, */
5859 48, 48, 48, 48, 48, 48, 48, 48,
5860 /* e` e' e^ e: i` i' i^ i: */
5861 48, 48, 48, 48, 48, 48, 48, 48,
5862 /* d n~ o` o' o^ o~ o: -: */
5863 48, 48, 48, 48, 48, 48, 48, 247,
5864 /* o/ u` u' u^ u: y' P y: */
5865 48, 48, 48, 48, 48, 48, 48, 48};
5866 For example, the string “33:48,37:48,45-47:48,38:48” indicates
5868 that the exclamation mark, percent sign, dash, period, slash,
5869 and ampersand characters should be treated the same way as
5870 characters and numbers. This is useful for cutting and pasting
5871 electronic mailing addresses and filenames.
5872
5874 It is possible to rebind keys (or sequences of keys) to arbitrary
5875 strings for input, by changing the translations resources for the vt100
5876 or tek4014 widgets. Changing the translations resource for events
5877 other than key and button events is not expected, and will cause
5878 unpredictable behavior.
5879 Actions
5881 The following actions are provided for use within the vt100 or tek4014
5882 translations resources:
5883 allow-bold-fonts(on/off/toggle)
5885 This action sets, unsets or toggles the allowBoldFonts resource
5886 and is also invoked by the allow-bold-fonts entry in fontMenu.
5887 allow-color-ops(on/off/toggle)
5889 This action sets, unsets or toggles the allowColorOps resource
5890 and is also invoked by the allow-color-ops entry in fontMenu.
5891 allow-font-ops(on/off/toggle)
5893 This action sets, unsets or toggles the allowFontOps resource
5894 and is also invoked by the allow-font-ops entry in fontMenu.
5895 allow-mouse-ops(on/off/toggle)
5897 This action sets, unsets or toggles the allowMousepOps resource
5898 and is also invoked by the allow-mouse-ops entry in fontMenu.
5899 allow-send-events(on/off/toggle)
5901 This action sets, unsets or toggles the allowSendEvents
5902 resource and is also invoked by the allowsends entry in
5903 mainMenu.
5904 allow-tcap-ops(on/off/toggle)
5906 This action sets, unsets or toggles the allowTcapOps resource
5907 and is also invoked by the allow-tcap-ops entry in fontMenu.
5908 allow-title-ops(on/off/toggle)
5910 This action sets, unsets or toggles the allowTitleOps resource
5911 and is also invoked by the allow-title-ops entry in fontMenu.
5912 allow-window-ops(on/off/toggle)
5914 This action sets, unsets or toggles the allowWindowOps resource
5915 and is also invoked by the allow-window-ops entry in fontMenu.
5916 alt-sends-escape()
5918 This action toggles the state of the altSendsEscape resource.
5919 bell([percent])
5921 This action rings the keyboard bell at the specified percentage
5922 above or below the base volume.
5923 clear-saved-lines()
5925 This action does hard-reset() and also clears the history of
5926 lines saved off the top of the screen. It is also invoked from
5927 the clearsavedlines entry in vtMenu. The effect is identical
5928 to a hardware reset (RIS) control sequence.
5929 copy-selection(destname [, ...])
5931 This action puts the currently selected text into all of the
5932 selections or cutbuffers specified by destname. Unlike
5933 select-end, it does not send a mouse position or otherwise
5934 modify the internal selection state.
5935 create-menu(m/v/f/t)
5937 This action creates one of the menus used by xterm, if it has
5938 not been previously created. The parameter values are the menu
5939 names: mainMenu, vtMenu, fontMenu, tekMenu, respectively.
5940 dabbrev-expand()
5942 Expands the word before cursor by searching in the preceding
5943 text on the screen and in the scrollback buffer for words
5944 starting with that abbreviation. Repeating dabbrev-expand()
5945 several times in sequence searches for an alternative expansion
5946 by looking farther back. Lack of more matches is signaled by a
5947 bell. Attempts to expand an empty word (i.e., when cursor is
5948 preceded by a space) yield successively all previous words.
5949 Consecutive identical expansions are ignored. The word here is
5950 defined as a sequence of non-whitespace characters. This
5951 feature partially emulates the behavior of “dynamic
5952 abbreviation” expansion in Emacs (bound there to M-/). Here is
5953 a resource setting for xterm which will do the same thing:
5954 *VT100*translations: #override \n\
5956 Meta <KeyPress> /:dabbrev-expand()
5957 deiconify()
5959 Changes the window state back to normal, if it was iconified.
5960 delete-is-del()
5962 This action toggles the state of the deleteIsDEL resource.
5963 dired-button()
5965 Handles a button event (other than press and release) by
5966 echoing the event's position (i.e., character line and column)
5967 in the following format:
5968 ^X ESC G <line+“ ”> <col+“ ”>
5970 dump-html()
5972 Invokes the XHTML Screen Dump feature.
5973 dump-svg()
5975 Invokes the SVG Screen Dump feature.
5976 exec-formatted(format, sourcename [, ...])
5978 Execute an external command, using the current selection for
5979 part of the command's parameters. The first parameter, format
5980 gives the basic command. Succeeding parameters specify the
5981 selection source as in insert-selection.
5982 The format parameter allows these substitutions:
5984 %% inserts a "%".
5986 %P the screen-position at the beginning of the highlighted
5988 region, as a semicolon-separated pair of integers using
5989 the values that the CUP control sequence would use.
5990 %p the screen-position after the beginning of the highlighted
5992 region, using the same convention as “%P”.
5993 %S the length of the string that “%s” would insert.
5995 %s the content of the selection, unmodified.
5997 %T the length of the string that “%t” would insert.
5999 %t the selection, trimmed of leading/trailing whitespace.
6001 Embedded spaces (and newlines) are copied as is.
6002 %R the length of the string that “%r” would insert.
6004 %r the selection, trimmed of trailing whitespace.
6006 %V the video attributes at the beginning of the highlighted
6008 region, as a semicolon-separated list of integers using
6009 the values that the SGR control sequence would use.
6010 %v the video attributes after the end of the highlighted
6012 region, using the same convention as “%V”.
6013 After constructing the command-string, xterm forks a subprocess
6015 and executes the command, which completes independently of
6016 xterm.
6017 For example, this translation would invoke a new xterm process
6019 to view a file whose name is selected while holding the shift
6020 key down. The new process is started when the mouse button is
6021 released:
6022 *VT100*translations: #override Shift \
6024 <Btn1Up>:exec-formatted("xterm -e view '%t'", SELECT)
6025 exec-selectable(format, onClicks)
6027 Execute an external command, using data copied from the screen
6028 for part of the command's parameters. The first parameter,
6029 format gives the basic command as in exec-formatted. The
6030 second parameter specifies the method for copying the data as
6031 in the on2Clicks resource.
6032 fullscreen(on/off/toggle)
6034 This action sets, unsets or toggles the fullscreen resource.
6035 iconify()
6037 Iconifies the window.
6038 hard-reset()
6040 This action resets the scrolling region, tabs, window size, and
6041 cursor keys and clears the screen. It is also invoked from the
6042 hardreset entry in vtMenu.
6043 ignore()
6045 This action ignores the event but checks for special pointer
6046 position escape sequences.
6047 insert()
6049 This action inserts the character or string associated with the
6050 key that was pressed.
6051 insert-eight-bit()
6053 This action inserts an eight-bit (Meta) version of the
6054 character or string associated with the key that was pressed.
6055 Only single-byte values are treated specially. The exact
6056 action depends on the value of the altSendsEscape and the
6057 metaSendsEscape and the eightBitInput resources. The
6058 metaSendsEscape resource is tested first. See the
6059 eightBitInput resource for a full discussion.
6060 The term “eight-bit” is misleading: xterm checks if the key is
6062 in the range 128 to 255 (the eighth bit is set). If the value
6063 is in that range, depending on the resource values, xterm may
6064 then do one of the following:
6065 · add 128 to the value, setting its eighth bit,
6067 · send an ESC byte before the key, or
6069 · send the key unaltered.
6071 insert-formatted(format, sourcename [, ...])
6073 Insert the current selection or data related to it, formatted.
6074 The first parameter, format gives the template for the data as
6075 in exec-formatted. Succeeding parameters specify the selection
6076 source as in insert-selection.
6077 insert-selectable(format, onClicks)
6079 Insert data copied from the screen, formatted. The first
6080 parameter, format gives the template for the data as in
6081 exec-formatted. The second parameter specifies the method for
6082 copying the data as in the on2Clicks resource.
6083 insert-selection(sourcename [, ...])
6085 This action inserts the string found in the selection or
6086 cutbuffer indicated by sourcename. Sources are checked in the
6087 order given (case is significant) until one is found.
6088 Commonly-used selections include: PRIMARY, SECONDARY, and
6089 CLIPBOARD. Cut buffers are typically named CUT_BUFFER0 through
6090 CUT_BUFFER7.
6091 insert-seven-bit()
6093 This action is a synonym for insert(). The term “seven-bit” is
6094 misleading: it only implies that xterm does not try to add 128
6095 to the key's value as in insert-eight-bit().
6096 interpret(control-sequence)
6098 Interpret the given control sequence locally, i.e., without
6099 passing it to the host. This works by inserting the control
6100 sequence at the front of the input buffer. Use “\” to escape
6101 octal digits in the string. Xt does not allow you to put a
6102 null character (i.e., “\000”) in the string.
6103 keymap(name)
6105 This action dynamically defines a new translation table whose
6106 resource name is name with the suffix “Keymap” (i.e.,
6107 nameKeymap, where case is significant). The name None restores
6108 the original translation table.
6109 larger-vt-font()
6111 Set the font to the next larger one, based on the font
6112 dimensions. See also set-vt-font().
6113 load-vt-fonts(name[,class])
6115 Load fontnames from the given subresource name and class. That
6116 is, load the “*VT100.name.font”, resource as “*VT100.font” etc.
6117 If no name is given, the original set of fontnames is restored.
6118 Unlike set-vt-font(), this does not affect the escape- and
6120 select-fonts, since those are not based on resource values. It
6121 does affect the fonts loosely organized under the “Default”
6122 menu entry, including font, boldFont, wideFont and
6123 wideBoldFont.
6124 maximize()
6126 Resizes the window to fill the screen.
6127 meta-sends-escape()
6129 This action toggles the state of the metaSendsEscape resource.
6130 pointer-button()
6132 Use this action as a fall-back to handle button press- and
6133 release-events for the mouse control sequence protocol when the
6134 selection-related translations are suppressed with the
6135 omitTranslation resource.
6136 pointer-motion()
6138 Use this action as a fall-back to handle motion-events for the
6139 mouse control sequence protocol when the selection-related
6140 translations are suppressed with the omitTranslation resource.
6141 popup-menu(menuname)
6143 This action displays the specified popup menu. Valid names
6144 (case is significant) include: mainMenu, vtMenu, fontMenu, and
6145 tekMenu.
6146 print(printer-flags)
6148 This action prints the window. It is also invoked by the print
6149 entry in mainMenu.
6150 The action accepts optional parameters, which temporarily
6152 override resource settings. The parameter values are matched
6153 ignoring case:
6154 noFormFeed
6156 no form feed will be sent at the end of the last line
6157 printed (i.e., printerFormFeed is “false”).
6158 FormFeed
6160 a form feed will be sent at the end of the last line
6161 printed (i.e., printerFormFeed is “true”).
6162 noNewLine
6164 no newline will be sent at the end of the last line
6165 printed, and wrapped lines will be combined into long
6166 lines (i.e., printerNewLine is “false”).
6167 NewLine
6169 a newline will be sent at the end of the last line
6170 printed, and each line will be limited (by adding a
6171 newline) to the screen width (i.e., printerNewLine is
6172 “true”).
6173 noAttrs
6175 the page is printed without attributes (i.e.,
6176 printAttributes is “0”).
6177 monoAttrs
6179 the page is printed with monochrome (vt220) attributes
6180 (i.e., printAttributes is “1”).
6181 colorAttrs
6183 the page is printed with ANSI color attributes (i.e.,
6184 printAttributes is “2”).
6185 print-everything(printer-flags)
6187 This action sends the entire text history, in addition to the
6188 text currently visible, to the program given in the
6189 printerCommand resource. It allows the same optional
6190 parameters as the print action. With a suitable printer
6191 command, the action can be used to load the text history in an
6192 editor.
6193 print-immediate()
6195 Sends the text of the current window directly to a file, as
6196 specified by the printFileImmediate, printModeImmediate and
6197 printOptsImmediate resources.
6198 print-on-error()
6200 Toggles a flag telling xterm that if it exits with an X error,
6201 to send the text of the current window directly to a file, as
6202 specified by the printFileOnXError, printModeOnXError and
6203 printOptsOnXError resources.
6204 print-redir()
6206 This action toggles the printerControlMode between 0 and 2.
6207 The corresponding popup menu entry is useful for switching the
6208 printer off if you happen to change your mind after deciding to
6209 print random binary files on the terminal.
6210 quit()
6212 This action sends a SIGHUP to the subprogram and exits. It is
6213 also invoked by the quit entry in mainMenu.
6214 readline-button()
6216 Supports the optional readline feature by echoing repeated
6217 cursor forward or backward control sequences on button release
6218 event, to request that the host application update its notion
6219 of the cursor's position to match the button event.
6220 redraw()
6222 This action redraws the window. It is also invoked by the
6223 redraw entry in mainMenu.
6224 restore()
6226 Restores the window to the size before it was last maximized.
6227 scroll-back(count [,units [,mouse] ])
6229 This action scrolls the text window backward so that text that
6230 had previously scrolled off the top of the screen is now
6231 visible.
6232 The count argument indicates the number of units (which may be
6234 page, halfpage, pixel, or line) by which to scroll. If no
6235 count parameter is given, xterm uses the number of lines given
6236 by the scrollLines resource.
6237 An adjustment can be specified for the page or halfpage units
6239 by appending a “+” or “-” sign followed by a number, e.g.,
6240 page-2 to specify 2 lines less than a page.
6241 If the second parameter is omitted “lines” is used.
6243 If the third parameter mouse is given, the action is ignored
6245 when mouse reporting is enabled.
6246 scroll-forw(count [,units [,mouse] ])
6248 This action is similar to scroll-back except that it scrolls in
6249 the other direction.
6250 secure()
6252 This action toggles the Secure Keyboard mode (see SECURITY),
6253 and is invoked from the securekbd entry in mainMenu.
6254 scroll-lock(on/off/toggle)
6256 This action sets, unsets or toggles internal state which tells
6257 xterm whether Scroll Lock is active, subject to the
6258 allowScrollLock resource.
6259 scroll-to(count)
6261 Scroll to the given line relative to the beginning of the
6262 saved-lines. For instance, “scroll-to(0)” would scroll to the
6263 beginning. Two special nonnumeric parameters are recognized:
6264 scroll-to(begin)
6266 Scroll to the beginning of the saved lines.
6267 scroll-to(end)
6269 Scroll to the end of the saved lines, i.e., to the
6270 currently active page.
6271 select-cursor-end(destname [, ...])
6273 This action is similar to select-end except that it should be
6274 used with select-cursor-start.
6275 select-cursor-extend()
6277 This action is similar to select-extend except that it should
6278 be used with select-cursor-start.
6279 select-cursor-start()
6281 This action is similar to select-start except that it begins
6282 the selection at the current text cursor position.
6283 select-end(destname [, ...])
6285 This action puts the currently selected text into all of the
6286 selections or cutbuffers specified by destname. It also sends
6287 a mouse position and updates the internal selection state to
6288 reflect the end of the selection process.
6289 select-extend()
6291 This action tracks the pointer and extends the selection. It
6292 should only be bound to Motion events.
6293 select-set()
6295 This action stores text that corresponds to the current
6296 selection, without affecting the selection mode.
6297 select-start()
6299 This action begins text selection at the current pointer
6300 location. See the section on POINTER USAGE for information on
6301 making selections.
6302 send-signal(signame)
6304 This action sends the signal named by signame to the xterm
6305 subprocess (the shell or program specified with the -e command
6306 line option). It is also invoked by the suspend, continue,
6307 interrupt, hangup, terminate, and kill entries in mainMenu.
6308 Allowable signal names are (case is not significant): tstp (if
6309 supported by the operating system), suspend (same as tstp),
6310 cont (if supported by the operating system), int, hup, term,
6311 quit, alrm, alarm (same as alrm) and kill.
6312 set-8-bit-control(on/off/toggle)
6314 This action sets, unsets or toggles the eightBitControl
6315 resource. It is also invoked from the 8-bit-control entry in
6316 vtMenu.
6317 set-allow132(on/off/toggle)
6319 This action sets, unsets or toggles the c132 resource. It is
6320 also invoked from the allow132 entry in vtMenu.
6321 set-altscreen(on/off/toggle)
6323 This action sets, unsets or toggles between the alternate and
6324 current screens.
6325 set-appcursor(on/off/toggle)
6327 This action sets, unsets or toggles the handling Application
6328 Cursor Key mode and is also invoked by the appcursor entry in
6329 vtMenu.
6330 set-appkeypad(on/off/toggle)
6332 This action sets, unsets or toggles the handling of Application
6333 Keypad mode and is also invoked by the appkeypad entry in
6334 vtMenu.
6335 set-autolinefeed(on/off/toggle)
6337 This action sets, unsets or toggles automatic insertion of line
6338 feeds. It is also invoked by the autolinefeed entry in vtMenu.
6339 set-autowrap(on/off/toggle)
6341 This action sets, unsets or toggles automatic wrapping of long
6342 lines. It is also invoked by the autowrap entry in vtMenu.
6343 set-backarrow(on/off/toggle)
6345 This action sets, unsets or toggles the backarrowKey resource.
6346 It is also invoked from the backarrow key entry in vtMenu.
6347 set-bellIsUrgent(on/off/toggle)
6349 This action sets, unsets or toggles the bellIsUrgent resource.
6350 It is also invoked by the bellIsUrgent entry in vtMenu.
6351 set-cursorblink(on/off/toggle)
6353 This action sets, unsets or toggles the cursorBlink resource.
6354 It is also invoked from the cursorblink entry in vtMenu.
6355 set-cursesemul(on/off/toggle)
6357 This action sets, unsets or toggles the curses resource. It is
6358 also invoked from the cursesemul entry in vtMenu.
6359 set-font-doublesize(on/off/toggle)
6361 This action sets, unsets or toggles the fontDoublesize
6362 resource. It is also invoked by the font-doublesize entry in
6363 fontMenu.
6364 set-hp-function-keys(on/off/toggle)
6366 This action sets, unsets or toggles the hpFunctionKeys
6367 resource. It is also invoked by the hpFunctionKeys entry in
6368 mainMenu.
6369 set-jumpscroll(on/off/toggle)
6371 This action sets, unsets or toggles the jumpscroll resource.
6372 It is also invoked by the jumpscroll entry in vtMenu.
6373 set-font-linedrawing(on/off/toggle)
6375 This action sets, unsets or toggles the xterm's state regarding
6376 whether the current font has line-drawing characters and
6377 whether it should draw them directly. It is also invoked by
6378 the font-linedrawing entry in fontMenu.
6379 set-font-packed(on/off/toggle)
6381 This action sets, unsets or toggles the forcePackedFont
6382 resource which controls use of the font's minimum or maximum
6383 glyph width. It is also invoked by the font-packed entry in
6384 fontMenu.
6385 set-keep-clipboard(on/off/toggle)
6387 This action sets, unsets or toggles the keepClipboard resource.
6388 set-keep-selection(on/off/toggle)
6390 This action sets, unsets or toggles the keepSelection resource.
6391 It is also invoked by the keepSelection entry in vtMenu.
6392 set-logging(on/off/toggle)
6394 This action sets, unsets or toggles the state of the logging
6395 option.
6396 set-old-function-keys(on/off/toggle)
6398 This action sets, unsets or toggles the state of legacy
6399 function keys. It is also invoked by the oldFunctionKeys entry
6400 in mainMenu.
6401 set-marginbell(on/off/toggle)
6403 This action sets, unsets or toggles the marginBell resource.
6404 set-num-lock(on/off/toggle)
6406 This action toggles the state of the numLock resource.
6407 set-pop-on-bell(on/off/toggle)
6409 This action sets, unsets or toggles the popOnBell resource. It
6410 is also invoked by the poponbell entry in vtMenu.
6411 set-private-colors(on/off/toggle)
6413 This action sets, unsets or toggles the privateColorRegisters
6414 resource.
6415 set-render-font(on/off/toggle)
6417 This action sets, unsets or toggles the renderFont resource.
6418 It is also invoked by the render-font entry in fontMenu.
6419 set-reverse-video(on/off/toggle)
6421 This action sets, unsets or toggles the reverseVideo resource.
6422 It is also invoked by the reversevideo entry in vtMenu.
6423 set-reversewrap(on/off/toggle)
6425 This action sets, unsets or toggles the reverseWrap resource.
6426 It is also invoked by the reversewrap entry in vtMenu.
6427 set-scroll-on-key(on/off/toggle)
6429 This action sets, unsets or toggles the scrollKey resource. It
6430 is also invoked from the scrollkey entry in vtMenu.
6431 set-scroll-on-tty-output(on/off/toggle)
6433 This action sets, unsets or toggles the scrollTtyOutput
6434 resource. It is also invoked from the scrollttyoutput entry in
6435 vtMenu.
6436 set-scrollbar(on/off/toggle)
6438 This action sets, unsets or toggles the scrollbar resource. It
6439 is also invoked by the scrollbar entry in vtMenu.
6440 set-sco-function-keys(on/off/toggle)
6442 This action sets, unsets or toggles the scoFunctionKeys
6443 resource. It is also invoked by the scoFunctionKeys entry in
6444 mainMenu.
6445 set-select(on/off/toggle)
6447 This action sets, unsets or toggles the selectToClipboard
6448 resource. It is also invoked by the selectToClipboard entry in
6449 vtMenu.
6450 set-sixel-scrolling(on/off/toggle)
6452 This action toggles between inline (sixel scrolling) and
6453 absolute positioning. It can also be controlled via DEC
6454 private mode 80 (DECSDM) or from the sixelScrolling entry in
6455 the btMenu.
6456 set-sun-function-keys(on/off/toggle)
6458 This action sets, unsets or toggles the sunFunctionKeys
6459 resource. It is also invoked by the sunFunctionKeys entry in
6460 mainMenu.
6461 set-sun-keyboard(on/off/toggle)
6463 This action sets, unsets or toggles the sunKeyboard resource.
6464 It is also invoked by the sunKeyboard entry in mainMenu.
6465 set-tek-text(large/2/3/small)
6467 This action sets the font used in the Tektronix window to the
6468 value of the selected resource according to the argument. The
6469 argument can be either a keyword or single-letter alias, as
6470 shown in parentheses:
6471 large (l)
6473 Use resource fontLarge, same as menu entry tektextlarge.
6474 two (2)
6476 Use resource font2, same as menu entry tektext2.
6477 three (3)
6479 Use resource font3, same as menu entry tektext3.
6480 small (s)
6482 Use resource fontSmall, same as menu entry tektextsmall.
6483 set-terminal-type(type)
6485 This action directs output to either the vt or tek windows,
6486 according to the type string. It is also invoked by the
6487 tekmode entry in vtMenu and the vtmode entry in tekMenu.
6488 set-titeInhibit(on/off/toggle)
6490 This action sets, unsets or toggles the titeInhibit resource,
6491 which controls switching between the alternate and current
6492 screens.
6493 set-toolbar(on/off/toggle)
6495 This action sets, unsets or toggles the toolbar feature. It is
6496 also invoked by the toolbar entry in mainMenu.
6497 set-utf8-fonts(on/off/toggle)
6499 This action sets, unsets or toggles the utf8Fonts resource. It
6500 is also invoked by the utf8-fonts entry in fontMenu.
6501 set-utf8-mode(on/off/toggle)
6503 This action sets, unsets or toggles the utf8 resource. It is
6504 also invoked by the utf8-mode entry in fontMenu.
6505 set-utf8-title(on/off/toggle)
6507 This action sets, unsets or toggles the utf8Title resource. It
6508 is also invoked by the utf8-title entry in fontMenu.
6509 set-visibility(vt/tek,on/off/toggle)
6511 This action sets, unsets or toggles whether or not the vt or
6512 tek windows are visible. It is also invoked from the tekshow
6513 and vthide entries in vtMenu and the vtshow and tekhide entries
6514 in tekMenu.
6515 set-visual-bell(on/off/toggle)
6517 This action sets, unsets or toggles the visualBell resource.
6518 It is also invoked by the visualbell entry in vtMenu.
6519 set-vt-font(d/1/2/3/4/5/6/7/e/s [,normalfont [, boldfont]])
6521 This action sets the font or fonts currently being used in the
6522 VTxxx window. The first argument is a single character that
6523 specifies the font to be used:
6524 d or D indicate the default font (the font initially used when
6526 xterm was started),
6527 1 through 7 indicate the fonts specified by the font1 through
6529 font7 resources,
6530 e or E indicate the normal and bold fonts that have been set
6532 through escape codes (or specified as the second and
6533 third action arguments, respectively), and
6534 s or S indicate the font selection (as made by programs such as
6536 xfontsel(1)) indicated by the second action argument.
6537 If xterm is configured to support wide characters, an
6539 additional two optional parameters are recognized for the e
6540 argument: wide font and wide bold font.
6541 smaller-vt-font()
6543 Set the font to the next smaller one, based on the font
6544 dimensions. See also set-vt-font().
6545 soft-reset()
6547 This action resets the scrolling region. It is also invoked
6548 from the softreset entry in vtMenu. The effect is identical to
6549 a soft reset (DECSTR) control sequence.
6550 spawn-new-terminal(params)
6552 Spawn a new xterm process. This is available on systems which
6553 have a modern version of the process filesystem, e.g., “/proc”,
6554 which xterm can read.
6555 Use the “cwd” process entry, e.g., /proc/12345/cwd to obtain
6557 the working directory of the process which is running in the
6558 current xterm.
6559 On systems which have the “exe” process entry, e.g.,
6561 /proc/12345/exe, use this to obtain the actual executable.
6562 Otherwise, use the $PATH variable to find xterm.
6563 If parameters are given in the action, pass them to the new
6565 xterm process.
6566 start-extend()
6568 This action is similar to select-start except that the
6569 selection is extended to the current pointer location.
6570 start-cursor-extend()
6572 This action is similar to select-extend except that the
6573 selection is extended to the current text cursor position.
6574 string(string)
6576 This action inserts the specified text string as if it had been
6577 typed. Quotation is necessary if the string contains
6578 whitespace or non-alphanumeric characters. If the string
6579 argument begins with the characters “0x”, it is interpreted as
6580 a hex character constant.
6581 tek-copy()
6583 This action copies the escape codes used to generate the
6584 current window contents to a file in the current directory
6585 beginning with the name COPY. It is also invoked from the
6586 tekcopy entry in tekMenu.
6587 tek-page()
6589 This action clears the Tektronix window. It is also invoked by
6590 the tekpage entry in tekMenu.
6591 tek-reset()
6593 This action resets the Tektronix window. It is also invoked by
6594 the tekreset entry in tekMenu.
6595 vi-button()
6597 Handles a button event (other than press and release) by
6598 echoing a control sequence computed from the event's line
6599 number in the screen relative to the current line:
6600 ESC ^P
6602 or
6604 ESC ^N
6606 according to whether the event is before, or after the current
6608 line, respectively. The ^N (or ^P) is repeated once for each
6609 line that the event differs from the current line. The control
6610 sequence is omitted altogether if the button event is on the
6611 current line.
6612 visual-bell()
6614 This action flashes the window quickly.
6615 The Tektronix window also has the following action:
6617 gin-press(l/L/m/M/r/R)
6619 This action sends the indicated graphics input code.
6620 Default Key Bindings
6622 The default bindings in the VTxxx window use the SELECT token, which is
6623 set by the selectToClipboard resource. These are for the vt100 widget:
6624 Shift <KeyPress> Prior:scroll-back(1,halfpage) \n\
6626 Shift <KeyPress> Next:scroll-forw(1,halfpage) \n\
6627 Shift <KeyPress> Select:select-cursor-start() \
6628 select-cursor-end(SELECT, CUT_BUFFER0) \n\
6629 Shift <KeyPress> Insert:insert-selection(SELECT, CUT_BUFFER0) \n\
6630 Alt <Key>Return:fullscreen() \n\
6631 <KeyRelease> Scroll_Lock:scroll-lock() \n\
6632 Shift~Ctrl <KeyPress> KP_Add:larger-vt-font() \n\
6633 Shift Ctrl <KeyPress> KP_Add:smaller-vt-font() \n\
6634 Shift <KeyPress> KP_Subtract:smaller-vt-font() \n\
6635 ~Meta <KeyPress>:insert-seven-bit() \n\
6636 Meta <KeyPress>:insert-eight-bit() \n\
6637 !Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
6638 !Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
6639 !Lock Ctrl @Num_Lock <Btn1Down>:popup-menu(mainMenu) \n\
6640 ! @Num_Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
6641 ~Meta <Btn1Down>:select-start() \n\
6642 ~Meta <Btn1Motion>:select-extend() \n\
6643 !Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
6644 !Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
6645 !Lock Ctrl @Num_Lock <Btn2Down>:popup-menu(vtMenu) \n\
6646 ! @Num_Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
6647 ~Ctrl ~Meta <Btn2Down>:ignore() \n\
6648 Meta <Btn2Down>:clear-saved-lines() \n\
6649 ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0) \n\
6650 !Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
6651 !Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
6652 !Lock Ctrl @Num_Lock <Btn3Down>:popup-menu(fontMenu) \n\
6653 ! @Num_Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
6654 ~Ctrl ~Meta <Btn3Down>:start-extend() \n\
6655 ~Meta <Btn3Motion>:select-extend() \n\
6656 Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6657 Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6658 Lock @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6659 @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
6660 <Btn4Down>:scroll-back(5,line,m) \n\
6661 Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6662 Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6663 Lock @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6664 @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
6665 <Btn5Down>:scroll-forw(5,line,m) \n\
6666 <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n\
6667 <BtnMotion>:pointer-motion() \n\
6668 <BtnDown>:pointer-button() \n\
6669 <BtnUp>:pointer-button() \n\
6670 <BtnDown>:ignore()
6671 The default bindings in the Tektronix window are analogous but less
6673 extensive. These are for the tek4014 widget:
6674 ~Meta<KeyPress>: insert-seven-bit() \n\
6676 Meta<KeyPress>: insert-eight-bit() \n\
6677 !Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
6678 !Lock Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
6679 !Lock Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
6680 !Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
6681 !Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
6682 !Lock Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
6683 !Lock Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
6684 !Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
6685 Shift ~Meta<Btn1Down>: gin-press(L) \n\
6686 ~Meta<Btn1Down>: gin-press(l) \n\
6687 Shift ~Meta<Btn2Down>: gin-press(M) \n\
6688 ~Meta<Btn2Down>: gin-press(m) \n\
6689 Shift ~Meta<Btn3Down>: gin-press(R) \n\
6690 ~Meta<Btn3Down>: gin-press(r)
6691 Custom Key Bindings
6693 You can modify the translations resource by overriding parts of it, or
6694 merging your resources with it.
6695 Here is an example which uses shifted select/paste to copy to the
6697 clipboard, and unshifted select/paste for the primary selection. In
6698 each case, a (different) cut buffer is also a target or source of the
6699 select/paste operation. It is important to remember however, that cut
6700 buffers store data in ISO-8859-1 encoding, while selections can store
6701 data in a variety of formats and encodings. While xterm owns the
6702 selection, it highlights it. When it loses the selection, it removes
6703 the corresponding highlight. But you can still paste from the
6704 corresponding cut buffer.
6705 *VT100*translations: #override \n\
6707 ~Shift~Ctrl<Btn2Up>: insert-selection(PRIMARY, CUT_BUFFER0) \n\
6708 Shift~Ctrl<Btn2Up>: insert-selection(CLIPBOARD, CUT_BUFFER1) \n\
6709 ~Shift <BtnUp> : select-end(PRIMARY, CUT_BUFFER0) \n\
6710 Shift <BtnUp> : select-end(CLIPBOARD, CUT_BUFFER1)
6711 In the example, the class name VT100 is used rather than the widget
6713 name. These are different; a class name could apply to more than one
6714 widget. A leading “*” is used because the widget hierarchy above the
6715 vt100 widget depends on whether the toolbar support is compiled into
6716 xterm.
6717 Most of the predefined translations are related to the mouse, with a
6719 few that use some of the special keys on the keyboard. Applications
6720 use special keys (function-keys, cursor-keys, keypad-keys) with
6721 modifiers (shift, control, alt). If xterm defines a translation for a
6722 given combination of special key and modifier, that makes it
6723 unavailable for use by applications within the terminal. For instance,
6724 one might extend the use of Page Up and Page Down keys seen here:
6725 Shift <KeyPress> Prior : scroll-back(1,halfpage) \n\
6727 Shift <KeyPress> Next : scroll-forw(1,halfpage) \n\
6728 to the Home and End keys:
6730 Shift <KeyPress> Home : scroll-to(begin) \n\
6732 Shift <KeyPress> End : scroll-to(end)
6733 but then shift-Home and shift-End would then be unavailable to
6735 applications.
6736 Not everyone finds the three-button mouse bindings easy to use. In a
6738 wheel mouse, the middle button might be the wheel. As an alternative,
6739 you could add a binding using shifted keys:
6740 *VT100*translations: #override \n\
6742 Shift <Key>Home: copy-selection(SELECT) \n\
6743 Shift <Key>Insert: copy-selection(SELECT) \n\
6744 Ctrl Shift <Key>C: copy-selection(SELECT) \n\
6745 Ctrl Shift <Key>V: insert-selection(SELECT)
6746 You would still use the left- and right-mouse buttons (typically 1 and
6748 3) for beginning and extending selections.
6749 Besides mouse problems, there are also keyboards with inconvenient
6751 layouts. Some lack a numeric keypad, making it hard to use the shifted
6752 keypad plus and minus bindings for switching between font sizes. You
6753 can work around that by assigning the actions to more readily accessed
6754 keys:
6755 *VT100*translations: #override \n\
6757 Ctrl <Key> +: larger-vt-font() \n\
6758 Ctrl <Key> -: smaller-vt-font()
6759 The keymap feature allows you to switch between sets of translations.
6761 The sample below shows how the keymap() action may be used to add
6762 special keys for entering commonly-typed words:
6763 *VT100.Translations: #override <Key>F13: keymap(dbx)
6765 *VT100.dbxKeymap.translations: \
6766 <Key>F14: keymap(None) \n\
6767 <Key>F17: string("next") \n\
6768 string(0x0d) \n\
6769 <Key>F18: string("step") \n\
6770 string(0x0d) \n\
6771 <Key>F19: string("continue") \n\
6772 string(0x0d) \n\
6773 <Key>F20: string("print ") \n\
6774 insert-selection(PRIMARY, CUT_BUFFER0)
6775 Default Scrollbar Bindings
6777 Key bindings are normally associated with the vt100 or tek4014 widgets
6778 which act as terminal emulators. Xterm's scrollbar (and toolbar if it
6779 is configured) are separate widgets. Because all of these use the X
6780 Toolkit, they have corresponding translations resources. Those
6781 resources are distinct, and match different patterns, e.g., the
6782 differences in widget-name and number of levels of widgets which they
6783 may contain.
6784 The scrollbar widget is a child of the vt100 widget. It is positioned
6786 on top of the vt100 widget. Toggling the scrollbar on and off causes
6787 the vt100 widget to resize.
6788 The default bindings for the scrollbar widget use only mouse-button
6790 events:
6791 <Btn5Down>: StartScroll(Forward) \n\
6793 <Btn1Down>: StartScroll(Forward) \n\
6794 <Btn2Down>: StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
6795 <Btn3Down>: StartScroll(Backward) \n\
6796 <Btn4Down>: StartScroll(Backward) \n\
6797 <Btn2Motion>: MoveThumb() NotifyThumb() \n\
6798 <BtnUp>: NotifyScroll(Proportional) EndScroll()
6799 Events which the scrollbar widget does not recognize at all are lost.
6801 However, at startup, xterm augments these translations with the default
6803 translations used for the vt100 widget, together with the resource
6804 “actions” which those translations use. Because the scrollbar (or
6805 menubar) widgets do not recognize these actions (but because it has a
6806 corresponding translation), they are passed on to the vt100 widget.
6807 This augmenting of the scrollbar's translations has a few limitations:
6809 · Xterm knows what the default translations are, but there is no
6811 suitable library interface for determining what customizations a
6812 user may have added to the vt100 widget. All that xterm can do is
6813 augment the scrollbar widget to give it the same starting point for
6814 further customization by the user.
6815 · Events in the gap between the widgets may be lost.
6817 · Compose sequences begun in one widget cannot be completed in the
6819 other, because the input methods for each widget do not share
6820 context information.
6821 Most customizations of the scrollbar translations do not concern key
6823 bindings. Rather, users are generally more interested in changing the
6824 bindings of the mouse buttons. For example, some people prefer using
6825 the left pointer button for dragging the scrollbar thumb. That can be
6826 set up by altering the translations resource, e.g.,
6827 *VT100.scrollbar.translations: #override \n\
6829 <Btn5Down>: StartScroll(Forward) \n\
6830 <Btn1Down>: StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
6831 <Btn4Down>: StartScroll(Backward) \n\
6832 <Btn1Motion>: MoveThumb() NotifyThumb() \n\
6833 <BtnUp>: NotifyScroll(Proportional) EndScroll()
6834
6836 Applications can send sequences of characters to the terminal to change
6837 its behavior. Often they are referred to as “ANSI escape sequences” or
6838 just plain “escape sequences” but both terms are misleading:
6839 · ANSI x3.64 (obsolete) which was replaced by ISO 6429 (ECMA-48) gave
6841 rules for the format of these sequences of characters.
6842 · While the original VT100 was claimed to be ANSI-compatible (against
6844 x3.64), there is no freely available version of the ANSI standard
6845 to show where the VT100 differs. Most of the documents which
6846 mention the ANSI standard have additions not found in the original
6847 (such as those based on ansi.sys). So this discussion focuses on
6848 the ISO standards.
6849 · The standard describes only sequences sent from the host to the
6851 terminal. There is no standard for sequences sent by special keys
6852 from the terminal to the host. By convention (and referring to
6853 existing terminals), the format of those sequences usually conforms
6854 to the host-to-terminal standard.
6855 · Some of xterm's sequences do not fit into the standard scheme.
6857 Technically those are “unspecified”. As an example, DEC Screen
6858 Alignment Test (DECALN) is this three-character sequence:
6859 ESC # 8
6861 · Some sequences fit into the standard format, but are not listed in
6863 the standard. These include the sequences used for setting up
6864 scrolling margins and doing forward/reverse scrolling.
6865 · Some of the sequences (in particular, the single-character
6867 functions such as tab and backspace) do not include the escape
6868 character.
6869 With all of that in mind, the standard refers to these sequences of
6871 characters as “control sequences”.
6872 Xterm Control Sequences lists the control sequences which an
6874 application can send xterm to make it perform various operations. Most
6875 of these operations are standardized, from either the DEC or Tektronix
6876 terminals, or from more widely used standards such as ISO-6429.
6877 A few examples of usage are given in this section.
6879 Window and Icon Titles
6881 Some scripts use echo with options -e and -n to tell the shell to
6882 interpret the string “\e” as the escape character and to suppress a
6883 trailing newline on output. Those are not portable, nor recommended.
6884 Instead, use printf (POSIX).
6885 For example, to set the window title to “Hello world!”, you could use
6887 one of these commands in a script:
6888 printf '\033]2;Hello world!\033\'
6890 printf '\033]2;Hello world!\007'
6891 printf '\033]2;%s\033\' "Hello world!"
6892 printf '\033]2;%s\007' "Hello world!"
6893 The printf command interprets the octal value “\033” for escape, and
6895 (since it was not given in the format) omits a trailing newline from
6896 the output.
6897 Some programs (such as screen(1)) set both window- and icon-titles at
6899 the same time, using a slightly different control sequence:
6900 printf '\033]0;Hello world!\033\'
6902 printf '\033]0;Hello world!\007'
6903 printf '\033]0;%s\033\' "Hello world!"
6904 printf '\033]0;%s\007' "Hello world!"
6905 The difference is the parameter “0” in each command. Most window
6907 managers will honor either window title or icon title. Some will make
6908 a distinction and allow you to set just the icon title. You can tell
6909 xterm to ask for this with a different parameter in the control
6910 sequence:
6911 printf '\033]1;Hello world!\033\'
6913 printf '\033]1;Hello world!\007'
6914 printf '\033]1;%s\033\' "Hello world!"
6915 printf '\033]1;%s\007' "Hello world!"
6916 Special Keys
6918 Xterm, like any VT100-compatible terminal emulator, has two modes for
6919 the special keys (cursor-keys, numeric keypad, and certain function-
6920 keys):
6921 · normal mode, which makes the special keys transmit “useful”
6923 sequences such as the control sequence for cursor-up when pressing
6924 the up-arrow, and
6925 · application mode, which uses a different control sequence that
6927 cannot be mistaken for the “useful” sequences.
6928 The main difference between the two modes is that normal mode sequences
6930 start with CSI (escape [) and application mode sequences start with SS3
6931 (escape O).
6932 The terminal is initialized into one of these two modes (usually the
6934 normal mode), based on the terminal description (termcap or terminfo).
6935 The terminal description also has capabilities (strings) defined for
6936 the keypad mode used in curses applications.
6937 There is a problem in using the terminal description for applications
6939 that are not intended to be full-screen curses applications: the
6940 definitions of special keys are only correct for this keypad mode. For
6941 example, some shells (unlike ksh(1), which appears to be hard-coded,
6942 not even using termcap) allow their users to customize key-bindings,
6943 assigning shell actions to special keys.
6944 · bash(1) allows constant strings to be assigned to functions. This
6946 is only successful if the terminal is initialized to application
6947 mode by default, because bash lacks flexibility in this area. It
6948 uses a (less expressive than bash's) readline scripting language
6949 for setting up key bindings, which relies upon the user to
6950 statically enumerate the possible bindings for given values of
6951 $TERM.
6952 · zsh(1) provides an analogous feature, but it accepts runtime
6954 expressions, as well as providing a $terminfo array for scripts.
6955 In particular, one can use the terminal database, transforming when
6956 defining a key-binding. By transforming the output so that CSI and
6957 SS3 are equated, zsh can use the terminal database to obtain useful
6958 definitions for its command-line use regardless of whether the
6959 terminal uses normal or application mode initially. Here is an
6960 example:
6961 [[ "$terminfo[kcuu1]" == "^[O"* ]] && \
6963 bindkey -M viins "${terminfo[kcuu1]/O/[}" \
6964 vi-up-line-or-history
6965 Changing Colors
6967 A few shell programs provide the ability for users to add color and
6968 other video attributes to the shell prompt strings. Users can do this
6969 by setting $PS1 (the primary prompt string). Again, bash and zsh have
6970 provided features not found in ksh. There is a problem, however: the
6971 prompt's width on the screen will not necessarily be the same as the
6972 number of characters. Because there is no guidance in the POSIX
6973 standard, each shell addresses the problem in a different way:
6974 · bash treats characters within “\[” and “\]” as nonprinting (using
6976 no width on the screen).
6977 · zsh treats characters within “%{” and “%}” as nonprinting.
6979 In addition to the difference in syntax, the shells provide different
6981 methods for obtaining useful escape sequences:
6982 · As noted in Special Keys, zsh initializes the $terminfo array with
6984 the terminal capabilities.
6985 It also provides a function echoti which works like tput(1) to
6987 convert a terminal capability with its parameters into a string
6988 that can be written to the terminal.
6989 · Shells lacking a comparable feature (such as bash) can always use
6991 the program tput to do this transformation.
6992 Hard-coded escape sequences are supported by each shell, but are not
6994 recommended because those rely upon particular configurations and
6995 cannot be easily moved between different user environments.
6996
6998 Xterm sets several environment variables.
6999 System Independent
7001 Some variables are used on every system:
7002 DISPLAY
7004 is the display name, pointing to the X server (see DISPLAY NAMES
7005 in X(7)).
7006 TERM
7008 is set according to the terminfo (or termcap) entry which it is
7009 using as a reference.
7010 On some systems, you may encounter situations where the shell
7012 which you use and xterm are built using libraries with different
7013 terminal databases. In that situation, xterm may choose a
7014 terminal description not known to the shell.
7015 WINDOWID
7017 is set to the X window id number of the xterm window.
7018 XTERM_FILTER
7020 is set if a locale-filter is used. The value is the pathname of
7021 the filter.
7022 XTERM_LOCALE
7024 shows the locale which was used by xterm on startup. Some shell
7025 initialization scripts may set a different locale.
7026 XTERM_SHELL
7028 is set to the pathname of the program which is invoked. Usually
7029 that is a shell program, e.g., /bin/sh. Since it is not
7030 necessarily a shell program however, it is distinct from “SHELL”.
7031 XTERM_VERSION
7033 is set to the string displayed by the -version option. That is
7034 normally an identifier for the X Window libraries used to build
7035 xterm, followed by xterm's patch number in parenthesis. The patch
7036 number is also part of the response to a Secondary Device
7037 Attributes (DA) control sequence (see Xterm Control Sequences).
7038 System Dependent
7040 Depending on your system configuration, xterm may also set the
7041 following:
7042 COLUMNS
7044 the width of the xterm in characters (cf: “stty columns”).
7045 When this variable is set, curses applications (and most terminal
7047 programs) will assume that the terminal has this many columns.
7048 Xterm would do this for systems which have no ability to tell the
7050 size of the terminal. Those are very rare, none newer than the
7051 mid 1990s when SVR4 became prevalent.
7052 HOME
7054 when xterm is configured (at build-time) to update utmp.
7055 LINES
7057 the height of the xterm in characters (cf: “stty rows”).
7058 When this variable is set, curses applications (and most terminal
7060 programs) will assume that the terminal has this many lines
7061 (rows).
7062 Xterm would do this for systems which have no ability to tell the
7064 size of the terminal. Those are very rare, none newer than the
7065 mid 1990s when SVR4 became prevalent.
7066 LOGNAME
7068 when xterm is configured (at build-time) to update utmp.
7069 Your configuration may have set LOGNAME; xterm does not modify
7071 that. If it is unset, xterm will use USER if it is set. Finally,
7072 if neither is set, xterm will use the getlogin(3) function.
7073 SHELL
7075 when xterm is configured (at build-time) to update utmp. It is
7076 also set if you provide a valid shell name as the optional
7077 parameter.
7078 Xterm sets this to an absolute pathname. If you have set the
7080 variable to a relative pathname, xterm may set it to a different
7081 shell pathname.
7082 If you have set this to an pathname which does not correspond to a
7084 valid shell, xterm may unset it, to avoid confusion.
7085 TERMCAP
7087 the contents of the termcap entry corresponding to $TERM, with
7088 lines and columns values substituted for the actual size window
7089 you have created.
7090 This feature is, like LINES and COLUMNS, used rarely. It
7092 addresses the same limitation of a few older systems by providing
7093 a way for termcap-based applications to get the initial screen
7094 size.
7095 TERMINFO
7097 may be defined to a nonstandard location using the configure
7098 script.
7099
7101 In the output from xprop(1), there are several properties.
7102 Properties set by X Toolkit
7104 WM_CLASS
7105 This shows the instance name and the X resource class, passed to X
7106 Toolkit during initialization of xterm, e.g.,
7107 WM_CLASS(STRING) = "xterm", "UXTerm"
7109 WM_CLIENT_LEADER
7111 This shows the window-id which xterm provides with an environment
7112 variable (WINDOWID), e.g.,
7113 WM_CLIENT_LEADER(WINDOW): window id # 0x800023
7115 WM_COMMAND
7117 This shows the command-line arguments for xterm which are passed
7118 to X Toolkit during initialization, e.g.,
7119 WM_COMMAND(STRING) = { "xterm", "-class", "UXTerm", "-title", "uxterm", "-u8" }
7121 WM_ICON_NAME
7123 This holds the icon title, which different window managers handle
7124 in various ways. It is set via the iconName resource.
7125 Applications can change this using control sequences.
7126 WM_LOCALE_NAME
7128 This shows the result from the setlocale(3) function for the
7129 LC_CTYPE category, e.g.,
7130 WM_LOCALE_NAME(STRING) = "en_US.UTF-8"
7132 WM_NAME
7134 This holds the window title, normally at the top of xterm's
7135 window. It is set via the title resource. Applications can
7136 change this using control sequences.
7137 Properties set by Xterm
7139 X Toolkit does not manage EWMH properties. Xterm does this directly.
7140 _NET_WM_ICON_NAME
7142 stores the icon name.
7143 _NET_WM_NAME
7145 stores the title string.
7146 _NET_WM_PID
7148 stores the process identifier for xterm's display.
7149 Properties used by Xterm
7151 _NET_SUPPORTED
7152 Xterm checks this property on the supporting window to decide if
7153 the window manager supports specific maximizing styles. That may
7154 include other window manager hints; xterm uses the X library calls
7155 to manage those.
7156 _NET_SUPPORTING_WM_CHECK
7158 Xterm checks this to ensure that it will only update the EWMH
7159 properties for a window manager which claims EWMH compliance.
7160 _NET_WM_STATE
7162 This tells xterm whether its window has been maximized by the
7163 window manager, and if so, what type of maximizing:
7164 _NET_WM_STATE_FULLSCREEN
7166 _NET_WM_STATE_MAXIMIZED_HORZ
7168 _NET_WM_STATE_MAXIMIZED_VERT
7170
7172 The actual pathnames given may differ on your system.
7173 /etc/shells
7175 contains a list of valid shell programs, used by xterm to decide
7176 if the “SHELL” environment variable should be set for the process
7177 started by xterm.
7178 On systems which have the getusershell function, xterm will use
7180 that function rather than directly reading the file, since the
7181 file may not be present if the system uses default settings.
7182 /etc/utmp
7184 the system log file, which records user logins.
7185 /etc/wtmp
7187 the system log file, which records user logins and logouts.
7188 /usr/share/X11/app-defaults/XTerm
7190 the xterm default application resources.
7191 /usr/share/X11/app-defaults/XTerm-color
7193 the xterm color application resources. If your display supports
7194 color, use this
7195 *customization: -color
7197 in your .Xdefaults file to automatically use this resource file
7199 rather than /usr/share/X11/app-defaults/XTerm. If you do not do
7200 this, xterm uses its compiled-in default resource settings for
7201 colors.
7202 /usr/share/pixmaps
7204 the directory in which xterm's pixmap icon files are installed.
7205
7207 Most of the fatal error messages from xterm use the following format:
7208 xterm: Error XXX, errno YYY: ZZZ
7210 The XXX codes (which are used by xterm as its exit-code) are listed
7212 below, with a brief explanation.
7213 1 is used for miscellaneous errors, usually accompanied by a
7215 specific message,
7216 11 ERROR_FIONBIO
7218 main: ioctl() failed on FIONBIO
7219 12 ERROR_F_GETFL
7221 main: ioctl() failed on F_GETFL
7222 13 ERROR_F_SETFL
7224 main: ioctl() failed on F_SETFL
7225 14 ERROR_OPDEVTTY
7227 spawn: open() failed on /dev/tty
7228 15 ERROR_TIOCGETP
7230 spawn: ioctl() failed on TIOCGETP
7231 17 ERROR_PTSNAME
7233 spawn: ptsname() failed
7234 18 ERROR_OPPTSNAME
7236 spawn: open() failed on ptsname
7237 19 ERROR_PTEM
7239 spawn: ioctl() failed on I_PUSH/"ptem"
7240 20 ERROR_CONSEM
7242 spawn: ioctl() failed on I_PUSH/"consem"
7243 21 ERROR_LDTERM
7245 spawn: ioctl() failed on I_PUSH/"ldterm"
7246 22 ERROR_TTCOMPAT
7248 spawn: ioctl() failed on I_PUSH/"ttcompat"
7249 23 ERROR_TIOCSETP
7251 spawn: ioctl() failed on TIOCSETP
7252 24 ERROR_TIOCSETC
7254 spawn: ioctl() failed on TIOCSETC
7255 25 ERROR_TIOCSETD
7257 spawn: ioctl() failed on TIOCSETD
7258 26 ERROR_TIOCSLTC
7260 spawn: ioctl() failed on TIOCSLTC
7261 27 ERROR_TIOCLSET
7263 spawn: ioctl() failed on TIOCLSET
7264 28 ERROR_INIGROUPS
7266 spawn: initgroups() failed
7267 29 ERROR_FORK
7269 spawn: fork() failed
7270 30 ERROR_EXEC
7272 spawn: exec() failed
7273 32 ERROR_PTYS
7275 get_pty: not enough ptys
7276 34 ERROR_PTY_EXEC
7278 waiting for initial map
7279 35 ERROR_SETUID
7281 spawn: setuid() failed
7282 36 ERROR_INIT
7284 spawn: can't initialize window
7285 46 ERROR_TIOCKSET
7287 spawn: ioctl() failed on TIOCKSET
7288 47 ERROR_TIOCKSETC
7290 spawn: ioctl() failed on TIOCKSETC
7291 49 ERROR_LUMALLOC
7293 luit: command-line malloc failed
7294 50 ERROR_SELECT
7296 in_put: select() failed
7297 54 ERROR_VINIT
7299 VTInit: can't initialize window
7300 57 ERROR_KMMALLOC1
7302 HandleKeymapChange: malloc failed
7303 60 ERROR_TSELECT
7305 Tinput: select() failed
7306 64 ERROR_TINIT
7308 TekInit: can't initialize window
7309 71 ERROR_BMALLOC2
7311 SaltTextAway: malloc() failed
7312 80 ERROR_LOGEXEC
7314 StartLog: exec() failed
7315 83 ERROR_XERROR
7317 xerror: XError event
7318 84 ERROR_XIOERROR
7320 xioerror: X I/O error
7321 85 ERROR_ICEERROR
7323 ICE I/O error
7324 90 ERROR_SCALLOC
7326 Alloc: calloc() failed on base
7327 91 ERROR_SCALLOC2
7329 Alloc: calloc() failed on rows
7330 102 ERROR_SAVE_PTR
7332 ScrnPointers: malloc/realloc() failed
7333
7335 Large pastes do not work on some systems. This is not a bug in xterm;
7336 it is a bug in the pseudo terminal driver of those systems. Xterm
7337 feeds large pastes to the pty only as fast as the pty will accept data,
7338 but some pty drivers do not return enough information to know if the
7339 write has succeeded.
7340 When connected to an input method, it is possible for xterm to hang if
7342 the XIM server is suspended or killed.
7343 Many of the options are not resettable after xterm starts.
7345 This program still needs to be rewritten. It should be split into very
7347 modular sections, with the various emulators being completely separate
7348 widgets that do not know about each other. Ideally, you'd like to be
7349 able to pick and choose emulator widgets and stick them into a single
7350 control widget.
7351 There needs to be a dialog box to allow entry of the Tek COPY file
7353 name.
7354
7356 resize(1), luit(1), uxterm(1), X(7), pty(4), tty(4)
7357 Xterm Control Sequences (this is the file ctlseqs.ms).
7359 https://invisible-island.net/xterm/xterm.html
7361 https://invisible-island.net/xterm/manpage/xterm.html
7362 https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
7363 https://invisible-island.net/xterm/xterm.faq.html
7364 https://invisible-island.net/xterm/xterm.log.html
7365 X Toolkit Intrinsics – C Language Interface (Xt),
7367 Joel McCormack, Paul Asente, Ralph R. Swick (1994),
7368 Thomas E. Dickey (2019).
7369 Inter-Client Communication Conventions Manual (ICCCM),
7371 David Rosenthal and Stuart W. Marks (version 2.0, 1994).
7372 Extended Window Manager Hints (EWMH),
7374 X Desktop Group (version 1.3, 2005).
7375 EWMH uses UTF8_STRING pervasively without defining it, but does mention
7377 the ICCCM. Version 2.0 of the ICCCM does not address UTF-8. That is
7378 an extension added in XFree86.
7379 · Markus Kuhn summarized this in UTF-8 and Unicode FAQ for Unix/Linux
7381 (2001), in the section “Is X11 ready for Unicode?”
7382 https://www.cl.cam.ac.uk/~mgk25/unicode.html
7384 · Juliusz Chroboczek proposed the UTF8_STRING selection atom in
7386 1999/2000, which became part of the ICCCM in XFree86.
7387 https://www.irif.fr/~jch/software/UTF8_STRING/
7389 An Xorg developer removed that part of the documentation in 2004
7391 when incorporating other work from XFree86 into Xorg. The feature
7392 is still supported in Xorg, though undocumented as of 2019.
7393
7395 Far too many people.
7396 These contributed to the X Consortium: Loretta Guarino Reid (DEC-UEG-
7398 WSL), Joel McCormack (DEC-UEG-WSL), Terry Weissman (DEC-UEG-WSL),
7399 Edward Moy (Berkeley), Ralph R. Swick (MIT-Athena), Mark Vandevoorde
7400 (MIT-Athena), Bob McNamara (DEC-MAD), Jim Gettys (MIT-Athena), Bob
7401 Scheifler (MIT X Consortium), Doug Mink (SAO), Steve Pitschke
7402 (Stellar), Ron Newman (MIT-Athena), Jim Fulton (MIT X Consortium), Dave
7403 Serisky (HP), Jonathan Kamens (MIT-Athena).
7404 Beginning with XFree86, there were far more identifiable contributors.
7406 The THANKS file in xterm's source lists 228 in September 2020. Keep in
7407 mind these: Jason Bacon, Jens Schweikhardt, Ross Combs, Stephen P.
7408 Wall, David Wexelblat, and Thomas Dickey (invisible-island.net).
7409Patch #366 2021-02-10 XTERM(1)