1XTERM(1) General Commands Manual 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 (VTxxx) and Tektronix 4014 compatible termi‐
14 nals for programs that cannot use the window system directly. If the
15 underlying operating system supports terminal resizing capabilities
16 (for example, the SIGWINCH signal in systems derived from 4.3bsd),
17 xterm will use the facilities to notify programs running in the window
18 whenever it is resized.
19 The VTxxx and Tektronix 4014 terminals each have their own window so
21 that you can edit text in one and look at graphics in the other at the
22 same time. To maintain the correct aspect ratio (height/width), Tek‐
23 tronix graphics will be restricted to the largest box with a 4014's
24 aspect ratio that will fit in the window. This box is located in the
25 upper left area of the window.
26 Although both windows may be displayed at the same time, one of them is
28 considered the ``active'' window for receiving keyboard input and ter‐
29 minal output. This is the window that contains the text cursor. The
30 active window can be chosen through escape sequences, the ``VT
31 Options'' menu in the VTxxx window, and the ``Tek Options'' menu in the
32 4014 window.
33
35 The VT102 emulation is fairly complete, but does not support autore‐
36 peat. Double-size characters are displayed properly if your font
37 server supports scalable fonts. The VT220 emulation does not support
38 soft fonts, it is otherwise complete. Termcap(5) entries that work
39 with xterm include an optional platform-specific entry, ``xterm,''
40 ``vt102,'' ``vt100'' and ``ansi,'' and ``dumb.'' xterm automatically
41 searches the termcap file in this order for these entries and then sets
42 the ``TERM'' and the ``TERMCAP'' environment variables. You may also
43 use ``vt220,'' but must set the terminal emulation level with the
44 decTerminalID resource. (The ``TERMCAP'' environment variable is not
45 set if xterm is linked against a terminfo library, since the requisite
46 information is not provided by the termcap emulation of terminfo
47 libraries).
48 Many of the special xterm features may be modified under program con‐
50 trol through a set of escape sequences different from the standard
51 VT102 escape sequences. (See the Xterm Control Sequences document.)
52 The Tektronix 4014 emulation is also fairly good. It supports 12-bit
54 graphics addressing, scaled to the window size. Four different font
55 sizes and five different lines types are supported. There is no write-
56 through or defocused mode support. The Tektronix text and graphics
57 commands are recorded internally by xterm and may be written to a file
58 by sending the COPY escape sequence (or through the Tektronix menu; see
59 below). The name of the file will be ``COPYyyyy-MM-dd.hh:mm:ss'',
60 where yyyy, MM, dd, hh, mm and ss are the year, month, day, hour,
61 minute and second when the COPY was performed (the file is created in
62 the directory xterm is started in, or the home directory for a login
63 xterm).
64 Not all of the features described in this manual are necessarily avail‐
66 able in this version of xterm. Some (e.g., the non-VT220 extensions)
67 are available only if they were compiled in, though the most commonly-
68 used are in the default configuration.
69
71 Xterm automatically highlights the text cursor when the pointer enters
72 the window (selected) and unhighlights it when the pointer leaves the
73 window (unselected). If the window is the focus window, then the text
74 cursor is highlighted no matter where the pointer is.
75 In VT102 mode, there are escape sequences to activate and deactivate an
77 alternate screen buffer, which is the same size as the display area of
78 the window. When activated, the current screen is saved and replaced
79 with the alternate screen. Saving of lines scrolled off the top of the
80 window is disabled until the normal screen is restored. The termcap(5)
81 entry for xterm allows the visual editor vi(1) to switch to the alter‐
82 nate screen for editing and to restore the screen on exit. A popup
83 menu entry makes it simple to switch between the normal and alternate
84 screens for cut and paste.
85 In either VT102 or Tektronix mode, there are escape sequences to change
87 the name of the windows. Additionally, in VT102 mode, xterm implements
88 the window-manipulation control sequences from dtterm, such as resizing
89 the window, setting its location on the screen.
90 Xterm allows character-based applications to receive mouse events (cur‐
92 rently button-press and release events, and button-motion events) as
93 keyboard control sequences. See Xterm Control Sequences for details.
94
96 The xterm terminal emulator accepts the standard X Toolkit command line
97 options as well as many application-specific options. If the option
98 begins with a `+' instead of a `-', the option is restored to its
99 default value. The -version and -help options are interpreted even if
100 xterm cannot open the display, and are useful for testing and configu‐
101 ration scripts:
102 -version
104 This causes xterm to print a version number to the standard
105 output.
106 -help This causes xterm to print out a verbose message describing its
108 options, one per line. The message is written to the standard
109 output. Xterm generates this message, sorting it and noting
110 whether a "-option" or a "+option" turns the feature on or off,
111 since some features historically have been one or the other.
112 Xterm generates a concise help message (multiple options per
113 line) when an unknown option is used, e.g.,
114 xterm -z
115 If the logic for a particular option such as logging is not
117 compiled into xterm, the help text for that option also is not
118 displayed by the -help option.
119 One parameter (after all options) may be given. That overrides xterm's
121 built-in choice of shell program. Normally xterm checks the SHELL
122 variable. If that is not set, xterm tries to use the shell program
123 specified in the password file. If that is not set, xterm uses
124 /bin/sh. If the parameter names an executable file, xterm uses that
125 instead. The parameter must be an absolute path, or name a file found
126 on the user's PATH (and thereby construct an absolute path). The -e
127 option cannot be used with this parameter since it uses all parameters
128 following the option.
129 The other options are used to control the appearance and behavior. Not
131 all options are necessarily configured into your copy of xterm:
132 -132 Normally, the VT102 DECCOLM escape sequence that switches
134 between 80 and 132 column mode is ignored. This option causes
135 the DECCOLM escape sequence to be recognized, and the xterm
136 window will resize appropriately.
137 -ah This option indicates that xterm should always highlight the
139 text cursor. By default, xterm will display a hollow text cur‐
140 sor whenever the focus is lost or the pointer leaves the win‐
141 dow.
142 +ah This option indicates that xterm should do text cursor high‐
144 lighting based on focus.
145 -ai This option disables active icon support if that feature was
147 compiled into xterm. This is equivalent to setting the vt100
148 resource activeIcon to ``false''.
149 +ai This option enables active icon support if that feature was
151 compiled into xterm. This is equivalent to setting the vt100
152 resource activeIcon to ``true''.
153 -aw This option indicates that auto-wraparound should be allowed.
155 This allows the cursor to automatically wrap to the beginning
156 of the next line when it is at the rightmost position of a line
157 and text is output.
158 +aw This option indicates that auto-wraparound should not be
160 allowed.
161 -b number
163 This option specifies the size of the inner border (the dis‐
164 tance between the outer edge of the characters and the window
165 border) in pixels. That is the vt100 internalBorder resource.
166 The default is 2.
167 +bc turn off text cursor blinking. This overrides the cursorBlink
169 resource.
170 -bc turn on text cursor blinking. This overrides the cursorBlink
172 resource.
173 -bcf milliseconds
175 set the amount of time text cursor is off when blinking via the
176 cursorOffTime resource.
177 -bcn milliseconds
179 set the amount of time text cursor is on when blinking via the
180 cursorOffTime resource.
181 -bdc Set the vt100 resource colorBDMode to ``false'', disabling the
183 display of characters with bold attribute as color
184 +bdc Set the vt100 resource colorBDMode to ``true'', enabling the
186 display of characters with bold attribute as color rather than
187 bold
188 -cb Set the vt100 resource cutToBeginningOfLine to ``false''.
190 +cb Set the vt100 resource cutToBeginningOfLine to ``true''.
192 -cc characterclassrange:value[,...]
194 This sets classes indicated by the given ranges for using in
195 selecting by words. See the section specifying character
196 classes. and discussion of the charClass resource.
197 -cjk_width
199 Set the cjkWidth resource to ``true''. When turned on, charac‐
200 ters with East Asian Ambiguous (A) category in UTR 11 have a
201 column width of 2. Otherwise, they have a column width of 1.
202 This may be useful for some legacy CJK text terminal-based pro‐
203 grams assuming box drawings and others to have a column width
204 of 2. It also should be turned on when you specify a TrueType
205 CJK double-width (bi-width/monospace) font either with -fa at
206 the command line or faceName resource. The default is
207 ``false''
208 +cjk_width
210 Reset the cjkWidth resource.
211 -class string
213 This option allows you to override xterm's resource class.
214 Normally it is ``XTerm'', but can be set to another class such
215 as ``UXTerm'' to override selected resources.
216 -cm This option disables recognition of ANSI color-change escape
218 sequences. It sets the colorMode resource to ``false''.
219 +cm This option enables recognition of ANSI color-change escape
221 sequences. This is the same as the vt100 resource colorMode.
222 -cn This option indicates that newlines should not be cut in line-
224 mode selections. It sets the cutNewline resource to ``false''.
225 +cn This option indicates that newlines should be cut in line-mode
227 selections. It sets the cutNewline resource to ``true''.
228 -cr color
230 This option specifies the color to use for text cursor. The
231 default is to use the same foreground color that is used for
232 text. It sets the cursorColor resource according to the param‐
233 eter.
234 -cu This option indicates that xterm should work around a bug in
236 the more(1) program that causes it to incorrectly display lines
237 that are exactly the width of the window and are followed by a
238 line beginning with a tab (the leading tabs are not displayed).
239 This option is so named because it was originally thought to be
240 a bug in the curses(3x) cursor motion package.
241 +cu This option indicates that xterm should not work around the
243 more(1) bug mentioned above.
244 -dc This option disables the escape sequence to change dynamic col‐
246 ors: the vt100 foreground and background colors, its text cur‐
247 sor color, the pointer cursor foreground and background colors,
248 the Tektronix emulator foreground and background colors, its
249 text cursor color and highlight color. The option sets the
250 dynamicColors option to ``false''.
251 +dc This option enables the escape sequence to change dynamic col‐
253 ors. The option sets the dynamicColors option to ``true''.
254 -e program [ arguments ... ]
256 This option specifies the program (and its command line argu‐
257 ments) to be run in the xterm window. It also sets the window
258 title and icon name to be the basename of the program being
259 executed if neither -T nor -n are given on the command line.
260 This must be the last option on the command line.
261 -en encoding
263 This option determines the encoding on which xterm runs. It
264 sets the locale resource. Encodings other than UTF-8 are sup‐
265 ported by using luit. The -lc option should be used instead of
266 -en for systems with locale support.
267 -fb font
269 This option specifies a font to be used when displaying bold
270 text. This font must be the same height and width as the nor‐
271 mal font. If only one of the normal or bold fonts is speci‐
272 fied, it will be used as the normal font and the bold font will
273 be produced by overstriking this font. The default is to do
274 overstriking of the normal font. See also the discussion of
275 boldFont, boldMode and alwaysBoldMode resources.
276 -fa pattern
278 This option sets the pattern for fonts selected from the
279 FreeType library if support for that library was compiled into
280 xterm. This corresponds to the faceName resource. When a CJK
281 double-width font is specified, you also need to turn on the
282 cjkWidth resource. See also the renderFont resource, which
283 combines with this to determine whether FreeType fonts are ini‐
284 tially active.
285 -fbb This option indicates that xterm should compare normal and bold
287 fonts bounding boxes to ensure they are compatible. It sets
288 the freeBoldBox resource to ``false''.
289 +fbb This option indicates that xterm should not compare normal and
291 bold fonts bounding boxes to ensure they are compatible. It
292 sets the freeBoldBox resource to ``true''.
293 -fbx This option indicates that xterm should not assume that the
295 normal and bold fonts have VT100 line-drawing characters. If
296 any are missing, xterm will draw the characters directly. It
297 sets the forceBoxChars resource to ``false''.
298 +fbx This option indicates that xterm should assume that the normal
300 and bold fonts have VT100 line-drawing characters. It sets the
301 forceBoxChars resource to ``true''.
302 -fd pattern
304 This option sets the pattern for double-width fonts selected
305 from the FreeType library if support for that library was com‐
306 piled into xterm. This corresponds to the faceNameDoublesize
307 resource.
308 -fi font
310 This option sets the font for active icons if that feature was
311 compiled into xterm. See also the discussion of the iconFont
312 resource.
313 -fs size
315 This option sets the pointsize for fonts selected from the
316 FreeType library if support for that library was compiled into
317 xterm. This corresponds to the faceSize resource.
318 -fw font
320 This option specifies the font to be used for displaying wide
321 text. By default, it will attempt to use a font twice as wide
322 as the font that will be used to draw normal text. If no dou‐
323 blewidth font is found, it will improvise, by stretching the
324 normal font. This corresponds to the wideFont resource.
325 -fwb font
327 This option specifies the font to be used for displaying bold
328 wide text. By default, it will attempt to use a font twice as
329 wide as the font that will be used to draw bold text. If no
330 doublewidth font is found, it will improvise, by stretching the
331 bold font. This corresponds to the wideBoldFont resource.
332 -fx font
334 This option specifies the font to be used for displaying the
335 preedit string in the "OverTheSpot" input method. See also the
336 discussion of the ximFont resource.
337 -hc color
339 (see -selbg).
340 -hf This option indicates that HP Function Key escape codes should
342 be generated for function keys. It sets the hpFunctionKeys
343 resource to ``true''.
344 +hf This option indicates that HP Function Key escape codes should
346 not be generated for function keys. It sets the hpFunctionKeys
347 resource to ``false''.
348 -hm Tells xterm to use highlightTextColor and highlightColor to
350 override the reversed foreground/background colors in a selec‐
351 tion. It sets the highlightColorMode resource to ``true''.
352 +hm Tells xterm not to use highlightTextColor and highlightColor to
354 override the reversed foreground/background colors in a selec‐
355 tion. It sets the highlightColorMode resource to ``false''.
356 -hold Turn on the hold resource, i.e., xterm will not immediately
358 destroy its window when the shell command completes. It will
359 wait until you use the window manager to destroy/kill the win‐
360 dow, or if you use the menu entries that send a signal, e.g.,
361 HUP or KILL.
362 +hold Turn off the hold resource, i.e., xterm will immediately
364 destroy its window when the shell command completes.
365 -ie Turn on the ptyInitialErase resource, i.e., use the pseudo-ter‐
367 minal's sense of the stty erase value.
368 +ie Turn off the ptyInitialErase resource, i.e., set the stty erase
370 value using the kb string from the termcap entry as a refer‐
371 ence, if available.
372 -im Turn on the useInsertMode resource, which forces use of insert
374 mode by adding appropriate entries to the TERMCAP environment
375 variable.
376 +im Turn off the useInsertMode resource.
378 -into windowId
380 Given an X window identifier (a decimal integer), xterm will
381 reparent its top-level shell widget to that window. This is
382 used to embed xterm within other applications.
383 -j This option indicates that xterm should do jump scrolling. It
385 corresponds to the jumpScroll resource. Normally, text is
386 scrolled one line at a time; this option allows xterm to move
387 multiple lines at a time so that it does not fall as far
388 behind. Its use is strongly recommended since it makes xterm
389 much faster when scanning through large amounts of text. The
390 VT100 escape sequences for enabling and disabling smooth scroll
391 as well as the ``VT Options'' menu can be used to turn this
392 feature on or off.
393 +j This option indicates that xterm should not do jump scrolling.
395 -k8 This option sets the allowC1Printable resource. When
397 allowC1Printable is set, xterm overrides the mapping of C1 con‐
398 trol characters (code 128-159) to treat them as printable.
399 +k8 This option resets the allowC1Printable resource.
401 -kt keyboardtype
403 This option sets the keyboardType resource. Possible values
404 include: ``unknown'', ``default'', ``hp'', ``sco'', ``sun'',
405 ``tcap'' and ``vt220''.
406 The value ``unknown'', causes the corresponding resource to be
408 ignored.
409 The value ``default'', suppresses the associated resources
411 hpFunctionKeys, scoFunctionKeys, sunFunctionKeys, tcapFunction‐
412 Keys and sunKeyboard, using the Sun/PC keyboard layout.
413 -l Turn logging on. Normally logging is not supported, due to
415 security concerns. Some versions of xterm may have logging
416 enabled. The logfile is written to the directory from which
417 xterm is invoked. The filename is generated, of the form
418 XtermLog.XXXXXX
420 or
422 Xterm.log.hostname.yyyy.mm.dd.hh.mm.ss.XXXXXX
424 depending on how xterm was built.
426 +l Turn logging off.
428 -lc Turn on support of various encodings according to the users'
430 locale setting, i.e., LC_ALL, LC_CTYPE, or LANG environment
431 variables. This is achieved by turning on UTF-8 mode and by
432 invoking luit for conversion between locale encodings and
433 UTF-8. (luit is not invoked in UTF-8 locales.) This corre‐
434 sponds to the locale resource.
435 The actual list of encodings which are supported is determined
437 by luit. Consult the luit manual page for further details.
438 See also the discussion of the -u8 option which supports UTF-8
439 locales.
440 +lc Turn off support of automatic selection of locale encodings.
442 Conventional 8bit mode or, in UTF-8 locales or with -u8 option,
443 UTF-8 mode will be used.
444 -lcc path
446 File name for the encoding converter from/to locale encodings
447 and UTF-8 which is used with -lc option or locale resource.
448 This corresponds to the localeFilter resource.
449 -leftbar
451 Force scrollbar to the left side of VT100 screen. This is the
452 default, unless you have set the rightScrollBar resource.
453 -lf filename
455 Specify the log-filename. See the -l option.
456 -ls This option indicates that the shell that is started in the
458 xterm window will be a login shell (i.e., the first character
459 of argv[0] will be a dash, indicating to the shell that it
460 should read the user's .login or .profile).
461 The -ls flag and the loginShell resource are ignored if -e is
463 also given, because xterm does not know how to make the shell
464 start the given command after whatever it does when it is a
465 login shell - the user's shell of choice need not be a Bourne
466 shell after all. Also, xterm -e is supposed to provide a con‐
467 sistent functionality for other applications that need to start
468 text-mode programs in a window, and if loginShell were not
469 ignored, the result of ~/.profile might interfere with that.
470 If you do want the effect of -ls and -e simultaneously, you may
472 get away with something like
473 xterm -e /bin/bash -l -c "my command here"
474 Finally, -ls is not completely ignored, because xterm -ls -e
476 does write a /var/log/wtmp entry (if configured to do so),
477 whereas xterm -e does not.
478 +ls This option indicates that the shell that is started should not
480 be a login shell (i.e., it will be a normal ``subshell'').
481 -mb This option indicates that xterm should ring a margin bell when
483 the user types near the right end of a line. This option can
484 be turned on and off from the ``VT Options'' menu.
485 +mb This option indicates that margin bell should not be rung.
487 -mc milliseconds
489 This option specifies the maximum time between multi-click
490 selections.
491 -mesg Turn off the messages resource, i.e., disallow write access to
493 the terminal.
494 +mesg Turn on the messages resource, i.e., allow write access to the
496 terminal.
497 -mk_width
499 Set the mkWidth resource to ``true''. This makes xterm use a
500 built-in version of the wide-character width calculation. The
501 default is ``false''
502 +mk_width
504 Reset the mkWidth resource.
505 -ms color
507 This option specifies the color to be used for the pointer cur‐
508 sor. The default is to use the foreground color. This sets
509 the pointerColor resource.
510 -nb number
512 This option specifies the number of characters from the right
513 end of a line at which the margin bell, if enabled, will ring.
514 The default is 10.
515 -nul This option disables the display of underlining.
517 +nul This option enables the display of underlining.
519 -pc This option enables the PC-style use of bold colors (see bold‐
521 Colors resource).
522 +pc This option disables the PC-style use of bold colors.
524 -pob This option indicates that the window should be raised whenever
526 a Control-G is received.
527 +pob This option indicates that the window should not be raised
529 whenever a Control-G is received.
530 -rightbar
532 Force scrollbar to the right side of VT100 screen.
533 -rvc This option disables the display of characters with reverse
535 attribute as color.
536 +rvc This option enables the display of characters with reverse
538 attribute as color.
539 -rw This option indicates that reverse-wraparound should be
541 allowed. This allows the cursor to back up from the leftmost
542 column of one line to the rightmost column of the previous
543 line. This is very useful for editing long shell command lines
544 and is encouraged. This option can be turned on and off from
545 the ``VT Options'' menu.
546 +rw This option indicates that reverse-wraparound should not be
548 allowed.
549 -s This option indicates that xterm may scroll asynchronously,
551 meaning that the screen does not have to be kept completely up
552 to date while scrolling. This allows xterm to run faster when
553 network latencies are very high and is typically useful when
554 running across a very large internet or many gateways.
555 +s This option indicates that xterm should scroll synchronously.
557 -samename
559 Does not send title and icon name change requests when the
560 request would have no effect: the name is not changed. This
561 has the advantage of preventing flicker and the disadvantage of
562 requiring an extra round trip to the server to find out the
563 previous value. In practice this should never be a problem.
564 +samename
566 Always send title and icon name change requests.
567 -sb This option indicates that some number of lines that are
569 scrolled off the top of the window should be saved and that a
570 scrollbar should be displayed so that those lines can be
571 viewed. This option may be turned on and off from the ``VT
572 Options'' menu.
573 +sb This option indicates that a scrollbar should not be displayed.
575 -selbg color
577 This option specifies the color to use for the background of
578 selected text. If not specified, reverse video is used. See
579 the discussion of the highlightColor resource.
580 -selfg color
582 This option specifies the color to use for selected text. If
583 not specified, reverse video is used. See the discussion of
584 the highlightTextColor resource.
585 -sf This option indicates that Sun Function Key escape codes should
587 be generated for function keys.
588 +sf This option indicates that the standard escape codes should be
590 generated for function keys.
591 -si This option indicates that output to a window should not auto‐
593 matically reposition the screen to the bottom of the scrolling
594 region. This option can be turned on and off from the ``VT
595 Options'' menu.
596 +si This option indicates that output to a window should cause it
598 to scroll to the bottom.
599 -sk This option indicates that pressing a key while using the
601 scrollbar to review previous lines of text should cause the
602 window to be repositioned automatically in the normal position
603 at the bottom of the scroll region.
604 +sk This option indicates that pressing a key while using the
606 scrollbar should not cause the window to be repositioned.
607 -sl number
609 This option specifies the number of lines to save that have
610 been scrolled off the top of the screen. This corresponds to
611 the saveLines resource. The default is 64.
612 -sm This option, corresponding to the sessionMgt resource, indi‐
614 cates that xterm should set up session manager callbacks.
615 +sm This option indicates that xterm should not set up session man‐
617 ager callbacks.
618 -sp This option indicates that Sun/PC keyboard should be assumed,
620 providing mapping for keypad `+' to `,', and CTRL-F1 to F13,
621 CTRL-F2 to F14, etc.
622 +sp This option indicates that the standard escape codes should be
624 generated for keypad and function keys.
625 -t This option indicates that xterm should start in Tektronix
627 mode, rather than in VT102 mode. Switching between the two
628 windows is done using the ``Options'' menus. Termcap(5)
629 entries that work with xterm ``tek4014,'' ``tek4015,''
630 ``tek4012'', ``tek4013'' and ``tek4010,'' and ``dumb.'' xterm
631 automatically searches the termcap file in this order for these
632 entries and then sets the ``TERM'' and the ``TERMCAP'' environ‐
633 ment variables.
634 +t This option indicates that xterm should start in VT102 mode.
636 -tb This option, corresponding to the toolBar resource, indicates
638 that xterm should display a toolbar (or menubar) at the top of
639 its window. The buttons in the toolbar correspond to the popup
640 menus, e.g., control/left/mouse for "Main Options".
641 +tb This option indicates that xterm should not set up a toolbar.
643 -ti term_id
645 Specify the name used by xterm to select the correct response
646 to terminal ID queries. It also specifies the emulation level,
647 used to determine the type of response to a DA control
648 sequence. Valid values include vt52, vt100, vt101, vt102, and
649 vt220 (the "vt" is optional). The default is vt100. The
650 term_id argument specifies the terminal ID to use. (This is
651 the same as the decTerminalID resource).
652 -tm string
654 This option specifies a series of terminal setting keywords
655 followed by the characters that should be bound to those func‐
656 tions, similar to the stty program. The keywords and their
657 values are described in detail in the ttyModes resource.
658 -tn name
660 This option specifies the name of the terminal type to be set
661 in the TERM environment variable. It corresponds to the
662 termName resource. This terminal type must exist in the termi‐
663 nal database (termcap or terminfo, depending on how xterm is
664 built) and should have li# and co# entries. If the terminal
665 type is not found, xterm uses the built-in list ``xterm'',
666 ``vt102'', etc.
667 -u8 This option sets the utf8 resource. When utf8 is set, xterm
669 interprets incoming data as UTF-8. This sets the wideChars
670 resource as a side-effect, but the UTF-8 mode set by this
671 option prevents it from being turned off. If you must turn it
672 on and off, use the wideChars resource.
673 This option and the utf8 resource are overridden by the -lc and
675 -en options and locale resource. That is, if xterm has been
676 compiled to support luit, and the locale resource is not
677 ``false'' this option is ignored. We recommend using the -lc
678 option or the ``locale: true'' resource in UTF-8 locales when
679 your operating system supports locale, or -en UTF-8 option or
680 the ``locale: UTF-8'' resource when your operating system does
681 not support locale.
682 +u8 This option resets the utf8 resource.
684 -ulc This option disables the display of characters with underline
686 attribute as color rather than with underlining.
687 +ulc This option enables the display of characters with underline
689 attribute as color rather than with underlining.
690 -ulit This option, corresponding to the italicULMode resource, dis‐
692 ables the display of characters with underline attribute as
693 italics rather than with underlining.
694 +ulit This option, corresponding to the italicULMode resource,
696 enables the display of characters with underline attribute as
697 italics rather than with underlining.
698 -ut This option indicates that xterm should not write a record into
700 the the system utmp log file.
701 +ut This option indicates that xterm should write a record into the
703 system utmp log file.
704 -vb This option indicates that a visual bell is preferred over an
706 audible one. Instead of ringing the terminal bell whenever a
707 Control-G is received, the window will be flashed.
708 +vb This option indicates that a visual bell should not be used.
710 -wc This option sets the wideChars resource. When wideChars is
712 set, xterm maintains internal structures for 16-bit characters.
713 If you do not set this resource to ``true'', xterm will ignore
714 the escape sequence which turns UTF-8 mode on and off. The
715 default is ``false''.
716 +wc This option resets the wideChars resource.
718 -wf This option indicates that xterm should wait for the window to
720 be mapped the first time before starting the subprocess so that
721 the initial terminal size settings and environment variables
722 are correct. It is the application's responsibility to catch
723 subsequent terminal size changes.
724 +wf This option indicates that xterm should not wait before start‐
726 ing the subprocess.
727 -ziconbeep percent
729 Same as zIconBeep resource. If percent is non-zero, xterms
730 that produce output while iconified will cause an XBell sound
731 at the given volume and have "***" prepended to their icon
732 titles. Most window managers will detect this change immedi‐
733 ately, showing you which window has the output. (A similar
734 feature was in x10 xterm.)
735 -C This option indicates that this window should receive console
737 output. This is not supported on all systems. To obtain con‐
738 sole output, you must be the owner of the console device, and
739 you must have read and write permission for it. If you are
740 running X under xdm on the console screen you may need to have
741 the session startup and reset programs explicitly change the
742 ownership of the console device in order to get this option to
743 work.
744 -Sccn This option allows xterm to be used as an input and output
746 channel for an existing program and is sometimes used in spe‐
747 cialized applications. The option value specifies the last few
748 letters of the name of a pseudo-terminal to use in slave mode,
749 plus the number of the inherited file descriptor. If the
750 option contains a ``/'' character, that delimits the characters
751 used for the pseudo-terminal name from the file descriptor.
752 Otherwise, exactly two characters are used from the option for
753 the pseudo-terminal name, the remainder is the file descriptor.
754 Examples:
755 -S123/45
756 -Sab34
757 Note that xterm does not close any file descriptor which it did
759 not open for its own use. It is possible (though probably not
760 portable) to have an application which passes an open file
761 descriptor down to xterm past the initialization or the -S
762 option to a process running in the xterm.
763 The following command line arguments are provided for compatibility
765 with older versions. They may not be supported in the next release as
766 the X Toolkit provides standard options that accomplish the same task.
767 %geom This option specifies the preferred size and position of the
769 Tektronix window. It is shorthand for specifying the ``*tekGe‐
770 ometry'' resource.
771 #geom This option specifies the preferred position of the icon win‐
773 dow. It is shorthand for specifying the ``*iconGeometry''
774 resource.
775 -T string
777 This option specifies the title for xterm's windows. It is
778 equivalent to -title.
779 -n string
781 This option specifies the icon name for xterm's windows. It is
782 shorthand for specifying the ``*iconName'' resource. Note that
783 this is not the same as the toolkit option -name (see below).
784 The default icon name is the application name.
785 -r This option indicates that reverse video should be simulated by
787 swapping the foreground and background colors. It is equiva‐
788 lent to -rv.
789 -w number
791 This option specifies the width in pixels of the border sur‐
792 rounding the window. It is equivalent to -borderwidth or -bw.
793 The following standard X Toolkit command line arguments are commonly
795 used with xterm:
796 -bd color
798 This option specifies the color to use for the border of the
799 window. xterm uses the X Toolkit default, which is ``XtDe‐
800 faultForeground''.
801 -bg color
803 This option specifies the color to use for the background of
804 the window. The default is ``XtDefaultBackground.''
805 -bw number
807 This option specifies the width in pixels of the border sur‐
808 rounding the window.
809 This appears to be a legacy of older X releases. It sets the
811 borderWidth resource of the shell widget, and may provide
812 advice to your window manager to set the thickness of the win‐
813 dow frame. Most window managers do not use this information.
814 See the -b option, which controls the inner border of the xterm
815 window.
816 -display display
818 This option specifies the X server to contact; see X(7).
819 -fg color
821 This option specifies the color to use for displaying text.
822 The default is ``XtDefaultForeground.''
823 -fn font
825 This option specifies the font to be used for displaying normal
826 text. The default is fixed.
827 -font font
829 This is the same as -fn.
830 -geometry geometry
832 This option specifies the preferred size and position of the
833 VT102 window; see X(7).
834 -iconic This option indicates that xterm should ask the window manager
836 to start it as an icon rather than as the normal window.
837 -name name
839 This option specifies the application name under which
840 resources are to be obtained, rather than the default exe‐
841 cutable file name. Name should not contain ``.'' or ``*''
842 characters.
843 -rv This option indicates that reverse video should be simulated by
845 swapping the foreground and background colors.
846 +rv Disable the simulation of reverse video by swapping foreground
848 and background colors.
849 -title string
851 This option specifies the window title string, which may be
852 displayed by window managers if the user so chooses. The
853 default title is the command line specified after the -e
854 option, if any, otherwise the application name.
855 -xrm resourcestring
857 This option specifies a resource string to be used. This is
858 especially useful for setting resources that do not have sepa‐
859 rate command line options.
860
862 The program understands all of the core X Toolkit resource names and
863 classes. Application specific resources (e.g., "XTerm.NAME") follow:
864 backarrowKeyIsErase (class BackarrowKeyIsErase)
866 Tie the VTxxx backarrowKey and ptyInitialErase resources
867 together by setting the DECBKM state according to whether the
868 initial value of stty erase is a backspace (8) or delete (127)
869 character. The default is ``false'', which disables this fea‐
870 ture.
871 hold (class Hold)
873 If true, xterm will not immediately destroy its window when the
874 shell command completes. It will wait until you use the window
875 manager to destroy/kill the window, or if you use the menu
876 entries that send a signal, e.g., HUP or KILL. You may scroll
877 back, select text, etc., to perform most graphical operations.
878 Resizing the display will lose data, however, since this
879 involves interaction with the shell which is no longer running.
880 hpFunctionKeys (class HpFunctionKeys)
882 Specifies whether or not HP Function Key escape codes should be
883 generated for function keys instead of standard escape
884 sequences. See also the keyboardType resource.
885 iconGeometry (class IconGeometry)
887 Specifies the preferred size and position of the application
888 when iconified. It is not necessarily obeyed by all window
889 managers.
890 iconName (class IconName)
892 Specifies the icon name. The default is the application name.
893 keyboardType (class KeyboardType)
895 Enables one (or none) of the various keyboard-type resources:
896 hpFunctionKeys, scoFunctionKeys, sunFunctionKeys, tcapFunction‐
897 Keys and sunKeyboard. The resource's value should be one of
898 the corresponding strings ``hp'', ``sco'', ``sun'', ``tcap'' or
899 ``vt220''. The individual resources are provided for legacy
900 support; this resource is simpler to use.
901 maxBufSize (class MaxBufSize)
903 Specify the maximum size of the input buffer. The default is
904 32768. You cannot set this to a value less than the minBufSize
905 resource. It will be increased as needed to make that value
906 evenly divide this one.
907 On some systems you may want to increase one or both of the
909 maxBufSize and minBufSize resource values to achieve better
910 performance if the operating system prefers larger buffer
911 sizes.
912 messages (class Messages)
914 Specifies whether write access to the terminal is allowed ini‐
915 tially. See mesg(1). The default is ``true''.
916 menuLocale (class MenuLocale)
918 Specify the locale used for character-set computations when
919 loading the popup menus. Use this to improve initialization
920 performance of the Athena popup menus, which may load unneces‐
921 sary (and very large) fonts, e.g., in a locale having UTF-8
922 encoding. The default is an empty string, which uses the cur‐
923 rent locale setting.
924 Set it to ``C'' to achieve the best performance using the
926 default menu resource settings. If you happen to be using
927 localized menu resources, set the resource accordingly.
928 minBufSize (class MinBufSize)
930 Specify the minimum size of the input buffer, i.e., the amount
931 of data that xterm requests on each read. The default is 4096.
932 You cannot set this to a value less than 64.
933 ptyHandshake (class PtyHandshake)
935 If ``true'', xterm will perform handshaking during initializa‐
936 tion to ensure that the parent and child processes update the
937 utmp and stty state. See also waitForMap which waits for the
938 pseudo-terminal's notion of the screen size, and ptySttySize
939 which resets the screen size after other terminal initializa‐
940 tion is complete. The default is ``true''.
941 ptyInitialErase (class PtyInitialErase)
943 If ``true'', xterm will use the pseudo-terminal's sense of the
944 stty erase value. If ``false'', xterm will set the stty erase
945 value to match its own configuration, using the kb string from
946 the termcap entry as a reference, if available. In either
947 case, the result is applied to the TERMCAP variable which xterm
948 sets. See also the ttyModes resource, which may modify this.
949 The default is ``false''.
950 ptySttySize (class PtySttySize)
952 If ``true'', xterm will reset the screen size after terminal
953 initialization is complete. This is needed for some systems
954 whose pseudo-terminals cannot propagate terminal characteris‐
955 tics. Where it is not needed, it can interfere with other
956 methods for setting the intial screen size, e.g., via window
957 manager interaction. See also waitForMap which waits for a
958 handshake-message giving the pseudo-terminal's notion of the
959 screen size. The default is ``false'' on Linux and OS X sys‐
960 tems, ``true'' otherwise.
961 sameName (class SameName)
963 If the value of this resource is ``true'', xterm does not send
964 title and icon name change requests when the request would have
965 no effect: the name is not changed. This has the advantage of
966 preventing flicker and the disadvantage of requiring an extra
967 round trip to the server to find out the previous value. In
968 practice this should never be a problem. The default is
969 ``true''.
970 scoFunctionKeys (class ScoFunctionKeys)
972 Specifies whether or not SCP Function Key escape codes should
973 be generated for function keys instead of standard escape
974 sequences. See also the keyboardType resource.
975 sessionMgt (class SessionMgt)
977 If the value of this resource is ``true'', xterm sets up ses‐
978 sion manager callbacks for XtNdieCallback and XtNsaveCallback.
979 The default is ``true''.
980 sunFunctionKeys (class SunFunctionKeys)
982 Specifies whether or not Sun Function Key escape codes should
983 be generated for function keys instead of standard escape
984 sequences. See also the keyboardType resource.
985 sunKeyboard (class SunKeyboard)
987 Specifies whether or not Sun/PC keyboard layout should be
988 assumed rather than DEC VT220. This causes the keypad `+' to
989 be mapped to `,'. and CTRL F1-F12 to F11-F20, depending on the
990 setting of the ctrlFKeys resource. so xterm emulates a DEC
991 VT220 more accurately. Otherwise (the default, with sunKey‐
992 board set to ``false''), xterm uses PC-style bindings for the
993 function keys and keypad.
994 PC-style bindings use the Shift, Alt, Control and Meta keys as
996 modifiers for function-keys and keypad (see the document Xterm
997 Control Sequences for details). The PC-style bindings are
998 analogous to PCTerm, but not the same thing. Normally these
999 bindings do not conflict with the use of the Meta key as
1000 described for the eightBitInput resource. If they do, note
1001 that the PC-style bindings are evaluated first. See also the
1002 keyboardType resource.
1003 tcapFunctionKeys (class TcapFunctionKeys)
1005 Specifies whether or not function key escape codes read from
1006 the termcap/terminfo entry should be generated for function
1007 keys instead of standard escape sequences. See also the key‐
1008 boardType resource.
1009 termName (class TermName)
1011 Specifies the terminal type name to be set in the TERM environ‐
1012 ment variable.
1013 title (class Title)
1015 Specifies a string that may be used by the window manager when
1016 displaying this application.
1017 toolBar (class ToolBar)
1019 Specifies whether or not the toolbar should be displayed. The
1020 default is ``true.''
1021 ttyModes (class TtyModes)
1023 Specifies a string containing terminal setting keywords and the
1024 characters to which they may be bound. Allowable keywords
1025 include: brk, dsusp, eof, eol, eol2, erase, erase2, flush,
1026 intr, kill, lnext, quit, rprnt, start, status, stop, susp,
1027 swtch and weras. Control characters may be specified as ^char
1028 (e.g., ^c or ^u) and ^? may be used to indicate delete (127).
1029 Use ^- to denote undef. Use \034 to represent ^\, since a lit‐
1030 eral backslash in an X resource escapes the next character.
1031 This is very useful for overriding the default terminal set‐
1033 tings without having to do an stty every time an xterm is
1034 started. Note, however, that the stty program on a given host
1035 may use different keywords; xterm's table is built-in.
1036 If the ttyModes resource specifies a value for erase, that
1038 overrides the ptyInitialErase resource setting, i.e., xterm
1039 initializes the terminal to match that value.
1040 useInsertMode (class UseInsertMode)
1042 Force use of insert mode by adding appropriate entries to the
1043 TERMCAP environment variable. This is useful if the system
1044 termcap is broken. The default is ``false.''
1045 utmpDisplayId (class UtmpDisplayId)
1047 Specifies whether or not xterm should try to record the display
1048 identifier (display number and screen number) as well as the
1049 hostname in the system utmp log file. The default is ``true.''
1050 utmpInhibit (class UtmpInhibit)
1052 Specifies whether or not xterm should try to record the user's
1053 terminal in the system utmp log file. If true, xterm will not
1054 try. The default is ``false.''
1055 waitForMap (class WaitForMap)
1057 Specifies whether or not xterm should wait for the initial win‐
1058 dow map before starting the subprocess. This is part of the
1059 ptyHandshake logic. When xterm is directed to wait in this
1060 fashion, it passes the terminal size from the display end of
1061 the pseudo-terminal to the terminal I/O connection, e.g.,
1062 according to the window manager. Otherwise, it uses the size
1063 as given in resource values or command-line option -geom. The
1064 default is ``false.''
1065 zIconBeep (class ZIconBeep)
1067 Same as -ziconbeep command line argument. If the value of this
1068 resource is non-zero, xterms that produce output while iconi‐
1069 fied will cause an XBell sound at the given volume and have
1070 "***" prepended to their icon titles. Most window managers
1071 will detect this change immediately, showing you which window
1072 has the output. (A similar feature was in x10 xterm.) The
1073 default is ``false.''
1074 VT100 Widget Resources
1076 The following resources are specified as part of the vt100 widget
1077 (class VT100): These are specified by patterns such as
1078 "XTerm.vt100.NAME":
1079 activeIcon (class ActiveIcon)
1081 Specifies whether or not active icon windows are to be used
1082 when the xterm window is iconified, if this feature is compiled
1083 into xterm. The active icon is a miniature representation of
1084 the content of the window and will update as the content
1085 changes. Not all window managers necessarily support applica‐
1086 tion icon windows. Some window managers will allow you to
1087 enter keystrokes into the active icon window. The default is
1088 ``false.''
1089 allowC1Printable (class AllowC1Printable)
1091 If true, overrides the mapping of C1 controls (codes 128-159)
1092 to make them be treated as if they were printable characters.
1093 Although this corresponds to no particular standard, some users
1094 insist it is a VT100. The default is ``false.''
1095 allowSendEvents (class AllowSendEvents)
1097 Specifies whether or not synthetic key and button events (gen‐
1098 erated using the X protocol SendEvent request) should be inter‐
1099 preted or discarded. The default is ``false'' meaning they are
1100 discarded. Note that allowing such events creates a very large
1101 security hole. The default is ``false.''
1102 allowTitleOps (class AllowTitleOps)
1104 Specifies whether control sequences that modify the window
1105 title or icon name should be allowed. The default is ``true.''
1106 allowWindowOps (class AllowWindowOps)
1108 Specifies whether extended window control sequences (as used in
1109 dtterm) should be allowed. The default is ``true.''
1110 altIsNotMeta (class AltIsNotMeta)
1112 If ``true'', treat the Alt-key as if it were the Meta-key.
1113 Your keyboard may happen to be configured so they are the same.
1114 But if they are not, this allows you to use the same prefix-
1115 and shifting operations with the Alt-key as with the Meta-key.
1116 See altSendsEscape and metaSendsEscape. The default is
1117 ``false.''
1118 altSendsEscape (class AltSendsEscape)
1120 This is an additional keyboard operation that may be processed
1121 after the logic for metaSendsEscape. It is only available if
1122 the altIsNotMeta resource is set.
1123 If ``true'', Alt characters (a character combined with the mod‐
1125 ifier associated with left/right Alt-keys) are converted into a
1126 two-character sequence with the character itself preceded by
1127 ESC. This applies as well to function key control sequences,
1128 unless xterm sees that Alt is used in your key translations.
1129 If ``false'', Alt characters input from the keyboard cause a
1130 shift to 8-bit characters (just like metaSendsEscape). By com‐
1131 bining the Alt- and Meta-modifiers, you can create correspond‐
1132 ing combinations of ESC-prefix and 8-bit characters. The
1133 default is ``false.''
1134 alwaysBoldMode (class AlwaysBoldMode)
1136 Specifies whether xterm should check if the normal and bold
1137 fonts are distinct before deciding whether to use overstriking
1138 to simulate bold fonts. If this resource is true, xterm does
1139 not make the check for distinct fonts when deciding how to han‐
1140 dle the boldMode resource. The default is ``false.''
1141 boldMode alwaysBoldMode Comparison Action
1143 ────────────────────────────────────────────────────
1144 false false ignored use font
1145 false true ignored use font
1146 true false same overstrike
1147 true false different use font
1148 true true ignored overstrike
1149 alwaysHighlight (class AlwaysHighlight)
1151 Specifies whether or not xterm should always display a high‐
1152 lighted text cursor. By default (if this resource is false), a
1153 hollow text cursor is displayed whenever the pointer moves out
1154 of the window or the window loses the input focus. The default
1155 is ``false.''
1156 alwaysUseMods (class AlwaysUseMods)
1158 Override the numLock resource, telling xterm to use the Alt and
1159 Meta modifiers to construct parameters for function key
1160 sequences even if those modifiers appear in the translations
1161 resource. The default is ``false.''
1162 answerbackString (class AnswerbackString)
1164 Specifies the string that xterm sends in response to an ENQ
1165 (control/E) character from the host. The default is a blank
1166 string, i.e., ``''. A hardware VT100 implements this feature
1167 as a setup option.
1168 appcursorDefault (class AppcursorDefault)
1170 If ``true,'' the cursor keys are initially in application mode.
1171 This is the same as the VT102 private DECCKM mode, The default
1172 is ``false.''
1173 appkeypadDefault (class AppkeypadDefault)
1175 If ``true,'' the keypad keys are initially in application mode.
1176 The default is ``false.''
1177 autoWrap (class AutoWrap)
1179 Specifies whether or not auto-wraparound should be enabled.
1180 This is the same as the VT102 DECAWM. The default is ``true.''
1181 awaitInput (class AwaitInput)
1183 Specifies whether or not the xterm uses a 50 millisecond time‐
1184 out to await input (i.e., to support the Xaw3d arrow scroll‐
1185 bar). The default is ``false.''
1186 backarrowKey (class BackarrowKey)
1188 Specifies whether the backarrow key transmits a backspace (8)
1189 or delete (127) character. This corresponds to the DECBKM con‐
1190 trol sequence. The default (backspace) is ``true.'' Pressing
1191 the control key toggles this behavior.
1192 background (class Background)
1194 Specifies the color to use for the background of the window.
1195 The default is ``XtDefaultBackground.''
1196 bellIsUrgent (class BellIsUrgent)
1198 Specifies whether to set the Urgency hint for the window man‐
1199 ager when making a bell sound. The default is ``false.''
1200 bellOnReset (class BellOnReset)
1202 Specifies whether to sound a bell when doing a hard reset. The
1203 default is ``true.''
1204 bellSuppressTime (class BellSuppressTime)
1206 Number of milliseconds after a bell command is sent during
1207 which additional bells will be suppressed. Default is 200. If
1208 set non-zero, additional bells will also be suppressed until
1209 the server reports that processing of the first bell has been
1210 completed; this feature is most useful with the visible bell.
1211 boldColors (class ColorMode)
1213 Specifies whether to combine bold attribute with colors like
1214 the IBM PC, i.e., map colors 0 through 7 to colors 8 through
1215 15. These normally are the brighter versions of the first 8
1216 colors, hence bold. The default is ``true.''
1217 boldFont (class BoldFont)
1219 Specifies the name of the bold font to use instead of over‐
1220 striking. There is no default for this resource.
1221 boldMode (class BoldMode)
1223 This specifies whether or not text with the bold attribute
1224 should be overstruck to simulate bold fonts if the resolved
1225 bold font is the same as the normal font. It may be desirable
1226 to disable bold fonts when color is being used for the bold
1227 attribute.
1228 Note that xterm has one bold font which you may set explicitly.
1230 Xterm attempts to derive a bold font for the other font selec‐
1231 tions (font1 through font6). If it cannot find a bold font, it
1232 will use the normal font. In each case (whether the explicit
1233 resource or the derived font), if the normal and bold fonts are
1234 distinct, this resource has no effect. The default is
1235 ``true.''
1236 See the alwaysBoldMode resource which can modify the behavior
1238 of this resource.
1239 Although xterm attempts to derive a bold font for other font
1241 selections, the font server may not cooperate. Since X11R6,
1242 bitmap fonts have been scaled. The font server claims to pro‐
1243 vide the bold font that xterm requests, but the result is not
1244 always readable. XFree86 provides a feature which can be used
1245 to suppress the scaling. In the X server's configuration file
1246 (e.g., /etc/X11/xorg.conf), you can add ":unscaled" to the end
1247 of the directory specification for the "misc" fonts, which com‐
1248 prise the fixed-pitch fonts that are used by xterm. For exam‐
1249 ple
1250 FontPath "/usr/share/X11/fonts"
1251 would become
1253 FontPath "/usr/share/X11/fonts/misc/:unscaled"
1254 Depending on your configuration, the font server may have its
1256 own configuration file. The same ":unscaled" can be added to
1257 its configuration file at the end of the directory specifica‐
1258 tion for "misc".
1259 brokenLinuxOSC (class BrokenLinuxOSC)
1261 If true, xterm applies a workaround to ignore malformed control
1262 sequences that a Linux script might send. Compare the palette
1263 control sequences documented in console_codes with ECMA-48.
1264 The default is ``true.''
1265 brokenSelections (class BrokenSelections)
1267 If true, xterm in 8-bit mode will interpret STRING selections
1268 as carrying text in the current locale's encoding. Normally
1269 STRING selections carry ISO-8859-1 encoded text. Setting this
1270 resource to ``true'' violates the ICCCM; it may, however, be
1271 useful for interacting with some broken X clients. The default
1272 is ``false.''
1273 brokenStringTerm (class BrokenStringTerm)
1275 provides a work-around for some ISDN routers which start an
1276 application control string without completing it. Set this to
1277 ``true'' if xterm appears to freeze when connecting. The
1278 default is ``false.''
1279 c132 (class C132)
1281 Specifies whether or not the VT102 DECCOLM escape sequence,
1282 used to switch between 80 and 132 columns, should be honored.
1283 The default is ``false.''
1284 cacheDoublesize (class CacheDoublesize)
1286 Tells whether to cache double-sized fonts by xterm. Set this
1287 to zero to disable doublesize fonts altogether.
1288 charClass (class CharClass)
1290 Specifies comma-separated lists of character class bindings of
1291 the form [low-]high:value. These are used in determining which
1292 sets of characters should be treated the same when doing cut
1293 and paste. See the CHARACTER CLASSES section.
1294 cjkWidth (class CjkWidth)
1296 Specifies whether xterm should follow the traditional East
1297 Asian width convention. When turned on, characters with East
1298 Asian Ambiguous (A) category in UTR 11 have a column width of
1299 2. You may have to set this option to ``true'' if you have
1300 some old East Asian terminal based programs that assume that
1301 line-drawing characters have a column width of 2. If this
1302 resource is false, the mkWidth resource controls the choice
1303 between the system's wcwidth and xterm's built-in tables. The
1304 default is ``false.''
1305 color0 (class Color0)
1307 color1 (class Color1)
1309 color2 (class Color2)
1311 color3 (class Color3)
1313 color4 (class Color4)
1315 color5 (class Color5)
1317 color6 (class Color6)
1319 color7 (class Color7)
1321 These specify the colors for the ISO-6429 extension. The
1322 defaults are, respectively, black, red3, green3, yellow3, a
1323 customizable dark blue, magenta3, cyan3, and gray90. The
1324 default shades of color are chosen to allow the colors 8-15 to
1325 be used as brighter versions.
1326 color8 (class Color8)
1328 color9 (class Color9)
1330 color10 (class Color10)
1332 color11 (class Color11)
1334 color12 (class Color12)
1336 color13 (class Color13)
1338 color14 (class Color14)
1340 color15 (class Color15)
1342 These specify the colors for the ISO-6429 extension if the bold
1343 attribute is also enabled. The default resource values are
1344 respectively, gray30, red, green, yellow, a customizable light
1345 blue, magenta, cyan, and white.
1346 color16 (class Color16)
1348 through
1350 color255 (class Color255)
1352 These specify the colors for the 256-color extension. The
1353 default resource values are for colors 16 through 231 to make a
1354 6x6x6 color cube, and colors 232 through 255 to make a
1355 grayscale ramp.
1356 colorAttrMode (class ColorAttrMode)
1358 Specifies whether colorBD, colorBL, colorRV, and colorUL should
1359 override ANSI colors. If not, these are displayed only when no
1360 ANSI colors have been set for the corresponding position. The
1361 default is ``false.''
1362 colorBD (class ColorBD)
1364 This specifies the color to use to display bold characters if
1365 the ``colorBDMode'' resource is enabled. The default is
1366 ``XtDefaultForeground.''
1367 colorBDMode (class ColorAttrMode)
1369 Specifies whether characters with the bold attribute should be
1370 displayed in color or as bold characters. Note that setting
1371 colorMode off disables all colors, including bold. The default
1372 is ``false.''
1373 colorBL (class ColorBL)
1375 This specifies the color to use to display blink characters if
1376 the ``colorBLMode'' resource is enabled. The default is
1377 ``XtDefaultForeground.''
1378 colorBLMode (class ColorAttrMode)
1380 Specifies whether characters with the blink attribute should be
1381 displayed in color. Note that setting colorMode off disables
1382 all colors, including this. The default is ``false.''
1383 colorMode (class ColorMode)
1385 Specifies whether or not recognition of ANSI (ISO-6429) color
1386 change escape sequences should be enabled. The default is
1387 ``true.''
1388 colorRV (class ColorRV)
1390 This specifies the color to use to display reverse characters
1391 if the ``colorRVMode'' resource is enabled. The default is
1392 ``XtDefaultForeground.''
1393 colorRVMode (class ColorAttrMode)
1395 Specifies whether characters with the reverse attribute should
1396 be displayed in color. Note that setting colorMode off dis‐
1397 ables all colors, including this. The default is ``false.''
1398 colorUL (class ColorUL)
1400 This specifies the color to use to display underlined charac‐
1401 ters if the ``colorULMode'' resource is enabled. The default
1402 is ``XtDefaultForeground.''
1403 colorULMode (class ColorAttrMode)
1405 Specifies whether characters with the underline attribute
1406 should be displayed in color or as underlined characters. Note
1407 that setting colorMode off disables all colors, including
1408 underlining. The default is ``false.''
1409 combiningChars (class CombiningChars)
1411 Specifies the number of wide-characters which can be stored in
1412 a cell to overstrike (combine) with the base character of the
1413 cell. This can be set to values in the range 0 to 4. The
1414 default is ``2''.
1415 ctrlFKeys (class CtrlFKeys)
1417 In VT220 keyboard mode (see sunKeyboard resource), specifies
1418 the amount by which to shift F1-F12 given a control modifier
1419 (CTRL). This allows you to generate key symbols for F10-F20 on
1420 a Sun/PC keyboard. The default is ``10'', which means that
1421 CTRL F1 generates the key symbol for F11.
1422 curses (class Curses)
1424 Specifies whether or not the last column bug in more(1) should
1425 be worked around. See the -cu option for details. The default
1426 is ``false.''
1427 cursorBlink (class CursorBlink)
1429 Specifies whether to make the cursor blink. The default is
1430 ``false.''
1431 cursorColor (class CursorColor)
1433 Specifies the color to use for the text cursor. The default is
1434 ``XtDefaultForeground.'' Xterm attempts to keep this color
1435 from being the same as the background color, since it draws the
1436 cursor by filling the background of a text cell. The same
1437 restriction applies to control sequences which may change this
1438 color.
1439 cursorOffTime (class CursorOffTime)
1441 Specifies the duration of the "off" part of the cursor blink
1442 cycle-time in milliseconds. The same timer is used for text
1443 blinking. The default is 300.
1444 cursorOnTime (class CursorOnTime)
1446 Specifies the duration of the "on" part of the cursor blink
1447 cycle-time, in milliseconds. The same timer is used for text
1448 blinking. The default is 600.
1449 cutNewline (class CutNewline)
1451 If ``false'', triple clicking to select a line does not include
1452 the Newline at the end of the line. If ``true'', the Newline
1453 is selected. The default is ``true.''
1454 cutToBeginningOfLine (class CutToBeginningOfLine)
1456 If ``false'', triple clicking to select a line selects only
1457 from the current word forward. If ``true'', the entire line is
1458 selected. The default is ``true.''
1459 decTerminalID (class DecTerminalID)
1461 Specifies the emulation level (100=VT100, 220=VT220, etc.),
1462 used to determine the type of response to a DA control
1463 sequence. Leading non-digit characters are ignored, e.g.,
1464 "vt100" and "100" are the same. The default is 100.
1465 deleteIsDEL (class DeleteIsDEL)
1467 Specifies whether the Delete key on the editing keypad should
1468 send DEL (127) or the VT220-style Remove escape sequence. The
1469 default is ``false,'' for the latter.
1470 dynamicColors (class DynamicColors)
1472 Specifies whether or not escape sequences to change colors
1473 assigned to different attributes are recognized.
1474 eightBitControl (class EightBitControl)
1476 Specifies whether or not control sequences sent by the terminal
1477 should be eight-bit characters or escape sequences. The
1478 default is ``false.''
1479 eightBitInput (class EightBitInput)
1481 If ``true'', Meta characters (a single-byte character combined
1482 with the Meta modifier key) input from the keyboard are pre‐
1483 sented as a single character with the eighth bit turned on.
1484 The terminal is put into 8-bit mode. If ``false'', Meta char‐
1485 acters are converted into a two-character sequence with the
1486 character itself preceded by ESC. On startup, xterm tries to
1487 put the terminal into 7-bit mode. The metaSendsEscape and alt‐
1488 SendsEscape resources may override this. The default is
1489 ``true.''
1490 Generally keyboards do not have a key labeled "Meta", but "Alt"
1492 keys are common, and they are conventionally used for "Meta".
1493 If they were synonymous, it would have been reasonable to name
1494 this resource "altSendsEscape", reversing its sense. For more
1495 background on this, see the meta function in curses.
1496 Note that the Alt key is not necessarily the same as the Meta
1498 modifier. xmodmap lists your key modifiers. X defines modi‐
1499 fiers for shift, (caps) lock and control, as well as 5 addi‐
1500 tional modifiers which are generally used to configure key mod‐
1501 ifiers. xterm inspects the same information to find the modi‐
1502 fier associated with either Meta key (left or right), and uses
1503 that key as the Meta modifier. It also looks for the NumLock
1504 key, to recognize the modifier which is associated with that.
1505 If your xmodmap configuration uses the same keycodes for Alt-
1507 and Meta-keys, xterm will only see the Alt-key definitions,
1508 since those are tested before Meta-keys. NumLock is tested
1509 first. It is important to keep these keys distinct; otherwise
1510 some of xterm's functionality is not available.
1511 eightBitOutput (class EightBitOutput)
1513 Specifies whether or not eight-bit characters sent from the
1514 host should be accepted as is or stripped when printed. The
1515 default is ``true,'' which means that they are accepted as is.
1516 faceName (class FaceName)
1518 Specify the pattern for fonts selected from the FreeType
1519 library if support for that library was compiled into xterm.
1520 There is no default. If not specified, or if there is no match
1521 for both normal and bold fonts, xterm uses the font and related
1522 resources.
1523 faceNameDoublesize (class FaceNameDoublesize)
1525 Specify an double-width font for cases where an application
1526 requires this, e.g., in CJK applications. There is no default.
1527 If the application uses double-wide characters and this
1528 resource is not given, xterm will use a scaled version of the
1529 font given by faceName.
1530 faceSize (class FaceSize)
1532 Specify the pointsize for fonts selected from the FreeType
1533 library if support for that library was compiled into xterm.
1534 The default is ``14.'' On the VT Fonts menu, this corresponds
1535 to the Default entry. You can specify the pointsize for True‐
1536 Type fonts selected with the other size-related menu entries
1537 such as Medium, Huge, etc., by using one of the following
1538 resource values. If you do not specify a value, they default
1539 to ``0.0'', which causes xterm to use the ratio of font sizes
1540 from the bitmap font resources to obtain a TrueType pointsize.
1541 faceSize1 (class FaceSize1)
1543 Specifies the pointsize of the first alternative font.
1544 faceSize2 (class FaceSize2)
1546 Specifies the pointsize of the second alternative font.
1547 faceSize3 (class FaceSize3)
1549 Specifies the pointsize of the third alternative font.
1550 faceSize4 (class FaceSize4)
1552 Specifies the pointsize of the fourth alternative font.
1553 faceSize5 (class FaceSize5)
1555 Specifies the pointsize of the fifth alternative font.
1556 faceSize6 (class FaceSize6)
1558 Specifies the pointsize of the sixth alternative font.
1559 font (class Font)
1561 Specifies the name of the normal font. The default is
1562 ``fixed.''
1563 See the discussion of the locale resource, which describes how
1565 this font may be overridden.
1566 NOTE: some resource files use patterns such as
1568 *font: fixed
1569 which are overly broad, affecting both
1571 xterm.vt100.font
1572 and
1574 xterm.vt100.utf8fonts.font
1575 which is probably not what you intended.
1577 font1 (class Font1)
1579 Specifies the name of the first alternative font.
1580 font2 (class Font2)
1582 Specifies the name of the second alternative font.
1583 font3 (class Font3)
1585 Specifies the name of the third alternative font.
1586 font4 (class Font4)
1588 Specifies the name of the fourth alternative font.
1589 font5 (class Font5)
1591 Specifies the name of the fifth alternative font.
1592 font6 (class Font6)
1594 Specifies the name of the sixth alternative font.
1595 fontDoublesize (class FontDoublesize)
1597 Specifies whether xterm should attempt to use font scaling to
1598 draw doublesize characters. Some older font servers cannot do
1599 this properly, will return misleading font metrics. The
1600 default is ``true''. If disabled, xterm will simulate double‐
1601 size characters by drawing normal characters with spaces
1602 between them.
1603 forceBoxChars (class ForceBoxChars)
1605 Specifies whether xterm should assume the normal and bold fonts
1606 have VT100 line-drawing characters:
1607 - The fixed-pitch ISO-8859-*-encoded fonts used by xterm
1609 normally have the VT100 line-drawing glyphs in cells 1-31.
1610 Other fixed-pitch fonts may be more attractive, but lack
1611 these glyphs.
1612 - When using an ISO-10646-1 font and the wideChars resource
1614 is true, xterm uses the Unicode glyphs which match the
1615 VT100 line-drawing glyphs.
1616 If ``false'', xterm checks for missing glyphs in the font and
1618 makes line-drawing characters directly as needed. If ``true'',
1619 xterm assumes the font does not contain the line-drawing char‐
1620 acters, and draws them directly. The default is ``false.''
1621 foreground (class Foreground)
1623 Specifies the color to use for displaying text in the window.
1624 Setting the class name instead of the instance name is an easy
1625 way to have everything that would normally appear in the text
1626 color change color. The default is ``XtDefaultForeground.''
1627 freeBoldBox (class freeBoldBox)
1629 Specifies whether xterm should assume the bounding boxes for
1630 normal and bold fonts are compatible. If ``false'', xterm com‐
1631 pares them and will reject choices of bold fonts that do not
1632 match the size of the normal font. The default is ``false'',
1633 which means that the comparison is performed.
1634 geometry (class Geometry)
1636 Specifies the preferred size and position of the VT102 window.
1637 There is no default for this resource.
1638 highlightColor (class HighlightColor)
1640 Specifies the color to use for the background of selected
1641 (highlighted) text. If not specified (i.e., matching the
1642 default foreground), reverse video is used. The default is
1643 ``XtDefaultForeground.''
1644 highlightColorMode (class HighlightColorMode)
1646 Specifies whether xterm should use highlightTextColor and high‐
1647 lightColor to override the reversed foreground/background col‐
1648 ors in a selection. The default is unspecified: at startup,
1649 xterm checks if those resources are set to something other than
1650 the default foreground and background colors. Setting this
1651 resource disables the check.
1652 The following table shows the interaction of the highlighting
1654 resources, abbreviated as shown to fit in this page:
1655 HCM
1657 highlightColorMode
1658 HR highlightReverse
1660 HBG
1662 highlightColor
1663 HFG
1665 highlightTextColor
1666 HCM HR HBG HFG Highlight
1668 ──────────────────────────────────────────────────────
1669 false false default default bg/fg
1670 false false default set bg/fg
1671 false false set default fg/HBG
1672 false false set set fg/HBG
1673 ──────────────────────────────────────────────────────
1674 false true default default bg/fg
1675 false true default set bg/fg
1676 false true set default fg/HBG
1677 false true set set fg/HBG
1678 ──────────────────────────────────────────────────────
1679 true false default default bg/fg
1680 true false default set HFG/fg
1681 true false set default bg/HBG
1682 true false set set HFG/HBG
1683 ──────────────────────────────────────────────────────
1684 true true default default fg/fg (useless)
1685 true true default set HFG/fg
1686 true true set default fg/HBG
1687 true true set set HFG/HBG
1688 ──────────────────────────────────────────────────────
1689 default false default default bg/fg
1690 default false default set bg/fg
1691 default false set default fg/HBG
1692 default false set set HFG/HBG
1693 ──────────────────────────────────────────────────────
1694 default true default default bg/fg
1695 default true default set bg/fg
1696 default true set default fg/HBG
1697 default true set set HFG/HBG
1698 ──────────────────────────────────────────────────────
1699 highlightReverse (class HighlightReverse)
1701 Specifies whether xterm should reverse the selection foreground
1702 and background colors when selecting text with reverse-video
1703 attribute. This applies only to the highlightColor and high‐
1704 lightTextColor resources, e.g., to match the color scheme of
1705 xwsh. If ``true'', xterm reverses the colors, If ``false'',
1706 xterm does not reverse colors, The default is ``true.''
1707 highlightSelection (class HighlightSelection)
1709 If ``false'', selecting with the mouse highlights all positions
1710 on the screen between the beginning of the selection and the
1711 current position. If ``true'', xterm highlights only the posi‐
1712 tions that contain text that can be selected. The default is
1713 ``false.''
1714 Depending on the way your applications write to the screen,
1716 there may be trailing blanks on a line. Xterm stores data as
1717 it is shown on the screen. Erasing the display changes the
1718 internal state of each cell so it is not considered a blank for
1719 the purpose of selection. Blanks written since the last erase
1720 are selectable. If you do not wish to have trailing blanks in
1721 a selection, use the trimSelection resource.
1722 highlightTextColor (class HighlightTextColor)
1724 Specifies the color to use for the foreground of selected
1725 (highlighted) text. If not specified (i.e., matching the
1726 default background), reverse video is used. The default is
1727 ``XtDefaultBackground.''
1728 hpLowerleftBugCompat (class HpLowerleftBugCompat)
1730 Specifies whether to work around a bug in HP's xdb, which
1731 ignores termcap and always sends ESC F to move to the lower
1732 left corner. ``true'' causes xterm to interpret ESC F as a
1733 request to move to the lower left corner of the screen. The
1734 default is ``false.''
1735 i18nSelections (class I18nSelections)
1737 If false, xterm will never request the targets COMPOUND_TEXT or
1738 TEXT. The default is ``true.'' It may be set to false in order
1739 to work around ICCCM violations by other X clients.
1740 iconBorderColor (class BorderColor)
1742 Specifies the border color for the active icon window if this
1743 feature is compiled into xterm. Not all window managers will
1744 make the icon border visible.
1745 iconBorderWidth (class BorderWidth)
1747 Specifies the border width for the active icon window if this
1748 feature is compiled into xterm. The default is 2. Not all
1749 window managers will make the border visible.
1750 iconFont (class IconFont)
1752 Specifies the font for the miniature active icon window, if
1753 this feature is compiled into xterm. The default is "nil2".
1754 initialFont (class InitialFont)
1756 Specifies which of the VT100 fonts to use initially. Values
1757 are the same as for the set-vt-font action. The default is
1758 ``d'', i.e., "default".
1759 internalBorder (class BorderWidth)
1761 Specifies the number of pixels between the characters and the
1762 window border. The default is 2.
1763 italicULMode (class ColorAttrMode)
1765 Specifies whether characters with the underline attribute
1766 should be displayed in an italic font or as underlined charac‐
1767 ters. It is implemented only for TrueType fonts.
1768 jumpScroll (class JumpScroll)
1770 Specifies whether or not jump scroll should be used. This cor‐
1771 responds to the VT102 DECSCLM private mode. The default is
1772 ``true.''
1773 keepSelection (class KeepSelection)
1775 Specifies whether xterm will keep the selection even after the
1776 selected area was touched by some output to the terminal. The
1777 default is ``false''.
1778 keyboardDialect (class KeyboardDialect)
1780 Specifies the initial keyboard dialect, as well as the default
1781 value when the terminal is reset. The value given is the same
1782 as the final character in the control sequences which change
1783 character sets. The default is ``B'', which corresponds to US
1784 ASCII.
1785 nameKeymap (class NameKeymap)
1787 See the discussion of the keymap() action.
1788 limitResize (class LimitResize)
1790 Limits resizing of the screen via control sequence to a given
1791 multiple of the display dimensions. The default is ``1''.
1792 locale (class Locale)
1794 Specifies how to use luit, an encoding converter between UTF-8
1795 and locale encodings. The resource value (ignoring case) may
1796 be:
1797 true
1799 xterm will use the encoding specified by the users'
1800 LC_CTYPE locale (i.e., LC_ALL, LC_CTYPE, or LANG variables)
1801 as far as possible. This is realized by always enabling
1802 UTF-8 mode and invoking luit in non-UTF-8 locales.
1803 medium
1805 xterm will follow users' LC_CTYPE locale only for UTF-8,
1806 east Asian, and Thai locales, where the encodings were not
1807 supported by conventional 8bit mode with changing fonts.
1808 For other locales, xterm will use conventional 8bit mode.
1809 checkfont
1811 If mini-luit is compiled-in, xterm will check if a Unicode
1812 font has been specified. If so, it checks if the character
1813 encoding for the current locale is POSIX, Latin-1 or
1814 Latin-9, uses the appropriate mapping to support those with
1815 the Unicode font. For other encodings, xterm assumes that
1816 UTF-8 encoding is required.
1817 false
1819 xterm will use conventional 8bit mode or UTF-8 mode accord‐
1820 ing to utf8 resource or -u8 option.
1821 Any other value, e.g., ``UTF-8'' or ``ISO8859-2'', is assumed
1823 to be an encoding name; luit will be invoked to support the
1824 encoding. The actual list of supported encodings depends on
1825 luit. The default is ``medium''.
1826 Regardless of your locale and encoding, you need an ISO-10646-1
1828 font to display the result. Your configuration may not include
1829 this font, or locale-support by xterm may not be needed. At
1830 startup, xterm uses a mechanism equivalent to the load-vt-
1831 fonts(utf8Fonts, Utf8Fonts) action to load font name subre‐
1832 sources of the VT100 widget. That is, resource patterns such
1833 as "*vt100.utf8Fonts.font" will be loaded, and (if this
1834 resource is enabled), override the normal fonts. If no subre‐
1835 sources are found, the normal fonts such as "*vt100.font",
1836 etc., are used. The resource files distributed with xterm use
1837 ISO-10646-1 fonts, but do not rely on them unless you are using
1838 the locale mechanism.
1839 localeFilter (class LocaleFilter)
1841 Specifies the file name for the encoding converter from/to
1842 locale encodings and UTF-8 which is used with the -lc option or
1843 locale resource. The help message shown by ``xterm -help''
1844 lists the default value, which depends on your system configu‐
1845 ration.
1846 loginShell (class LoginShell)
1848 Specifies whether or not the shell to be run in the window
1849 should be started as a login shell. The default is ``false.''
1850 marginBell (class MarginBell)
1852 Specifies whether or not the bell should be rung when the user
1853 types near the right margin. The default is ``false.''
1854 metaSendsEscape (class MetaSendsEscape)
1856 If ``true'', Meta characters (a character combined with the
1857 Meta modifier key) are converted into a two-character sequence
1858 with the character itself preceded by ESC. This applies as
1859 well to function key control sequences, unless xterm sees that
1860 Meta is used in your key translations. If ``false'', Meta
1861 characters input from the keyboard are handled according to the
1862 eightBitInput resource. The default is ``false.''
1863 mkSamplePass (class MkSamplePass)
1865 If mkSampleSize is nonzero, and mkWidth (and cjkWidth) are
1866 false, on startup xterm compares its built-in tables to the
1867 system's wide character width data to decide if it will use the
1868 system's data. It tests the first mkSampleSize character val‐
1869 ues, and allows up to mkSamplePass mismatches before the test
1870 fails. The default (for the allowed number of mismatches) is
1871 256.
1872 mkSampleSize (class MkSampleSize)
1874 With mkSamplePass, this specifies a startup test used for ini‐
1875 tializing wide character width calculations. The default (num‐
1876 ber of characters to check) is 1024.
1877 mkWidth (class MkWidth)
1879 Specifies whether xterm should use a built-in version of the
1880 wide character width calculation. See also the cjkWidth
1881 resource which can override this. The default is ``false.''
1882 Here is a summary of the resources which control the choice of
1884 wide character width calculation:
1885 cjkWidth mkWidth Action
1887 ───────────────────────────────────────────────────────────────
1888 false false use system tables subject to mkSamplePass
1889 false true use built-in tables
1890 true false use built-in CJK tables
1891 true true use built-in CJK tables
1892 modifyCursorKeys (class ModifyCursorKeys)
1894 Tells how to handle the special case where Control-, Shift-,
1895 Alt- or Meta-modifiers are used to add a parameter to the
1896 escape sequence returned by a cursor-key. The default is
1897 ``2'':
1898 Set it to -1 to disable it.
1900 Set it to 0 to use the old/obsolete behavior.
1901 Set it to 1 to prefix modified sequences with CSI.
1902 Set it to 2 to force the modifier to be the second parameter if
1903 it would otherwise be the first.
1904 Set it to 3 to mark the sequence with a '>' to hint that it is
1905 private.
1906 modifyFunctionKeys (class ModifyFunctionKeys)
1908 Tells how to handle the special case where Control-, Shift-,
1909 Alt- or Meta-modifiers are used to add a parameter to the
1910 escape sequence returned by a (numbered) function-key. The
1911 default is ``2''. The resource values are similar to modify‐
1912 CursorKeys:
1913 Set it to -1 to permit the user to use shift- and control-modi‐
1915 fiers to construct function-key strings using the normal encod‐
1916 ing scheme.
1917 Set it to 0 to use the old/obsolete behavior.
1918 Set it to 1 to prefix modified sequences with CSI.
1919 Set it to 2 to force the modifier to be the second parameter if
1920 it would otherwise be the first.
1921 Set it to 3 to mark the sequence with a '>' to hint that it is
1922 private.
1923 If modifyFunctionKeys is zero, xterm uses Control- and Shift-
1925 modifiers to allow the user to construct numbered function-keys
1926 beyond the set provided by the keyboard:
1927 Control
1929 adds the value given by the ctrlFKeys resource.
1930 Shift
1932 adds twice the value given by the ctrlFKeys resource.
1933 Control/Shift
1935 adds three times the value given by the ctrlFKeys
1936 resource.
1937 As a special case, legacy (when oldFunctionKeys is true) or
1939 vt220 (when sunKeyboard is true) keyboards interpret only the
1940 Control-modifier when constructing numbered function-keys.
1941 This is done to provide compatible keyboards for DEC VT220 and
1942 related terminals that implement user-defined keys (UDK).
1943 modifyOtherKeys (class ModifyOtherKeys)
1945 Like modifyCursorKeys, tells xterm to construct an escape
1946 sequence for other keys (such as "2") when modified by Con‐
1947 trol-, Alt- or Meta-modifiers. This feature does not apply to
1948 function keys and well-defined keys such as ESC or the control
1949 keys. The default is ``0'':
1950 0 disables this feature.
1952 1 enables this feature for keys except for those with well-
1954 known behavior, e.g., Tab, Backarrow and some special con‐
1955 trol character cases, e.g., Control-Space to make a NUL.
1956 2 enables this feature for keys including the exceptions
1958 listed.
1959 multiClickTime (class MultiClickTime)
1961 Specifies the maximum time in milliseconds between multi-click
1962 select events. The default is 250 milliseconds.
1963 multiScroll (class MultiScroll)
1965 Specifies whether or not scrolling should be done asyn‐
1966 chronously. The default is ``false.''
1967 nMarginBell (class Column)
1969 Specifies the number of characters from the right margin at
1970 which the margin bell should be rung, when enabled by the
1971 marginBell resource. The default is 10.
1972 numLock (class NumLock)
1974 If ``true'', xterm checks if NumLock is used as a modifier (see
1975 xmodmap(1)). If so, this modifier is used to simplify the
1976 logic when implementing special NumLock for the sunKeyboard
1977 resource. Also (when sunKeyboard is false), similar logic is
1978 used to find the modifier associated with the left and right
1979 Alt keys. The default is ``true.''
1980 oldXtermFKeys (class OldXtermFKeys)
1982 If ``true'', xterm will use old-style control sequences for
1983 function keys F1 to F4, for compatibility with X Consortium
1984 xterm. Otherwise, it uses the VT100-style codes for PF1 to
1985 PF4. The default is ``false.''
1986 on2Clicks (class On2Clicks)
1988 on3Clicks (class On3Clicks)
1990 on4Clicks (class On4Clicks)
1992 on5Clicks (class On5Clicks)
1994 Specify selection behavior in response to multiple mouse
1995 clicks. A single mouse click is always interpreted as
1996 described in the SELECTION section (see POINTER USAGE). Multi‐
1997 ple mouse clicks (using the button which activates the select-
1998 start action) are interpreted according to the resource values
1999 of on2Clicks, etc. The resource value can be one of these:
2000 word
2002 Select a ``word'' as determined by the charClass resource.
2003 See the CHARACTER CLASSES section.
2004 line
2006 Select a line (counting wrapping).
2007 group
2009 Select a group of adjacent lines (counting wrapping). The
2010 selection stops on a blank line.
2011 page
2013 Select all visible lines, i.e., the page.
2014 all
2016 Select all lines, i.e., including the saved lines.
2017 regex
2019 Select a ``word'' as determined by the regular expression
2020 which follows in the resource value.
2021 none
2023 No selection action is associated with this resource. xterm
2024 interprets it as the end of the list. For example, you may
2025 use it to disable triple (and higher) clicking by setting
2026 on3Clicks to ``none''.
2027 The default values for on2Clicks and on3Clicks are ``word'' and
2029 ``line'', respectively. There is no default value for
2030 on4Clicks or on5Clicks, making those inactive. On startup,
2031 xterm determines the maximum number of clicks by the onXClicks
2032 resource values which are set.
2033 pointerColor (class PointerColor)
2035 Specifies the foreground color of the pointer. The default is
2036 ``XtDefaultForeground.''
2037 pointerColorBackground (class PointerColorBackground)
2039 Specifies the background color of the pointer. The default is
2040 ``XtDefaultBackground.''
2041 pointerMode (class PointerMode)
2043 Specifies when the pointer may be hidden as the user types. It
2044 will be redisplayed if the user moves the mouse, or clicks one
2045 of its buttons.
2046 0 never
2048 1 the application running in xterm has not activated mouse
2050 mode. This is the default.
2051 2 always.
2053 pointerShape (class Cursor)
2055 Specifies the name of the shape of the pointer. The default is
2056 ``xterm.''
2057 popOnBell (class PopOnBell)
2059 Specifies whether the window would be raised when Control-G is
2060 received. The default is ``false.''
2061 printAttributes (class PrintAttributes)
2063 Specifies whether to print graphic attributes along with the
2064 text. A real DEC VTxxx terminal will print the underline,
2065 highlighting codes but your printer may not handle these. A
2066 ``0'' disables the attributes. A ``1'' prints the normal set
2067 of attributes (bold, underline, inverse and blink) as
2068 VT100-style control sequences. A ``2'' prints ANSI color
2069 attributes as well. The default is ``1.''
2070 printerAutoClose (class PrinterAutoClose)
2072 If ``true'', xterm will close the printer (a pipe) when the
2073 application switches the printer offline with a Media Copy com‐
2074 mand. The default is ``false.''
2075 printerCommand (class PrinterCommand)
2077 Specifies a shell command to which xterm will open a pipe when
2078 the first MC (Media Copy) command is initiated. The default is
2079 a blank string. If the resource value is given as a blank
2080 string, the printer is disabled.
2081 printerControlMode (class PrinterControlMode)
2083 Specifies the printer control mode. A ``1'' selects autoprint
2084 mode, which causes xterm to print a line from the screen when
2085 you move the cursor off that line with a line feed, form feed
2086 or vertical tab character, or an autowrap occurs. Autoprint
2087 mode is overridden by printer controller mode (a ``2''), which
2088 causes all of the output to be directed to the printer. The
2089 default is ``0.''
2090 printerExtent (class PrinterExtent)
2092 Controls whether a print page function will print the entire
2093 page (true), or only the the portion within the scrolling mar‐
2094 gins (false). The default is ``false.''
2095 printerFormFeed (class PrinterFormFeed)
2097 Controls whether a form feed is sent to the printer at the end
2098 of a print page function. The default is ``false.''
2099 quietGrab (class QuietGrab)
2101 Controls whether the cursor is repainted when NotifyGrab and
2102 NotifyUngrab event types are received during change of focus.
2103 The default is ``false.''
2104 renderFont (class RenderFont)
2106 If xterm is built with the Xft library, this controls whether
2107 the faceName resource is used. The default is ``true.''
2108 resizeGravity (class ResizeGravity)
2110 Affects the behavior when the window is resized to be taller or
2111 shorter. NorthWest specifies that the top line of text on the
2112 screen stay fixed. If the window is made shorter, lines are
2113 dropped from the bottom; if the window is made taller, blank
2114 lines are added at the bottom. This is compatible with the
2115 behavior in R4. SouthWest (the default) specifies that the
2116 bottom line of text on the screen stay fixed. If the window is
2117 made taller, additional saved lines will be scrolled down onto
2118 the screen; if the window is made shorter, lines will be
2119 scrolled off the top of the screen, and the top saved lines
2120 will be dropped.
2121 reverseVideo (class ReverseVideo)
2123 Specifies whether or not reverse video should be simulated.
2124 The default is ``false.''
2125 reverseWrap (class ReverseWrap)
2127 Specifies whether or not reverse-wraparound should be enabled.
2128 This corresponds to xterm's private mode 45. The default is
2129 ``false.''
2130 rightScrollBar (class RightScrollBar)
2132 Specifies whether or not the scrollbar should be displayed on
2133 the right rather than the left. The default is ``false.''
2134 saveLines (class SaveLines)
2136 Specifies the number of lines to save beyond the top of the
2137 screen when a scrollbar is turned on. The default is 64.
2138 scrollBar (class ScrollBar)
2140 Specifies whether or not the scrollbar should be displayed.
2141 The default is ``false.''
2142 scrollBarBorder (class ScrollBarBorder)
2144 Specifies the width of the scrollbar border. Note that this is
2145 drawn to overlap the border of the xterm window. Modifying the
2146 scrollbar's border affects only the line between the VT100 wid‐
2147 get and the scrollbar. The default value is 1.
2148 scrollKey (class ScrollCond)
2150 Specifies whether or not pressing a key should automatically
2151 cause the scrollbar to go to the bottom of the scrolling
2152 region. This corresponds to xterm's private mode 1011. The
2153 default is ``false.''
2154 scrollLines (class ScrollLines)
2156 Specifies the number of lines that the scroll-back and scroll-
2157 forw actions should use as a default. The default value is 1.
2158 scrollTtyOutput (class ScrollCond)
2160 Specifies whether or not output to the terminal should automat‐
2161 ically cause the scrollbar to go to the bottom of the scrolling
2162 region. The default is ``true.''
2163 selectToClipboard (class SelectToClipboard)
2165 Tells xterm whether to use the PRIMARY or CLIPBOARD for SELECT
2166 tokens in the selection mechanism. The set-select action can
2167 change this at runtime, allowing the user to work with programs
2168 that handle only one of these mechanisms. The default is
2169 ``false'', which tells it to use PRIMARY.
2170 shiftFonts (class ShiftFonts)
2172 Specifies whether to enable the actions larger-vt-font() and
2173 smaller-vt-font(), which are normally bound to the shifted
2174 KP_Add and KP_Subtract. The default is ``true.''
2175 showBlinkAsBold (class ShowBlinkAsBold)
2177 Tells xterm whether to display text with blink-attribute the
2178 same as bold. If xterm has not been configured to support
2179 blinking text, the default is ``true.'', which corresponds to
2180 older versions of xterm, otherwise the default is ``false.''
2181 showMissingGlyphs (class ShowMissingGlyphs)
2183 Tells xterm whether to display a box outlining places where a
2184 character has been used that the font does not represent. The
2185 default is ``false.''
2186 signalInhibit (class SignalInhibit)
2188 Specifies whether or not the entries in the ``Main Options''
2189 menu for sending signals to xterm should be disallowed. The
2190 default is ``false.''
2191 tekGeometry (class Geometry)
2193 Specifies the preferred size and position of the Tektronix win‐
2194 dow. There is no default for this resource.
2195 tekInhibit (class TekInhibit)
2197 Specifies whether or not the escape sequence to enter Tektronix
2198 mode should be ignored. The default is ``false.''
2199 tekSmall (class TekSmall)
2201 Specifies whether or not the Tektronix mode window should start
2202 in its smallest size if no explicit geometry is given. This is
2203 useful when running xterm on displays with small screens. The
2204 default is ``false.''
2205 tekStartup (class TekStartup)
2207 Specifies whether or not xterm should start up in Tektronix
2208 mode. The default is ``false.''
2209 tiXtraScroll (class TiXtraScroll)
2211 Specifies whether xterm should scroll to a new page when pro‐
2212 cessing the ti termcap entry, i.e., the private modes 47, 1047
2213 or 1049. This is only in effect if titeInhibit is ``true'',
2214 because the intent of this option is to provide a picture of
2215 the full-screen application's display on the scrollback without
2216 wiping out the text that would be shown before the application
2217 was initialized. The default for this resource is ``false.''
2218 titeInhibit (class TiteInhibit)
2220 Specifies whether or not xterm should remove ti and te termcap
2221 entries (used to switch between alternate screens on startup of
2222 many screen-oriented programs) from the TERMCAP string. If
2223 set, xterm also ignores the escape sequence to switch to the
2224 alternate screen. Xterm supports terminfo in a different way,
2225 supporting composite control sequences (also known as private
2226 modes) 1047, 1048 and 1049 which have the same effect as the
2227 original 47 control sequence. The default for this resource is
2228 ``false.''
2229 translations (class Translations)
2231 Specifies the key and button bindings for menus, selections,
2232 ``programmed strings,'' etc. The translations resource, which
2233 provides much of xterm's configurability, is a feature of the X
2234 Toolkit Intrinsics library (Xt). See the ACTIONS section.
2235 trimSelection (class TrimSelection)
2237 If you set highlightSelection, you can see the text which is
2238 selected, including any trailing spaces. Clearing the screen
2239 (or a line) resets it to a state containing no spaces. Some
2240 lines may contain trailing spaces when an application writes
2241 them to the screen. However, you may not wish to paste lines
2242 with trailing spaces. If this resource is true, xterm will
2243 trim trailing spaces from text which is selected. It does not
2244 affect spaces which result in a wrapped line, nor will it trim
2245 the trailing newline from your selection. The default is
2246 ``false.''
2247 underLine (class UnderLine)
2249 This specifies whether or not text with the underline attribute
2250 should be underlined. It may be desirable to disable underlin‐
2251 ing when color is being used for the underline attribute. The
2252 default is ``true.''
2253 useClipping (class UseClipping)
2255 Tell xterm whether to use clipping to keep from producing dots
2256 outside the text drawing area. Originally used to work around
2257 for overstriking effects, this is also needed to work with some
2258 incorrectly-sized fonts. The default is ``true.''
2259 utf8 (class Utf8)
2261 This specifies whether xterm will run in UTF-8 mode. If you
2262 set this resource, xterm also sets the wideChars resource as a
2263 side-effect. The resource is an integer, expected to range
2264 from 0 to 3:
2265 0 UTF-8 mode is initially off. The command-line option +u8
2267 sets the resource to this value. Escape sequences for turn‐
2268 ing UTF-8 mode on/off are allowed.
2269 1 UTF-8 mode is initially on. Escape sequences for turning
2271 UTF-8 mode on/off are allowed.
2272 2 The command-line option -u8 sets the resource to this value.
2274 Escape sequences for turning UTF-8 mode on/off are ignored.
2275 3 This is the default value of the resource. It is changed
2277 during initialization depending on whether the locale
2278 resource was set, to 0 or 2. See the locale resource for
2279 additional discussion of non-UTF-8 locales.
2280 If you want to set the value of utf8, it should be in this
2282 range. Other nonzero values are treated the same as ``1'',
2283 i.e., UTF-8 mode is initially on, and escape sequences for
2284 turning UTF-8 mode on/off are allowed.
2285 utf8Fonts (class Utf8Fonts)
2287 See the discussion of the locale resource.
2288 utf8Latin1 (class Utf8Latin1)
2290 If true, allow an ISO-8859-1 normal font to be combined with an
2291 ISO-10646 font if the latter is given via the -fw option or its
2292 corresponding resource value. The default is ``false.''
2293 utf8Title (class Utf8Title)
2295 Applications can set xterm's title by writing a control
2296 sequence. Normally this control sequence follows the VT220
2297 convention, which encodes the string in ISO-8859-1 and allows
2298 for an 8-bit string terminator. If xterm is started in a UTF-8
2299 locale, it translates the ISO-8859-1 string to UTF-8 to work
2300 with the X libraries which assume the string is UTF-8.
2301 However, some users may wish to write a title string encoded in
2303 UTF-8. Set this resource to ``true'' to allow UTF-8 encoded
2304 title strings. That cancels the translation to UTF-8, allowing
2305 UTF-8 strings to be displayed as is.
2306 The default is ``false.''
2308 veryBoldColors (class VeryBoldColors)
2310 Specifies whether to combine video attributes with colors spec‐
2311 ified by colorBD, colorBL, colorRV and colorUL. The resource
2312 value is the sum of values for each attribute:
2313 1 for reverse,
2314 2 for underline,
2315 4 for bold and
2316 8 for blink.
2317 The default is ``0.''
2319 visualBell (class VisualBell)
2321 Specifies whether or not a visible bell (i.e., flashing) should
2322 be used instead of an audible bell when Control-G is received.
2323 The default is ``false.''
2324 visualBellDelay (class VisualBellDelay)
2326 Number of milliseconds to delay when displaying a visual bell.
2327 Default is 100. If set to zero, no visual bell is displayed.
2328 This is useful for very slow displays, e.g., an LCD display on
2329 a laptop.
2330 vt100Graphics (class VT100Graphics)
2332 This specifies whether xterm will interpret VT100 graphic char‐
2333 acter escape sequences while in UTF-8 mode. The default is
2334 ``true'', to provide support for various legacy applications.
2335 wideBoldFont (class WideBoldFont)
2337 This option specifies the font to be used for displaying bold
2338 wide text. By default, it will attempt to use a font twice as
2339 wide as the font that will be used to draw bold text. If no
2340 doublewidth font is found, it will improvise, by stretching the
2341 bold font.
2342 wideChars (class WideChars)
2344 Specifies if xterm should respond to control sequences that
2345 process 16-bit characters. The default is ``false.''
2346 wideFont (class WideFont)
2348 This option specifies the font to be used for displaying wide
2349 text. By default, it will attempt to use a font twice as wide
2350 as the font that will be used to draw normal text. If no dou‐
2351 blewidth font is found, it will improvise, by stretching the
2352 normal font.
2353 ximFont (class XimFont)
2355 This option specifies the font to be used for displaying the
2356 preedit string in the "OverTheSpot" input method.
2357 In "OverTheSpot" preedit type, the preedit (preconversion)
2359 string is displayed at the position of the cursor. It is the
2360 XIM server's responsibility to display the preedit string. The
2361 XIM client must inform the XIM server of the cursor position.
2362 For best results, the preedit string must be displayed with a
2363 proper font. Therefore, xterm informs the XIM server of the
2364 proper font. The font is be supplied by a "fontset", whose
2365 default value is "*". This matches every font, the X library
2366 automatically chooses fonts with proper charsets. The ximFont
2367 resource is provided to override this default font setting.
2368 Tek4014 Widget Resources
2370 The following resources are specified as part of the tek4014 widget
2371 (class Tek4014). These are specified by patterns such as
2372 "XTerm.tek4014.NAME":
2373 font2 (class Font)
2375 Specifies font number 2 to use in the Tektronix window.
2376 font3 (class Font)
2378 Specifies font number 3 to use in the Tektronix window.
2379 fontLarge (class Font)
2381 Specifies the large font to use in the Tektronix window.
2382 fontSmall (class Font)
2384 Specifies the small font to use in the Tektronix window.
2385 ginTerminator (class GinTerminator)
2387 Specifies what character(s) should follow a GIN report or sta‐
2388 tus report. The possibilities are ``none,'' which sends no
2389 terminating characters, ``CRonly,'' which sends CR, and
2390 ``CR&EOT,'' which sends both CR and EOT. The default is
2391 ``none.''
2392 height (class Height)
2394 Specifies the height of the Tektronix window in pixels.
2395 initialFont (class InitialFont)
2397 Specifies which of the four Tektronix fonts to use initially.
2398 Values are the same as for the set-tek-text action. The
2399 default is ``large.''
2400 width (class Width)
2402 Specifies the width of the Tektronix window in pixels.
2403 Menu Resources
2405 The resources that may be specified for the various menus are described
2406 in the documentation for the Athena SimpleMenu widget. The name and
2407 classes of the entries in each of the menus are listed below.
2408 Resources named "lineN" where N is a number are separators with class
2409 SmeLine.
2410 The mainMenu has the following entries:
2412 toolbar (class SmeBSB)
2414 This entry invokes the set-toolbar(toggle) action.
2415 securekbd (class SmeBSB)
2417 This entry invokes the secure() action.
2418 allowsends (class SmeBSB)
2420 This entry invokes the allow-send-events(toggle) action.
2421 redraw (class SmeBSB)
2423 This entry invokes the redraw() action.
2424 logging (class SmeBSB)
2426 This entry invokes the logging(toggle) action.
2427 print (class SmeBSB)
2429 This entry invokes the print() action.
2430 print-redir (class SmeBSB)
2432 This entry invokes the print-redir() action.
2433 8-bit-control (class SmeBSB)
2435 This entry invokes the set-8-bit-control(toggle) action.
2436 backarrow key (class SmeBSB)
2438 This entry invokes the set-backarrow(toggle) action.
2439 num-lock (class SmeBSB)
2441 This entry invokes the set-num-lock(toggle) action.
2442 alt-esc (class SmeBSB)
2444 This entry invokes the alt-sends-escape(toggle) action.
2445 meta-esc (class SmeBSB)
2447 This entry invokes the meta-sends-escape(toggle) action.
2448 delete-is-del (class SmeBSB)
2450 This entry invokes the delete-is-del(toggle) action.
2451 oldFunctionKeys (class SmeBSB)
2453 This entry invokes the old-function-keys(toggle) action.
2454 hpFunctionKeys (class SmeBSB)
2456 This entry invokes the hp-function-keys(toggle) action.
2457 scoFunctionKeys (class SmeBSB)
2459 This entry invokes the sco-function-keys(toggle) action.
2460 sunFunctionKeys (class SmeBSB)
2462 This entry invokes the sun-function-keys(toggle) action.
2463 sunKeyboard (class SmeBSB)
2465 This entry invokes the sunKeyboard(toggle) action.
2466 suspend (class SmeBSB)
2468 This entry invokes the send-signal(tstp) action on systems that
2469 support job control.
2470 continue (class SmeBSB)
2472 This entry invokes the send-signal(cont) action on systems that
2473 support job control.
2474 interrupt (class SmeBSB)
2476 This entry invokes the send-signal(int) action.
2477 hangup (class SmeBSB)
2479 This entry invokes the send-signal(hup) action.
2480 terminate (class SmeBSB)
2482 This entry invokes the send-signal(term) action.
2483 kill (class SmeBSB)
2485 This entry invokes the send-signal(kill) action.
2486 quit (class SmeBSB)
2488 This entry invokes the quit() action.
2489 The vtMenu has the following entries:
2491 scrollbar (class SmeBSB)
2493 This entry invokes the set-scrollbar(toggle) action.
2494 jumpscroll (class SmeBSB)
2496 This entry invokes the set-jumpscroll(toggle) action.
2497 reversevideo (class SmeBSB)
2499 This entry invokes the set-reverse-video(toggle) action.
2500 autowrap (class SmeBSB)
2502 This entry invokes the set-autowrap(toggle) action.
2503 reversewrap (class SmeBSB)
2505 This entry invokes the set-reversewrap(toggle) action.
2506 autolinefeed (class SmeBSB)
2508 This entry invokes the set-autolinefeed(toggle) action.
2509 appcursor (class SmeBSB)
2511 This entry invokes the set-appcursor(toggle) action.
2512 appkeypad (class SmeBSB)
2514 This entry invokes the set-appkeypad(toggle) action.
2515 scrollkey (class SmeBSB)
2517 This entry invokes the set-scroll-on-key(toggle) action.
2518 scrollttyoutput (class SmeBSB)
2520 This entry invokes the set-scroll-on-tty-output(toggle) action.
2521 allow132 (class SmeBSB)
2523 This entry invokes the set-allow132(toggle) action.
2524 cursesemul (class SmeBSB)
2526 This entry invokes the set-cursesemul(toggle) action.
2527 visualbell (class SmeBSB)
2529 This entry invokes the set-visualbell(toggle) action.
2530 bellIsUrgent (class SmeBSB)
2532 This entry invokes the set-bellIsUrgent(toggle) action.
2533 poponbell (class SmeBSB)
2535 This entry invokes the set-poponbell(toggle) action.
2536 cursorblink (class SmeBSB)
2538 This entry invokes the set-cursorblink(toggle) action.
2539 titeInhibit (class SmeBSB)
2541 This entry invokes the set-titeInhibit(toggle) action.
2542 activeicon (class SmeBSB)
2544 This entry toggles active icons on and off if this feature was
2545 compiled into xterm. It is enabled only if xterm was started
2546 with the command line option +ai or the activeIcon resource is
2547 set to ``true.''
2548 softreset (class SmeBSB)
2550 This entry invokes the soft-reset() action.
2551 hardreset (class SmeBSB)
2553 This entry invokes the hard-reset() action.
2554 clearsavedlines (class SmeBSB)
2556 This entry invokes the clear-saved-lines() action.
2557 tekshow (class SmeBSB)
2559 This entry invokes the set-visibility(tek,toggle) action.
2560 tekmode (class SmeBSB)
2562 This entry invokes the set-terminal-type(tek) action.
2563 vthide (class SmeBSB)
2565 This entry invokes the set-visibility(vt,off) action.
2566 altscreen (class SmeBSB)
2568 This entry invokes the set-altscreen(toggle) action.
2569 The fontMenu has the following entries:
2571 fontdefault (class SmeBSB)
2573 This entry invokes the set-vt-font(d) action.
2574 font1 (class SmeBSB)
2576 This entry invokes the set-vt-font(1) action.
2577 font2 (class SmeBSB)
2579 This entry invokes the set-vt-font(2) action.
2580 font3 (class SmeBSB)
2582 This entry invokes the set-vt-font(3) action.
2583 font4 (class SmeBSB)
2585 This entry invokes the set-vt-font(4) action.
2586 font5 (class SmeBSB)
2588 This entry invokes the set-vt-font(5) action.
2589 font6 (class SmeBSB)
2591 This entry invokes the set-vt-font(6) action.
2592 fontescape (class SmeBSB)
2594 This entry invokes the set-vt-font(e) action.
2595 fontsel (class SmeBSB)
2597 This entry invokes the set-vt-font(s) action.
2598 font-linedrawing (class SmeBSB)
2600 This entry invokes the set-font-linedrawing(s) action.
2601 font-doublesize (class SmeBSB)
2603 This entry invokes the set-font-doublesize(s) action.
2604 render-font (class SmeBSB)
2606 This entry invokes the set-render-font(s) action.
2607 utf8-mode (class SmeBSB)
2609 This entry invokes the set-utf8-mode(s) action.
2610 utf8-title (class SmeBSB)
2612 This entry invokes the set-utf8-title(s) action.
2613 The tekMenu has the following entries:
2615 tektextlarge (class SmeBSB)
2617 This entry invokes the set-tek-text(large) action.
2618 tektext2 (class SmeBSB)
2620 This entry invokes the set-tek-text(2) action.
2621 tektext3 (class SmeBSB)
2623 This entry invokes the set-tek-text(3) action.
2624 tektextsmall (class SmeBSB)
2626 This entry invokes the set-tek-text(small) action.
2627 tekpage (class SmeBSB)
2629 This entry invokes the tek-page() action.
2630 tekreset (class SmeBSB)
2632 This entry invokes the tek-reset() action.
2633 tekcopy (class SmeBSB)
2635 This entry invokes the tek-copy() action.
2636 vtshow (class SmeBSB)
2638 This entry invokes the set-visibility(vt,toggle) action.
2639 vtmode (class SmeBSB)
2641 This entry invokes the set-terminal-type(vt) action.
2642 tekhide (class SmeBSB)
2644 This entry invokes the set-visibility(tek,toggle) action.
2645 Scrollbar Resources
2647 The following resources are useful when specified for the Athena
2648 Scrollbar widget:
2649 thickness (class Thickness)
2651 Specifies the width in pixels of the scrollbar.
2652 background (class Background)
2654 Specifies the color to use for the background of the scrollbar.
2655 foreground (class Foreground)
2657 Specifies the color to use for the foreground of the scrollbar.
2658 The ``thumb'' of the scrollbar is a simple checkerboard pattern
2659 alternating pixels for foreground and background color.
2660
2662 Once the VT102 window is created, xterm allows you to select text and
2663 copy it within the same or other windows.
2664 SELECTION
2666 The selection functions are invoked when the pointer buttons are used
2667 with no modifiers, and when they are used with the ``shift'' key. The
2668 assignment of the functions described below to keys and buttons may be
2669 changed through the resource database; see ACTIONS below.
2670 Pointer button one (usually left) is used to save text into the cut
2672 buffer. Move the cursor to beginning of the text, and then hold the
2673 button down while moving the cursor to the end of the region and
2674 releasing the button. The selected text is highlighted and is saved in
2675 the global cut buffer and made the PRIMARY selection when the button is
2676 released. Normally (but see the discussion of on2Clicks, etc):
2677 - Double-clicking selects by words.
2679 - Triple-clicking selects by lines.
2681 - Quadruple-clicking goes back to characters, etc.
2683 Multiple-click is determined by the time from button up to button down,
2685 so you can change the selection unit in the middle of a selection.
2686 Logical words and lines selected by double- or triple-clicking may wrap
2687 across more than one screen line if lines were wrapped by xterm itself
2688 rather than by the application running in the window. If the key/but‐
2689 ton bindings specify that an X selection is to be made, xterm will
2690 leave the selected text highlighted for as long as it is the selection
2691 owner.
2692 Pointer button two (usually middle) `types' (pastes) the text from the
2694 PRIMARY selection, if any, otherwise from the cut buffer, inserting it
2695 as keyboard input.
2696 Pointer button three (usually right) extends the current selection.
2698 (Without loss of generality, you can swap ``right'' and ``left'' every‐
2699 where in the rest of this paragraph.) If pressed while closer to the
2700 right edge of the selection than the left, it extends/contracts the
2701 right edge of the selection. If you contract the selection past the
2702 left edge of the selection, xterm assumes you really meant the left
2703 edge, restores the original selection, then extends/contracts the left
2704 edge of the selection. Extension starts in the selection unit mode
2705 that the last selection or extension was performed in; you can multi‐
2706 ple-click to cycle through them.
2707 By cutting and pasting pieces of text without trailing new lines, you
2709 can take text from several places in different windows and form a com‐
2710 mand to the shell, for example, or take output from a program and
2711 insert it into your favorite editor. Since cut buffers are globally
2712 shared among different applications, you may regard each as a `file'
2713 whose contents you know. The terminal emulator and other text programs
2714 should be treating it as if it were a text file, i.e., the text is
2715 delimited by new lines.
2716 SCROLLING
2718 The scroll region displays the position and amount of text currently
2719 showing in the window (highlighted) relative to the amount of text
2720 actually saved. As more text is saved (up to the maximum), the size of
2721 the highlighted area decreases.
2722 Clicking button one with the pointer in the scroll region moves the
2724 adjacent line to the top of the display window.
2725 Clicking button three moves the top line of the display window down to
2727 the pointer position.
2728 Clicking button two moves the display to a position in the saved text
2730 that corresponds to the pointer's position in the scrollbar.
2731 TEKTRONIX POINTER
2733 Unlike the VT102 window, the Tektronix window does not allow the copy‐
2734 ing of text. It does allow Tektronix GIN mode, and in this mode the
2735 cursor will change from an arrow to a cross. Pressing any key will
2736 send that key and the current coordinate of the cross cursor. Pressing
2737 button one, two, or three will return the letters `l', `m', and `r',
2738 respectively. If the `shift' key is pressed when a pointer button is
2739 pressed, the corresponding upper case letter is sent. To distinguish a
2740 pointer button from a key, the high bit of the character is set (but
2741 this is bit is normally stripped unless the terminal mode is RAW; see
2742 tty(4) for details).
2743
2745 Xterm has four menus, named mainMenu, vtMenu, fontMenu, and tekMenu.
2746 Each menu pops up under the correct combinations of key and button
2747 presses. Each menu is divided into sections, separated by a horizontal
2748 line. Some menu entries correspond to modes that can be altered. A
2749 check mark appears next to a mode that is currently active. Selecting
2750 one of these modes toggles its state. Other menu entries are commands;
2751 selecting one of these performs the indicated function.
2752 All of the menu entries correspond to X actions. In the list below,
2754 the menu label is shown followed by the action's name in parenthesis.
2755 Main Options
2757 The xterm mainMenu pops up when the ``control'' key and pointer button
2758 one are pressed in a window. This menu contains items that apply to
2759 both the VT102 and Tektronix windows. There are several sections:
2760 Commands for managing X events:
2762 Toolbar
2764 Clicking on the "Toolbar" menu entry hides the toolbar if
2765 it is visible, and shows it if it is not.
2766 Secure Keyboard (securekbd)
2768 The Secure Keyboard mode is helpful when typing in pass‐
2769 words or other sensitive data in an unsecure environment;
2770 see SECURITY below (but read the limitations carefully).
2771 Allow SendEvents (allowsends )
2773 Specifies whether or not synthetic key and button events
2774 generated using the X protocol SendEvent request should
2775 be interpreted or discarded. This corresponds to the
2776 allowSendEvents resource.
2777 Redraw Window (redraw)
2779 Forces the X display to repaint; useful in some environ‐
2780 ments.
2781 Commands for capturing output:
2783 Log to File (logging)
2785 Captures text sent to the screen in a logfile, as in the
2786 -l logging option.
2787 Print Window (print)
2789 Sends the text of the current window to the program given
2790 in the printerCommand resource.
2791 Redirect to Printer (print-redir)
2793 This sets the printerControlMode to 0 or 2. You can use
2794 this to turn the printer on as if an application had sent
2795 the appropriate control sequence. It is also useful for
2796 switching the printer off if an application turns it on
2797 without resetting the print control mode.
2798 Modes for setting keyboard style:
2800 8-Bit Controls (8-bit-control)
2802 Enabled for VT220 emulation, this controls whether xterm
2803 will send 8-bit control sequences rather than using 7-bit
2804 (ASCII) controls, e.g., sending a byte in the range
2805 128-159 rather than the escape character followed by a
2806 second byte. Xterm always interprets both 8-bit and
2807 7-bit control sequences (see the document Xterm Control
2808 Sequences). This corresponds to the eightBitControl
2809 resource.
2810 Backarrow Key (BS/DEL) (backarrow key)
2812 Modifies the behavior of the backarrow key, making it
2813 transmit either a backspace (8) or delete (127) charac‐
2814 ter. This corresponds to the backarrowKey resource.
2815 Alt/NumLock Modifiers (num-lock)
2817 Controls the treatment of Alt- and NumLock-key modifiers.
2818 This corresponds to the numLock resource.
2819 Meta Sends Escape (meta-esc)
2821 Controls whether Meta keys are converted into a two-char‐
2822 acter sequence with the character itself preceded by ESC.
2823 This corresponds to the metaSendsEscape resource.
2824 Delete is DEL (delete-is-del)
2826 Controls whether the Delete key on the editing keypad
2827 should send DEL (127) or the VT220-style Remove escape
2828 sequence. This corresponds to the deleteIsDEL resource.
2829 Old Function-Keys (oldFunctionKeys)
2831 HP Function-Keys (hpFunctionKeys)
2833 SCO Function-Keys (scoFunctionKeys)
2835 Sun Function-Keys (sunFunctionKeys)
2837 VT220 Keyboard (sunKeyboard)
2839 These act as a radio-button, selecting one style for the
2840 keyboard layout. It corresponds to more than one
2841 resource setting: sunKeyboard, sunFunctionKeys, scoFunc‐
2842 tionKeys and hpFunctionKeys ."
2843 Commands for process signalling:
2845 Send STOP Signal (suspend)
2847 Send CONT Signal (continue)
2849 Send INT Signal (interrupt)
2851 Send HUP Signal (hangup)
2853 Send TERM Signal (terminate)
2855 Send KILL Signal (kill)
2857 These send the SIGTSTP, SIGCONT, SIGINT, SIGHUP, SIGTERM
2858 and SIGKILL signals respectively, to the process group of
2859 the process running under xterm (usually the shell). The
2860 SIGCONT function is especially useful if the user has
2861 accidentally typed CTRL-Z, suspending the process.
2862 Quit (quit)
2864 Stop processing X events except to support the -hold
2865 option, and then send a SIGHUP signal to the the process
2866 group of the process running under xterm (usually the
2867 shell).
2868 VT Options
2870 The vtMenu sets various modes in the VT102 emulation, and is popped up
2871 when the ``control'' key and pointer button two are pressed in the
2872 VT102 window.
2873 VT102/VT220 Modes:
2875 Enable Scrollbar (scrollbar)
2877 Enable (or disable) the scrollbar. This corresponds to
2878 the -sb option and the scrollBar resource.
2879 Enable Jump Scroll (jumpscroll)
2881 Enable (or disable) jump scrolling. This corresponds to
2882 the -j option and the jumpScroll resource.
2883 Enable Reverse Video (reversevideo)
2885 Enable (or disable) reverse-video. This corresponds to
2886 the -rv option and the reverseVideo resource.
2887 Enable Auto Wraparound (autowrap)
2889 Enable (or disable) auto-wraparound. This corresponds to
2890 the -aw option and the autoWrap resource.
2891 Enable Reverse Wraparound (reversewrap)
2893 Enable (or disable) reverse wraparound. This corresponds
2894 to the -rw option and the reverseWrap resource.
2895 Enable Auto Linefeed (autolinefeed)
2897 Enable (or disable) auto-linefeed. This is the VT102 NEL
2898 function, which causes the emulator to emit a linefeed
2899 after each carriage return. There is no corresponding
2900 command-line option or resource setting.
2901 Enable Application Cursor Keys (appcursor)
2903 Enable (or disable) application cursor keys. This corre‐
2904 sponds to the appcursorDefault resource. There is no
2905 corresponding command-line option.
2906 Enable Application Keypad (appkeypad)
2908 Enable (or disable) application keypad keys. This corre‐
2909 sponds to the appkeypadDefault resource. There is no
2910 corresponding command-line option.
2911 Scroll to Bottom on Key Press (scrollkey)
2913 Enable (or disable) scrolling to the bottom of the
2914 scrolling region on a keypress. This corresponds to the
2915 -sk option and the scrollKey resource.
2916 Scroll to Bottom on Tty Output (scrollttyoutput)
2918 Enable (or disable) scrolling to the bottom of the
2919 scrolling region on output to the terminal. This corre‐
2920 sponds to the -si option and the scrollTtyOutput
2921 resource.
2922 Allow 80/132 Column Switching (allow132)
2924 Enable (or disable) switching between 80 and 132 columns.
2925 This corresponds to the -132 option and the c132
2926 resource.
2927 Keep Selection (keepSelection)
2929 Tell xterm whether to disown the selection when it stops
2930 highlighting it, e.g., when an application modifies the
2931 display so that it no longer matches the text which has
2932 been highlighted. As long as xterm continues to own the
2933 selection, it can provide the corresponding text to other
2934 clients via cut/paste. This corresponds to the keepSe‐
2935 lection resource. There is no corresponding command-line
2936 option.
2937 Select to Clipboard (selectToClipboard)
2939 Tell xterm whether to use the PRIMARY or CLIPBOARD for
2940 SELECT tokens in the translations resource which maps
2941 keyboard and mouse actions to select/paste actions. This
2942 corresponds to the selectToClipboard resource. There is
2943 no corresponding command-line option.
2944 Enable Visual Bell (visualbell)
2946 Enable (or disable) visible bell (i.e., flashing) instead
2947 of an audible bell. This corresponds to the -vb option
2948 and the visualBell resource.
2949 Enable Bell Urgency (bellIsUrgent)
2951 Enable (or disable) Urgency window manager hint when Con‐
2952 trol-G is received. This corresponds to the bellIsUrgent
2953 resource.
2954 Enable Pop on Bell (poponbell)
2956 Enable (or disable) raising of the window when Control-G
2957 is received. This corresponds to the -pop option and the
2958 popOnBell resource.
2959 Enable Blinking Cursor (cursorblink)
2961 Enable (or disable) the blinking-cursor feature. This
2962 corresponds to the -bc option and the cursorBlink
2963 resource. There is also an escape sequence (see the doc‐
2964 ument Xterm Control Sequences). The menu entry and the
2965 escape sequence states are XOR'd: if both are enabled,
2966 the cursor will not blink, if only one is enabled, the
2967 cursor will blink.
2968 Enable Alternate Screen Switching (titeInhibit)
2970 Enable (or disable) switching between the normal and
2971 alternate screens. This corresponds to the titeInhibit
2972 resource. There is no corresponding command-line option.
2973 Enable Active Icon (activeicon)
2975 Enable (or disable) the active-icon feature. This corre‐
2976 sponds to the -ai option and the activeIcon resource.
2977 VT102/VT220 Commands:
2979 Do Soft Reset (softreset)
2981 Reset scroll regions. This can be convenient when some
2982 program has left the scroll regions set incorrectly
2983 (often a problem when using VMS or TOPS-20). This corre‐
2984 sponds to the VT220 DECSTR control sequence.
2985 Do Full Reset (hardreset)
2987 The full reset entry will clear the screen, reset tabs to
2988 every eight columns, and reset the terminal modes (such
2989 as wrap and smooth scroll) to their initial states just
2990 after xterm has finished processing the command line
2991 options. This corresponds to the VT102 RIS control
2992 sequence, with a few obvious differences. For example,
2993 your session is not disconnected as a real VT102 would
2994 do.
2995 Reset and Clear Saved Lines (clearsavedlines)
2997 Perform a full reset, and also clear the saved lines.
2998 Commands for setting the current screen:
3000 Show Tek Window (tekshow)
3002 When enabled, pops the Tektronix 4014 window up (makes it
3003 visible). When disabled, hides the Tektronix 4014 win‐
3004 dow.
3005 Switch to Tek Mode (tekmode)
3007 When enabled, pops the Tektronix 4014 window up if it is
3008 not already visible, and switches the input stream to
3009 that window. When disabled, hides the Tektronix 4014
3010 window and switches input back to the VTxxx window.
3011 Hide VT Window (vthide)
3013 When enabled, hides the VTxxx window, shows the Tektronix
3014 4014 window if it was not already visible and switches
3015 the input stream to that window. When disabled, shows
3016 the VTxxx window, and switches the input stream to that
3017 window.
3018 Show Alternate Screen (altscreen)
3020 When enabled, shows the alternate screen. When disabled,
3021 shows the normal screen. Note that the normal screen may
3022 have saved lines; the alternate screen does not.
3023 VT Fonts
3025 The fontMenu pops up when when the ``control'' key and pointer button
3026 three are pressed in a window. It sets the font used in the VT102 win‐
3027 dow, or modifies the way the font is specified or displayed. There are
3028 three sections.
3029 The first section allows you to select the font from a set of alterna‐
3031 tives:
3032 Default (fontdefault)
3034 Set the font to the default, i.e., that given by the
3035 *VT100.font resource.
3036 Unreadable (font1)
3038 Set the font to that given by the *VT100.font1 resource.
3039 Tiny (font2)
3041 Set the font to that given by the *VT100.font2 resource.
3042 Small (font3)
3044 Set the font to that given by the *VT100.font3 resource.
3045 Medium (font4)
3047 Set the font to that given by the *VT100.font4 resource.
3048 Large (font5)
3050 Set the font to that given by the *VT100.font5 resource.
3051 Huge (font6)
3053 Set the font to that given by the *VT100.font6 resource.
3054 Escape Sequence
3056 This allows you to set the font last specified by the Set
3057 Font escape sequence (see the document Xterm Control
3058 Sequences).
3059 Selection (fontsel)
3061 This allows you to set the font specified the current
3062 selection as a font name (if the PRIMARY selection is
3063 owned).
3064 The second section allows you to modify the way it is displayed:
3066 Line-Drawing Characters (font-linedrawing)
3068 When set, tells xterm to draw its own line-drawing char‐
3069 acters. Otherwise it relies on the font containing
3070 these. Compare to the forceBoxChars resource.
3071 Doublesized Characters (font-doublesize)
3073 When set, xterm may ask the font server to produce scaled
3074 versions of the normal font, for VT102 double-size char‐
3075 acters.
3076 The third section allows you to modify the way it is specified:
3078 TrueType Fonts (render-font)
3080 If the renderFont and corresponding resources were set,
3081 this is a further control whether xterm will actually use
3082 the Xft library calls to obtain a font.
3083 UTF-8 (utf8-mode)
3085 This controls whether xterm uses UTF-8 encoding of
3086 input/output. It is useful for temporarily switching
3087 xterm to display text from an application which does not
3088 follow the locale settings.
3089 TEK Options
3091 The tekMenu sets various modes in the Tektronix emulation, and is
3092 popped up when the ``control'' key and pointer button two are pressed
3093 in the Tektronix window. The current font size is checked in the modes
3094 section of the menu.
3095 Large Characters (tektextlarge)
3097 #2 Size Characters (tektext2)
3099 #3 Size Characters (tektext3)
3101 Small Characters (tektextsmall)
3103 Commands:
3105 PAGE (tekpage)
3107 Clear the Tektronix window.
3108 RESET (tekreset)
3110 COPY (tekcopy)
3112 Windows:
3114 Show VT Window (vtshow)
3116 Switch to VT Mode (vtmode)
3118 Hide Tek Window (tekhide)
3120
3122 X environments differ in their security consciousness. Most servers,
3123 run under xdm, are capable of using a ``magic cookie'' authorization
3124 scheme that can provide a reasonable level of security for many people.
3125 If your server is only using a host-based mechanism to control access
3126 to the server (see xhost(1)), then if you enable access for a host and
3127 other users are also permitted to run clients on that same host, it is
3128 possible that someone can run an application which uses the basic ser‐
3129 vices of the X protocol to snoop on your activities, potentially cap‐
3130 turing a transcript of everything you type at the keyboard. Any
3131 process which has access to your X display can manipulate it in ways
3132 that you might not anticipate, even redirecting your keyboard to itself
3133 and sending events to your application's windows. This is true even
3134 with the ``magic cookie'' authorization scheme. While the allowSendE‐
3135 vents provides some protection against rogue applications tampering
3136 with your programs, guarding against a snooper is harder.
3137 The possibility of an application spying on your keystrokes is of par‐
3139 ticular concern when you want to type in a password or other sensitive
3140 data. The best solution to this problem is to use a better authoriza‐
3141 tion mechanism than is provided by X. Given all of these caveats, a
3142 simple mechanism exists for protecting keyboard input in xterm.
3143 The xterm menu (see MENUS above) contains a Secure Keyboard entry
3145 which, when enabled, attempts to ensure that all keyboard input is
3146 directed only to xterm (using the GrabKeyboard protocol request). When
3147 an application prompts you for a password (or other sensitive data),
3148 you can enable Secure Keyboard using the menu, type in the data, and
3149 then disable Secure Keyboard using the menu again. This ensures that
3150 you know which window is accepting your keystrokes. It cannot ensure
3151 that there are no processes which have access to your X display that
3152 might be observing the keystrokes as well.
3153 Only one X client at a time can grab the keyboard, so when you attempt
3155 to enable Secure Keyboard it may fail. In this case, the bell will
3156 sound. If the Secure Keyboard succeeds, the foreground and background
3157 colors will be exchanged (as if you selected the Reverse Video entry in
3158 the Modes menu); they will be exchanged again when you exit secure
3159 mode. If the colors do not switch, then you should be very suspicious
3160 that you are being spoofed. If the application you are running dis‐
3161 plays a prompt before asking for the password, it is safest to enter
3162 secure mode before the prompt gets displayed, and to make sure that the
3163 prompt gets displayed correctly (in the new colors), to minimize the
3164 probability of spoofing. You can also bring up the menu again and make
3165 sure that a check mark appears next to the entry.
3166 Secure Keyboard mode will be disabled automatically if your xterm win‐
3168 dow becomes iconified (or otherwise unmapped), or if you start up a
3169 reparenting window manager (that places a title bar or other decoration
3170 around the window) while in Secure Keyboard mode. (This is a feature
3171 of the X protocol not easily overcome.) When this happens, the fore‐
3172 ground and background colors will be switched back and the bell will
3173 sound in warning.
3174
3176 Clicking the left pointer button twice in rapid succession (double-
3177 clicking) causes all characters of the same class (e.g., letters, white
3178 space, punctuation) to be selected as a ``word''. Since different peo‐
3179 ple have different preferences for what should be selected (for exam‐
3180 ple, should filenames be selected as a whole or only the separate sub‐
3181 names), the default mapping can be overridden through the use of the
3182 charClass (class CharClass) resource.
3183 This resource is a series of comma-separated of range:value pairs. The
3185 range is either a single number or low-high in the range of 0 to 65535,
3186 corresponding to the code for the character or characters to be set.
3187 The value is arbitrary, although the default table uses the character
3188 number of the first character occurring in the set. When not in UTF-8
3189 mode, only the first 256 bytes of this table will be used.
3190 The default table starts as follows - static int charClass[256] = { /∗
3192 NUL SOH STX ETX EOT ENQ ACK BEL */
3193 32, 1, 1, 1, 1, 1, 1, 1, /∗ BS HT NL VT NP
3194 CR SO SI */
3195 1, 32, 1, 1, 1, 1, 1, 1, /∗ DLE DC1 DC2 DC3 DC4
3196 NAK SYN ETB */
3197 1, 1, 1, 1, 1, 1, 1, 1, /∗ CAN EM SUB ESC FS
3198 GS RS US */
3199 1, 1, 1, 1, 1, 1, 1, 1, /∗ SP ! " # $
3200 % & ' */
3201 32, 33, 34, 35, 36, 37, 38, 39, /∗ ( ) * + ,
3202 - . / */
3203 40, 41, 42, 43, 44, 45, 46, 47, /∗ 0 1 2 3 4
3204 5 6 7 */
3205 48, 48, 48, 48, 48, 48, 48, 48, /∗ 8 9 : ; <
3206 = > ? */
3207 48, 48, 58, 59, 60, 61, 62, 63, /∗ @ A B C D
3208 E F G */
3209 64, 48, 48, 48, 48, 48, 48, 48, /∗ H I J K L
3210 M N O */
3211 48, 48, 48, 48, 48, 48, 48, 48, /∗ P Q R S T
3212 U V W */
3213 48, 48, 48, 48, 48, 48, 48, 48, /∗ X Y Z [ \
3214 ] ^ _ */
3215 48, 48, 48, 91, 92, 93, 94, 48, /∗ ` a b c d
3216 e f g */
3217 96, 48, 48, 48, 48, 48, 48, 48, /∗ h i j k l
3218 m n o */
3219 48, 48, 48, 48, 48, 48, 48, 48, /∗ p q r s t
3220 u v w */
3221 48, 48, 48, 48, 48, 48, 48, 48, /∗ x y z { |
3222 } ~ DEL */
3223 48, 48, 48, 123, 124, 125, 126, 1, /∗ x80 x81 x82 x83 IND
3224 NEL SSA ESA */
3225 1, 1, 1, 1, 1, 1, 1, 1, /∗ HTS HTJ VTS PLD PLU
3226 RI SS2 SS3 */
3227 1, 1, 1, 1, 1, 1, 1, 1, /∗ DCS PU1 PU2 STS CCH
3228 MW SPA EPA */
3229 1, 1, 1, 1, 1, 1, 1, 1, /∗ x98 x99 x9A CSI ST
3230 OSC PM APC */
3231 1, 1, 1, 1, 1, 1, 1, 1, /∗ - i c/ L ox
3232 Y- | So */
3233 160, 161, 162, 163, 164, 165, 166, 167, /∗ .. c0 ip << _
3234 R0 - */
3235 168, 169, 170, 171, 172, 173, 174, 175, /∗ o +- 2 3 '
3236 u q| . */
3237 176, 177, 178, 179, 180, 181, 182, 183, /∗ , 1 2 >> 1/4
3238 1/2 3/4 ? */
3239 184, 185, 186, 187, 188, 189, 190, 191, /∗ A` A' A^ A~ A:
3240 Ao AE C, */
3241 48, 48, 48, 48, 48, 48, 48, 48, /∗ E` E' E^ E: I`
3242 I' I^ I: */
3243 48, 48, 48, 48, 48, 48, 48, 48, /∗ D- N~ O` O' O^
3244 O~ O: X */
3245 48, 48, 48, 48, 48, 48, 48, 215, /∗ O/ U` U' U^ U:
3246 Y' P B */
3247 48, 48, 48, 48, 48, 48, 48, 48, /∗ a` a' a^ a~ a:
3248 ao ae c, */
3249 48, 48, 48, 48, 48, 48, 48, 48, /∗ e` e' e^ e: i`
3250 i' i^ i: */
3251 48, 48, 48, 48, 48, 48, 48, 48, /∗ d n~ o` o' o^
3252 o~ o: -: */
3253 48, 48, 48, 48, 48, 48, 48, 247, /∗ o/ u` u' u^ u:
3254 y' P y: */
3255 48, 48, 48, 48, 48, 48, 48, 48}; For example, the string
3256 ``33:48,37:48,45-47:48,38:48'' indicates that the exclamation mark,
3257 percent sign, dash, period, slash, and ampersand characters should be
3258 treated the same way as characters and numbers. This is useful for
3259 cutting and pasting electronic mailing addresses and filenames.
3260
3262 It is possible to rebind keys (or sequences of keys) to arbitrary
3263 strings for input, by changing the translations resources for the vt100
3264 or tek4014 widgets. Changing the translations resource for events
3265 other than key and button events is not expected, and will cause unpre‐
3266 dictable behavior. The following actions are provided for use within
3267 the vt100 or tek4014 translations resources:
3268 allow-send-events(on/off/toggle)
3270 This action set or toggles the allowSendEvents resource and is
3271 also invoked by the allowsends entry in mainMenu.
3272 alt-sends-escape()
3274 This action toggles the state of the eightBitInput resource.
3275 bell([percent])
3277 This action rings the keyboard bell at the specified percentage
3278 above or below the base volume.
3279 clear-saved-lines()
3281 This action does hard-reset() (see below) and also clears the
3282 history of lines saved off the top of the screen. It is also
3283 invoked from the clearsavedlines entry in vtMenu. The effect
3284 is identical to a hardware reset (RIS) control sequence.
3285 create-menu(m/v/f/t)
3287 This action creates one of the menus used by xterm, if it has
3288 not been previously created. The parameter values are the menu
3289 names: mainMenu, vtMenu, fontMenu, tekMenu, respectively.
3290 dabbrev-expand()
3292 Expands the word before cursor by searching in the preceding
3293 text on the screen and in the scrollback buffer for words
3294 starting with that abbreviation. Repeating dabbrev-expand()
3295 several times in sequence searches for an alternative expansion
3296 by looking farther back. Lack of more matches is signaled by a
3297 beep(). Attempts to expand an empty word (i.e., when cursor is
3298 preceded by a space) yield successively all previous words.
3299 Consecutive identical expansions are ignored. The word here is
3300 defined as a sequence of non-whitespace characters. This fea‐
3301 ture partially emulates the behavior of `dynamic abbreviation'
3302 expansion in Emacs (bound there to M-/). Here is a resource
3303 setting for xterm which will do the same thing: *VT100*transla‐
3304 tions: #override \n\ Meta <KeyPress> /:dabbrev-
3305 expand()
3306 deiconify()
3308 Changes the window state back to normal, if it was iconified.
3309 delete-is-del()
3311 This action toggles the state of the deleteIsDEL resource.
3312 dired-button()
3314 Handles a button event (other than press and release) by echo‐
3315 ing the event's position (i.e., character line and column) in
3316 the following format:
3317 ^X ESC G <line+' '> <col+' '>
3319 iconify()
3321 Iconifies the window.
3322 hard-reset()
3324 This action resets the scrolling region, tabs, window size, and
3325 cursor keys and clears the screen. It is also invoked from the
3326 hardreset entry in vtMenu.
3327 ignore()
3329 This action ignores the event but checks for special pointer
3330 position escape sequences.
3331 insert()
3333 This action inserts the character or string associated with the
3334 key that was pressed.
3335 insert-eight-bit()
3337 This action inserts an eight-bit (Meta) version of the charac‐
3338 ter or string associated with the key that was pressed. This
3339 only applies to single-byte values. The exact action depends
3340 on the value of the metaSendsEscape and the eightBitInput
3341 resources. The metaSendsEscape resource is tested first.
3342 The term "eight-bit" is misleading: xterm checks if the key's
3344 value is less than 128. If so, xterm adds 128 to the value,
3345 setting its eighth bit. Otherwise xterm sends an ESC byte
3346 before the key. In other applications' documentation, that is
3347 referred to as a "meta key".
3348 insert-selection(sourcename [, ...])
3350 This action inserts the string found in the selection or cut‐
3351 buffer indicated by sourcename. Sources are checked in the
3352 order given (case is significant) until one is found. Com‐
3353 monly-used selections include: PRIMARY, SECONDARY, and CLIP‐
3354 BOARD. Cut buffers are typically named CUT_BUFFER0 through
3355 CUT_BUFFER7.
3356 insert-seven-bit()
3358 This action is a synonym for insert() The term "seven-bit" is
3359 misleading: it only implies that xterm does not try to add 128
3360 to the key's value as in insert-eight-bit().
3361 interpret(control-sequence)
3363 Interpret the given control sequence locally, i.e., without
3364 passing it to the host. This works by inserting the control
3365 sequence at the front of the input buffer. Use "\" to escape
3366 octal digits in the string. Xt does not allow you to put a
3367 null character (i.e., "\000") in the string.
3368 keymap(name)
3370 This action dynamically defines a new translation table whose
3371 resource name is name with the suffix Keymap (case is signifi‐
3372 cant). The name None restores the original translation table.
3373 larger-vt-font()
3375 Set the font to the next larger one, based on the font dimen‐
3376 sions. See also set-vt-font().
3377 load-vt-fonts(name[,class])
3379 Load fontnames from the given subresource name and class. That
3380 is, load the "*VT100.name.font", resource as "*VT100.font" etc.
3381 If no name is given, the original set of fontnames is restored.
3382 Unlike set-vt-font(), this does not affect the escape- and
3384 select-fonts, since those are not based on resource values. It
3385 does affect the fonts loosely organized under the ``Default''
3386 menu entry: font, boldFont, wideFont and wideBoldFont.
3387 maximize()
3389 Resizes the window to fill the screen.
3390 meta-sends-escape()
3392 This action toggles the state of the metaSendsEscape resource.
3393 popup-menu(menuname)
3395 This action displays the specified popup menu. Valid names
3396 (case is significant) include: mainMenu, vtMenu, fontMenu, and
3397 tekMenu.
3398 print() This action prints the window and is also invoked by the print
3400 entry in mainMenu.
3401 print-redir()
3403 This action toggles the printerControlMode between 0 and 2.
3404 The corresponding popup menu entry is useful for switching the
3405 printer off if you happen to change your mind after deciding to
3406 print random binary files on the terminal.
3407 quit() This action sends a SIGHUP to the subprogram and exits. It is
3409 also invoked by the quit entry in mainMenu.
3410 redraw()
3412 This action redraws the window and is also invoked by the
3413 redraw entry in mainMenu.
3414 restore()
3416 Restores the window to the size before it was last maximized.
3417 scroll-back(count [,units [,mouse] ])
3419 This action scrolls the text window backward so that text that
3420 had previously scrolled off the top of the screen is now visi‐
3421 ble.
3422 The count argument indicates the number of units (which may be
3424 page, halfpage, pixel, or line) by which to scroll.
3425 An adjustment can be specified for these values by appending a
3427 "+" or "-" sign followed by a number, e.g., page-2 to specify 2
3428 lines less than a page.
3429 If the third parameter mouse is given, the action is ignored
3431 when mouse reporting is enabled.
3432 scroll-forw(count [,units [,mouse] ])
3434 This action is similar to scroll-back except that it scrolls in
3435 the other direction.
3436 secure()
3438 This action toggles the Secure Keyboard mode described in the
3439 section named SECURITY, and is invoked from the securekbd entry
3440 in mainMenu.
3441 select-cursor-end(destname [, ...])
3443 This action is similar to select-end except that it should be
3444 used with select-cursor-start.
3445 select-cursor-extend()
3447 This action is similar to select-extend except that it should
3448 be used with select-cursor-start.
3449 select-cursor-start()
3451 This action is similar to select-start except that it begins
3452 the selection at the current text cursor position.
3453 select-end(destname [, ...])
3455 This action puts the currently selected text into all of the
3456 selections or cutbuffers specified by destname.
3457 select-extend()
3459 This action tracks the pointer and extends the selection. It
3460 should only be bound to Motion events.
3461 select-set()
3463 This action stores text that corresponds to the current selec‐
3464 tion, without affecting the selection mode.
3465 select-start()
3467 This action begins text selection at the current pointer loca‐
3468 tion. See the section on POINTER USAGE for information on mak‐
3469 ing selections.
3470 send-signal(signame)
3472 This action sends the signal named by signame to the xterm sub‐
3473 process (the shell or program specified with the -e command
3474 line option) and is also invoked by the suspend, continue,
3475 interrupt, hangup, terminate, and kill entries in mainMenu.
3476 Allowable signal names are (case is not significant): tstp (if
3477 supported by the operating system), suspend (same as tstp),
3478 cont (if supported by the operating system), int, hup, term,
3479 quit, alrm, alarm (same as alrm) and kill.
3480 set-allow132(on/off/toggle)
3482 This action toggles the c132 resource and is also invoked from
3483 the allow132 entry in vtMenu.
3484 set-altscreen(on/off/toggle)
3486 This action toggles between the alternate and current screens.
3487 set-appcursor(on/off/toggle)
3489 This action toggles the handling Application Cursor Key mode
3490 and is also invoked by the appcursor entry in vtMenu.
3491 set-appkeypad(on/off/toggle)
3493 This action toggles the handling of Application Keypad mode and
3494 is also invoked by the appkeypad entry in vtMenu.
3495 set-autolinefeed(on/off/toggle)
3497 This action toggles automatic insertion of linefeeds and is
3498 also invoked by the autolinefeed entry in vtMenu.
3499 set-autowrap(on/off/toggle)
3501 This action toggles automatic wrapping of long lines and is
3502 also invoked by the autowrap entry in vtMenu.
3503 set-backarrow(on/off/toggle)
3505 This action toggles the backarrowKey resource and is also
3506 invoked from the backarrow key entry in vtMenu.
3507 set-bellIsUrgent(on/off/toggle)
3509 This action toggles the bellIsUrgent resource and is also
3510 invoked by the bellIsUrgent entry in vtMenu.
3511 set-cursorblink(on/off/toggle)
3513 This action toggles the cursorBlink resource and is also
3514 invoked from the cursorblink entry in vtMenu.
3515 set-cursesemul(on/off/toggle)
3517 This action toggles the curses resource and is also invoked
3518 from the cursesemul entry in vtMenu.
3519 set-font-doublesize(on/off/toggle)
3521 This action toggles the fontDoublesize resource and is also
3522 invoked by the font-doublesize entry in fontMenu.
3523 set-hp-function-keys(on/off/toggle)
3525 This action toggles the hpFunctionKeys resource and is also
3526 invoked by the hpFunctionKeys entry in mainMenu.
3527 set-jumpscroll(on/off/toggle)
3529 This action toggles the jumpscroll resource and is also invoked
3530 by the jumpscroll entry in vtMenu.
3531 set-font-linedrawing(on/off/toggle)
3533 This action toggles the xterm's state regarding whether the
3534 current font has line-drawing characters and whether it should
3535 draw them directly. It is also invoked by the font-linedrawing
3536 entry in fontMenu.
3537 set-keep-selection(on/off/toggle)
3539 This action toggles the keepSelection resource and is also
3540 invoked by the keepSelection entry in vtMenu.
3541 set-logging()
3543 This action toggles the state of the logging option.
3544 set-old-function-keys(on/off/toggle)
3546 This action toggles the state of legacy function keys and is
3547 also invoked by the oldFunctionKeys entry in mainMenu.
3548 set-marginbell(on/off/toggle)
3550 This action toggles the marginBell resource.
3551 set-num-lock()
3553 This action toggles the state of the numLock resource.
3554 set-pop-on-bell(on/off/toggle)
3556 This action toggles the popOnBell resource and is also invoked
3557 by the poponbell entry in vtMenu.
3558 set-render-font(on/off/toggle)
3560 This action toggles the renderFont resource and is also invoked
3561 by the render-font entry in fontMenu.
3562 set-reverse-video(on/off/toggle)
3564 This action toggles the reverseVideo resource and is also
3565 invoked by the reversevideo entry in vtMenu.
3566 set-reversewrap(on/off/toggle)
3568 This action toggles the reverseWrap resource and is also
3569 invoked by the reversewrap entry in vtMenu.
3570 set-scroll-on-key(on/off/toggle)
3572 This action toggles the scrollKey resource and is also invoked
3573 from the scrollkey entry in vtMenu.
3574 set-scroll-on-tty-output(on/off/toggle)
3576 This action toggles the scrollTtyOutput resource and is also
3577 invoked from the scrollttyoutput entry in vtMenu.
3578 set-scrollbar(on/off/toggle)
3580 This action toggles the scrollbar resource and is also invoked
3581 by the scrollbar entry in vtMenu.
3582 set-select(on/off/toggle)
3584 This action toggles the selectToClipboard resource and is also
3585 invoked by the selectToClipboard entry in vtMenu.
3586 set-sco-function-keys(on/off/toggle)
3588 This action toggles the scoFunctionKeys resource and is also
3589 invoked by the scoFunctionKeys entry in mainMenu.
3590 set-sun-function-keys(on/off/toggle)
3592 This action toggles the sunFunctionKeys resource and is also
3593 invoked by the sunFunctionKeys entry in mainMenu.
3594 set-sun-keyboard(on/off/toggle)
3596 This action toggles the sunKeyboard resource and is also
3597 invoked by the sunKeyboard entry in mainMenu.
3598 set-tek-text(large/2/3/small)
3600 This action sets font used in the Tektronix window to the value
3601 of the resources tektextlarge, tektext2, tektext3, and tek‐
3602 textsmall according to the argument. It is also invoked by the
3603 entries of the same names as the resources in tekMenu.
3604 set-terminal-type(type)
3606 This action directs output to either the vt or tek windows,
3607 according to the type string. It is also invoked by the tek‐
3608 mode entry in vtMenu and the vtmode entry in tekMenu.
3609 set-titeInhibit(on/off/toggle)
3611 This action toggles the titeInhibit resource, which controls
3612 switching between the alternate and current screens.
3613 set-toolbar(on/off/toggle)
3615 This action toggles the toolbar feature and is also invoked by
3616 the toolbar entry in mainMenu.
3617 set-utf8-mode(on/off/toggle)
3619 This action toggles the utf8 resource and is also invoked by
3620 the utf8-mode entry in fontMenu.
3621 set-utf8-title(on/off/toggle)
3623 This action toggles the utf8Title resource and is also invoked
3624 by the utf8-title entry in fontMenu.
3625 set-visibility(vt/tek,on/off/toggle)
3627 This action controls whether or not the vt or tek windows are
3628 visible. It is also invoked from the tekshow and vthide
3629 entries in vtMenu and the vtshow and tekhide entries in tek‐
3630 Menu.
3631 set-visual-bell(on/off/toggle)
3633 This action toggles the visualBell resource and is also invoked
3634 by the visualbell entry in vtMenu.
3635 set-vt-font(d/1/2/3/4/5/6/e/s [,normalfont [, boldfont]])
3637 This action sets the font or fonts currently being used in the
3638 VT102 window. The first argument is a single character that
3639 specifies the font to be used:
3640 d or D indicate the default font (the font initially used when
3642 xterm was started),
3643 1 through 6 indicate the fonts specified by the font1 through
3645 font6 resources,
3646 e or E indicate the normal and bold fonts that have been set
3648 through escape codes (or specified as the second and
3649 third action arguments, respectively), and
3650 s or S indicate the font selection (as made by programs such as
3652 xfontsel(1)) indicated by the second action argument.
3653 If xterm is configured to support wide characters, an addi‐
3655 tional two optional parameters are recognized for the e argu‐
3656 ment: wide font and wide bold font.
3657 smaller-vt-font()
3659 Set the font to the next smaller one, based on the font dimen‐
3660 sions. See also set-vt-font().
3661 soft-reset()
3663 This action resets the scrolling region and is also invoked
3664 from the softreset entry in vtMenu. The effect is identical to
3665 a soft reset (DECSTR) control sequence.
3666 spawn-new-terminal(params)
3668 Spawn a new xterm process. This is available on systems which
3669 have a modern version of the process filesystem, e.g., "/proc",
3670 which xterm can read.
3671 Use the "cwd" process entry, e.g., /proc/12345/cwd to obtain
3673 the working directory of the process which is running in the
3674 current xterm.
3675 On systems which have the "exe" process entry, e.g.,
3677 /proc/12345/exe, use this to obtain the actual executable.
3678 Otherwise, use the $PATH variable to find xterm.
3679 If parameters are given in the action, pass them to the new
3681 xterm process.
3682 start-extend()
3684 This action is similar to select-start except that the selec‐
3685 tion is extended to the current pointer location.
3686 start-cursor-extend()
3688 This action is similar to select-extend except that the selec‐
3689 tion is extended to the current text cursor position.
3690 string(string)
3692 This action inserts the specified text string as if it had been
3693 typed. Quotation is necessary if the string contains white‐
3694 space or non-alphanumeric characters. If the string argument
3695 begins with the characters ``0x'', it is interpreted as a hex
3696 character constant.
3697 tek-copy()
3699 This action copies the escape codes used to generate the cur‐
3700 rent window contents to a file in the current directory begin‐
3701 ning with the name COPY. It is also invoked from the tekcopy
3702 entry in tekMenu.
3703 tek-page()
3705 This action clears the Tektronix window and is also invoked by
3706 the tekpage entry in tekMenu.
3707 tek-reset()
3709 This action resets the Tektronix window and is also invoked by
3710 the tekreset entry in tekMenu.
3711 vi-button()
3713 Handles a button event (other than press and release) by echo‐
3714 ing a control sequence computed from the event's line number in
3715 the screen relative to the current line:
3716 ESC ^P
3718 or
3719 ESC ^N
3720 according to whether the event is before, or after the current
3722 line, respectively. The ^N (or ^P) is repeated once for each
3723 line that the event differs from the current line. The control
3724 sequence is omitted altogether if the button event is on the
3725 current line.
3726 visual-bell()
3728 This action flashes the window quickly.
3729 The Tektronix window also has the following action:
3731 gin-press(l/L/m/M/r/R)
3733 This action sends the indicated graphics input code.
3734 The default bindings in the VT102 window use the SELECT token, which is
3736 set by the selectToClipboard resource:
3737 Shift <KeyPress> Prior:scroll-back(1,halfpage) \n\
3738 Shift <KeyPress> Next:scroll-forw(1,halfpage) \n\
3739 Shift <KeyPress> Select:select-cursor-start() \
3740 select-cursor-end(SELECT, CUT_BUFFER0)
3741 \n\
3742 Shift <KeyPress> Insert:insert-selection(SELECT, CUT_BUFFER0)
3743 \n\
3744 <KeyPress> XF86Paste:insert-selection(SELECT, CUT_BUFFER0)
3745 \n\
3746 <KeyPress> SunPaste:insert-selection(SELECT, CUT_BUFFER0)
3747 \n\
3748 Shift~Ctrl <KeyPress> KP_Add:larger-vt-font() \n\
3749 Shift Ctrl <KeyPress> KP_Add:smaller-vt-font() \n\
3750 Shift <KeyPress> KP_Subtract:smaller-vt-font() \n\
3751 ~Meta <KeyPress>:insert-seven-bit() \n\
3752 Meta <KeyPress>:insert-eight-bit() \n\
3753 !Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
3754 !Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
3755 !Lock Ctrl @Num_Lock <Btn1Down>:popup-menu(mainMenu) \n\
3756 ! @Num_Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
3757 ~Meta <Btn1Down>:select-start() \n\
3758 ~Meta <Btn1Motion>:select-extend() \n\
3759 !Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
3760 !Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
3761 !Lock Ctrl @Num_Lock <Btn2Down>:popup-menu(vtMenu) \n\
3762 ! @Num_Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
3763 ~Ctrl ~Meta <Btn2Down>:ignore() \n\
3764 Meta <Btn2Down>:clear-saved-lines() \n\
3765 ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0)
3766 \n\
3767 !Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
3768 !Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
3769 !Lock Ctrl @Num_Lock <Btn3Down>:popup-menu(fontMenu) \n\
3770 ! @Num_Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
3771 ~Ctrl ~Meta <Btn3Down>:start-extend() \n\
3772 ~Meta <Btn3Motion>:select-extend() \n\
3773 Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
3774 Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
3775 Lock @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
3776 @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
3777 <Btn4Down>:scroll-back(5,line,m) \n\
3778 Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
3779 Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
3780 Lock @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
3781 @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
3782 <Btn5Down>:scroll-forw(5,line,m) \n\
3783 <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n\
3784 <BtnDown>:ignore()
3785 The default bindings for the scrollbar widget are separate from the
3787 VT100 widget:
3788 <Btn5Down>: StartScroll(Forward) \n\
3789 <Btn1Down>: StartScroll(Forward) \n\
3790 <Btn2Down>: StartScroll(Continuous) MoveThumb()
3791 NotifyThumb() \n\
3792 <Btn3Down>: StartScroll(Backward) \n\
3793 <Btn4Down>: StartScroll(Backward) \n\
3794 <Btn2Motion>: MoveThumb() NotifyThumb() \n\
3795 <BtnUp>: NotifyScroll(Proportional) End‐
3796 Scroll()
3797 The default bindings in the Tektronix window are:
3799 ~Meta<KeyPress>: insert-seven-bit() \n\
3800 Meta<KeyPress>: insert-eight-bit() \n\
3801 !Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
3802 !Lock Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
3803 !Lock Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
3804 !Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
3805 !Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
3806 !Lock Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
3807 !Lock Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
3808 !Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
3809 Shift ~Meta<Btn1Down>: gin-press(L) \n\
3810 ~Meta<Btn1Down>: gin-press(l) \n\
3811 Shift ~Meta<Btn2Down>: gin-press(M) \n\
3812 ~Meta<Btn2Down>: gin-press(m) \n\
3813 Shift ~Meta<Btn3Down>: gin-press(R) \n\
3814 ~Meta<Btn3Down>: gin-press(r)
3815 Here is an example which uses shifted select/paste to copy to the clip‐
3817 board, and unshifted select/paste for the primary selection. In each
3818 case, a (different) cut buffer is also a target or source of the
3819 select/paste operation. It is important to remember however, that cut
3820 buffers store data in ISO-8859-1 encoding, while selections can store
3821 data in a variety of formats and encodings. While xterm owns the
3822 selection, it highlights it. When it loses the selection, it removes
3823 the corresponding highlight. But you can still paste from the corre‐
3824 sponding cut buffer. *VT100*translations: #override \n\
3825 ~Shift~Ctrl<Btn2Up>: insert-selection(PRIMARY, CUT_BUFFER0) \n\
3826 Shift~Ctrl<Btn2Up>: insert-selection(CLIPBOARD, CUT_BUFFER1) \n\
3827 ~Shift<BtnUp>: select-end(PRIMARY, CUT_BUFFER0) \n\
3828 Shift<BtnUp>: select-end(CLIPBOARD, CUT_BUFFER1)
3829 Below is a sample how of the keymap() action is used to add special
3831 keys for entering commonly-typed works: *VT100.Translations: #override
3832 <Key>F13: keymap(dbx) *VT100.dbxKeymap.translations: \
3833 <Key>F14: keymap(None) \n\ <Key>F17: string("next")
3834 string(0x0d) \n\ <Key>F18: string("step") string(0x0d) \n\
3835 <Key>F19: string("continue") string(0x0d) \n\
3836 <Key>F20: string("print ") insert-selection(PRIMARY, CUT_BUFFER0)
3837 Some people prefer using the left pointer button for dragging the
3839 scrollbar thumb. That can be setup by altering the translations
3840 resource, e.g., *VT100.scrollbar.translations:#override \n\
3841 <Btn5Down>:StartScroll(Forward) \n\
3842 <Btn1Down>:StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
3843 <Btn4Down>:StartScroll(Backward) \n\ <Btn1Motion>:MoveThumb()
3844 NotifyThumb() \n\ <BtnUp>: NotifyScroll(Proportional) EndScroll()
3845
3847 The Xterm Control Sequences document lists the control sequences which
3848 an application can send xterm to make it perform various operations.
3849 Most of these operations are standardized, from either the DEC or Tek‐
3850 tronix terminals, or from more widely used standards such as ISO-6429.
3851
3853 Xterm sets several environment variables:
3854 DISPLAY
3856 is the display name, pointing to the X server (see DISPLAY NAMES
3857 in X(7)).
3858 TERM is set according to the termcap (or terminfo) entry which it is
3860 using as a reference.
3861 WINDOWID
3863 is set to the X window id number of the xterm window.
3864 XTERM_LOCALE
3866 shows the locale which was used by xterm on startup. Some shell
3867 initialization scripts may set a different locale.
3868 XTERM_SHELL
3870 is set to the pathname of the program which is invoked. Usually
3871 that is a shell program, e.g., /bin/sh. Since it is not necessar‐
3872 ily a shell program however, it is distinct from ``SHELL''.
3873 XTERM_VERSION
3875 is set to the string displayed by the -version option. That is
3876 normally an identifier for the X Window libraries used to build
3877 xterm, followed by xterm's patch number in parenthesis. The patch
3878 number is also part of the response to a Secondary Device
3879 Attributes (DA) control sequence (see Xterm Control Sequences).
3880 Depending on your system configuration, xterm may also set the follow‐
3882 ing:
3883 COLUMNS
3885 the width of the xterm in characters (cf: "stty columns").
3886 HOME when xterm is configured to update utmp.
3888 LINES
3890 the height of the xterm in characters (cf: "stty rows").
3891 LOGNAME
3893 when xterm is configured to update utmp.
3894 SHELL
3896 when xterm is configured to update utmp. It is also set if you
3897 provide the shell name as the optional parameter.
3898 TERMCAP
3900 the contents of the termcap entry corresponding to $TERM, with
3901 lines and columns values substituted for the actual size window
3902 you have created.
3903 TERMINFO
3905 may be defined to a nonstandard location in the configure script.
3906
3908 The actual pathnames given may differ on your system.
3909 /var/run/utmp
3911 the system logfile, which records user logins.
3912 /var/log/wtmp
3914 the system logfile, which records user logins and logouts.
3915 /usr/share/X11/app-defaults/XTerm
3917 the xterm default application resources.
3918 /usr/share/X11/app-defaults/XTerm-color
3920 the xterm color application resources. If your display supports
3921 color, use this
3922 *customization: -color
3923 in your .Xdefaults file to automatically use this resource file
3924 rather than /usr/share/X11/app-defaults/XTerm. If you do not do
3925 this, xterm uses its compiled-in default resource settings for
3926 colors.
3927
3929 Most of the fatal error messages from xterm use the following format:
3930 xterm: Error XXX, errno YYY: ZZZ
3931 The XXX codes (which are used by xterm as its exit-code) are listed
3932 below, with a brief explanation.
3933 1 is used for miscellaneous errors, usually accompanied by a spe‐
3935 cific message,
3936 11 ERROR_FIONBIO
3938 main: ioctl() failed on FIONBIO
3939 12 ERROR_F_GETFL
3941 main: ioctl() failed on F_GETFL
3942 13 ERROR_F_SETFL
3944 main: ioctl() failed on F_SETFL
3945 14 ERROR_OPDEVTTY
3947 spawn: open() failed on /dev/tty
3948 15 ERROR_TIOCGETP
3950 spawn: ioctl() failed on TIOCGETP
3951 17 ERROR_PTSNAME
3953 spawn: ptsname() failed
3954 18 ERROR_OPPTSNAME
3956 spawn: open() failed on ptsname
3957 19 ERROR_PTEM
3959 spawn: ioctl() failed on I_PUSH/"ptem"
3960 20 ERROR_CONSEM
3962 spawn: ioctl() failed on I_PUSH/"consem"
3963 21 ERROR_LDTERM
3965 spawn: ioctl() failed on I_PUSH/"ldterm"
3966 22 ERROR_TTCOMPAT
3968 spawn: ioctl() failed on I_PUSH/"ttcompat"
3969 23 ERROR_TIOCSETP
3971 spawn: ioctl() failed on TIOCSETP
3972 24 ERROR_TIOCSETC
3974 spawn: ioctl() failed on TIOCSETC
3975 25 ERROR_TIOCSETD
3977 spawn: ioctl() failed on TIOCSETD
3978 26 ERROR_TIOCSLTC
3980 spawn: ioctl() failed on TIOCSLTC
3981 27 ERROR_TIOCLSET
3983 spawn: ioctl() failed on TIOCLSET
3984 28 ERROR_INIGROUPS
3986 spawn: initgroups() failed
3987 29 ERROR_FORK
3989 spawn: fork() failed
3990 30 ERROR_EXEC
3992 spawn: exec() failed
3993 32 ERROR_PTYS
3995 get_pty: not enough ptys
3996 34 ERROR_PTY_EXEC
3998 waiting for initial map
3999 35 ERROR_SETUID
4001 spawn: setuid() failed
4002 36 ERROR_INIT
4004 spawn: can't initialize window
4005 46 ERROR_TIOCKSET
4007 spawn: ioctl() failed on TIOCKSET
4008 47 ERROR_TIOCKSETC
4010 spawn: ioctl() failed on TIOCKSETC
4011 48 ERROR_SPREALLOC
4013 spawn: realloc of ttydev failed
4014 49 ERROR_LUMALLOC
4016 luit: command-line malloc failed
4017 50 ERROR_SELECT
4019 in_put: select() failed
4020 54 ERROR_VINIT
4022 VTInit: can't initialize window
4023 57 ERROR_KMMALLOC1
4025 HandleKeymapChange: malloc failed
4026 60 ERROR_TSELECT
4028 Tinput: select() failed
4029 64 ERROR_TINIT
4031 TekInit: can't initialize window
4032 71 ERROR_BMALLOC2
4034 SaltTextAway: malloc() failed
4035 80 ERROR_LOGEXEC
4037 StartLog: exec() failed
4038 83 ERROR_XERROR
4040 xerror: XError event
4041 84 ERROR_XIOERROR
4043 xioerror: X I/O error
4044 90 ERROR_SCALLOC
4046 Alloc: calloc() failed on base
4047 91 ERROR_SCALLOC2
4049 Alloc: calloc() failed on rows
4050 92 ERROR_SREALLOC
4052 ScreenResize: realloc() failed on alt base
4053 96 ERROR_RESIZE
4055 ScreenResize: malloc() or realloc() failed
4056 102 ERROR_SAVE_PTR
4058 ScrnPointers: malloc/realloc() failed
4059 110 ERROR_SBRALLOC
4061 ScrollBarOn: realloc() failed on base
4062 111 ERROR_SBRALLOC2
4064 ScrollBarOn: realloc() failed on rows
4065 121 ERROR_MMALLOC
4067 my_memmove: malloc/realloc failed
4068
4070 Large pastes do not work on some systems. This is not a bug in xterm;
4071 it is a bug in the pseudo terminal driver of those systems. xterm
4072 feeds large pastes to the pty only as fast as the pty will accept data,
4073 but some pty drivers do not return enough information to know if the
4074 write has succeeded.
4075 Many of the options are not resettable after xterm starts.
4077 This program still needs to be rewritten. It should be split into very
4079 modular sections, with the various emulators being completely separate
4080 widgets that do not know about each other. Ideally, you'd like to be
4081 able to pick and choose emulator widgets and stick them into a single
4082 control widget.
4083 There needs to be a dialog box to allow entry of the Tek COPY file
4085 name.
4086
4088 resize(1), luit(1), X(7), pty(4), tty(4)
4089 Xterm Control Sequences (this is the file ctlseqs.ms).
4090 http://invisible-island.net/xterm/xterm.html
4092 http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
4093
4095 Far too many people, including:
4096 Loretta Guarino Reid (DEC-UEG-WSL), Joel McCormack (DEC-UEG-WSL), Terry
4098 Weissman (DEC-UEG-WSL), Edward Moy (Berkeley), Ralph R. Swick (MIT-
4099 Athena), Mark Vandevoorde (MIT-Athena), Bob McNamara (DEC-MAD), Jim
4100 Gettys (MIT-Athena), Bob Scheifler (MIT X Consortium), Doug Mink (SAO),
4101 Steve Pitschke (Stellar), Ron Newman (MIT-Athena), Jim Fulton (MIT X
4102 Consortium), Dave Serisky (HP), Jonathan Kamens (MIT-Athena), Jason
4103 Bacon, Stephen P. Wall, David Wexelblat, and Thomas Dickey (invisible-
4104 island.net).
4105 X Window System XTERM(1)