1XTERM(1) General Commands Manual XTERM(1)
2
3
4
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
20 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
27 Although both windows may be displayed at the same time, one of them is
28 considered the “active” window for receiving keyboard input and termi‐
29 nal output. This is the window that contains the text cursor. The
30 active window can be chosen through escape sequences, the “VT Options”
31 menu in the VTxxx window, and the “Tek Options” menu in the 4014 win‐
32 dow.
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,” “ansi” and “dumb.” xterm automatically searches the
41 termcap file in this order for these entries and then sets the “TERM”
42 and the “TERMCAP” environment variables. You may also use “vt220,”
43 but must set the terminal emulation level with the decTerminalID
44 resource. (The “TERMCAP” environment variable is not set if xterm is
45 linked against a terminfo library, since the requisite information is
46 not provided by the termcap emulation of terminfo libraries).
47
48 Many of the special xterm features may be modified under program con‐
49 trol through a set of escape sequences different from the standard
50 VT102 escape sequences. (See the Xterm Control Sequences document.)
51
52 The Tektronix 4014 emulation is also fairly good. It supports 12-bit
53 graphics addressing, scaled to the window size. Four different font
54 sizes and five different lines types are supported. There is no write-
55 through or defocused mode support. The Tektronix text and graphics
56 commands are recorded internally by xterm and may be written to a file
57 by sending the COPY escape sequence (or through the Tektronix menu; see
58 below). The name of the file will be “COPYyyyy-MM-dd.hh:mm:ss”, where
59 yyyy, MM, dd, hh, mm and ss are the year, month, day, hour, minute and
60 second when the COPY was performed (the file is created in the direc‐
61 tory xterm is started in, or the home directory for a login xterm).
62
63 Not all of the features described in this manual are necessarily avail‐
64 able in this version of xterm. Some (e.g., the non-VT220 extensions)
65 are available only if they were compiled in, though the most commonly-
66 used are in the default configuration.
67
69 Xterm automatically highlights the text cursor when the pointer enters
70 the window (selected) and unhighlights it when the pointer leaves the
71 window (unselected). If the window is the focus window, then the text
72 cursor is highlighted no matter where the pointer is.
73
74 In VT102 mode, there are escape sequences to activate and deactivate an
75 alternate screen buffer, which is the same size as the display area of
76 the window. When activated, the current screen is saved and replaced
77 with the alternate screen. Saving of lines scrolled off the top of the
78 window is disabled until the normal screen is restored. The termcap(5)
79 entry for xterm allows the visual editor vi(1) to switch to the alter‐
80 nate screen for editing and to restore the screen on exit. A popup
81 menu entry makes it simple to switch between the normal and alternate
82 screens for cut and paste.
83
84 In either VT102 or Tektronix mode, there are escape sequences to change
85 the name of the windows. Additionally, in VT102 mode, xterm implements
86 the window-manipulation control sequences from dtterm, such as resizing
87 the window, setting its location on the screen.
88
89 Xterm allows character-based applications to receive mouse events (cur‐
90 rently button-press and release events, and button-motion events) as
91 keyboard control sequences. See Xterm Control Sequences for details.
92
94 The xterm terminal emulator accepts the standard X Toolkit command line
95 options as well as many application-specific options. If the option
96 begins with a `+' instead of a `-', the option is restored to its
97 default value. The -version and -help options are interpreted even if
98 xterm cannot open the display, and are useful for testing and configu‐
99 ration scripts:
100
101 -version
102 This causes xterm to print a version number to the standard
103 output.
104
105 -help This causes xterm to print out a verbose message describing its
106 options, one per line. The message is written to the standard
107 output. Xterm generates this message, sorting it and noting
108 whether a "-option" or a "+option" turns the feature on or off,
109 since some features historically have been one or the other.
110 Xterm generates a concise help message (multiple options per
111 line) when an unknown option is used, e.g.,
112 xterm -z
113
114 If the logic for a particular option such as logging is not
115 compiled into xterm, the help text for that option also is not
116 displayed by the -help option.
117
118 One parameter (after all options) may be given. That overrides xterm's
119 built-in choice of shell program. Normally xterm checks the SHELL
120 variable. If that is not set, xterm tries to use the shell program
121 specified in the password file. If that is not set, xterm uses
122 /bin/sh. If the parameter names an executable file, xterm uses that
123 instead. The parameter must be an absolute path, or name a file found
124 on the user's PATH (and thereby construct an absolute path). The -e
125 option cannot be used with this parameter since it uses all parameters
126 following the option.
127
128 The other options are used to control the appearance and behavior. Not
129 all options are necessarily configured into your copy of xterm:
130
131 -132 Normally, the VT102 DECCOLM escape sequence that switches
132 between 80 and 132 column mode is ignored. This option causes
133 the DECCOLM escape sequence to be recognized, and the xterm
134 window will resize appropriately.
135
136 -ah This option indicates that xterm should always highlight the
137 text cursor. By default, xterm will display a hollow text cur‐
138 sor whenever the focus is lost or the pointer leaves the win‐
139 dow.
140
141 +ah This option indicates that xterm should do text cursor high‐
142 lighting based on focus.
143
144 -ai This option disables active icon support if that feature was
145 compiled into xterm. This is equivalent to setting the vt100
146 resource activeIcon to “false”.
147
148 +ai This option enables active icon support if that feature was
149 compiled into xterm. This is equivalent to setting the vt100
150 resource activeIcon to “true”.
151
152 -aw This option indicates that auto-wraparound should be allowed.
153 This allows the cursor to automatically wrap to the beginning
154 of the next line when it is at the rightmost position of a line
155 and text is output.
156
157 +aw This option indicates that auto-wraparound should not be
158 allowed.
159
160 -b number
161 This option specifies the size of the inner border (the dis‐
162 tance between the outer edge of the characters and the window
163 border) in pixels. That is the vt100 internalBorder resource.
164 The default is 2.
165
166 +bc turn off text cursor blinking. This overrides the cursorBlink
167 resource.
168
169 -bc turn on text cursor blinking. This overrides the cursorBlink
170 resource.
171
172 -bcf milliseconds
173 set the amount of time text cursor is off when blinking via the
174 cursorOffTime resource.
175
176 -bcn milliseconds
177 set the amount of time text cursor is on when blinking via the
178 cursorOffTime resource.
179
180 -bdc Set the vt100 resource colorBDMode to “false”, disabling the
181 display of characters with bold attribute as color
182
183 +bdc Set the vt100 resource colorBDMode to “true”, enabling the dis‐
184 play of characters with bold attribute as color rather than
185 bold
186
187 -cb Set the vt100 resource cutToBeginningOfLine to “false”.
188
189 +cb Set the vt100 resource cutToBeginningOfLine to “true”.
190
191 -cc characterclassrange:value[,...]
192 This sets classes indicated by the given ranges for using in
193 selecting by words. See the section specifying character
194 classes. and discussion of the charClass resource.
195
196 -cjk_width
197 Set the cjkWidth resource to “true”. When turned on, charac‐
198 ters with East Asian Ambiguous (A) category in UTR 11 have a
199 column width of 2. Otherwise, they have a column width of 1.
200 This may be useful for some legacy CJK text terminal-based pro‐
201 grams assuming box drawings and others to have a column width
202 of 2. It also should be turned on when you specify a TrueType
203 CJK double-width (bi-width/monospace) font either with -fa at
204 the command line or faceName resource. The default is “false”
205
206 +cjk_width
207 Reset the cjkWidth resource.
208
209 -class string
210 This option allows you to override xterm's resource class.
211 Normally it is “XTerm”, but can be set to another class such as
212 “UXTerm” to override selected resources.
213
214 -cm This option disables recognition of ANSI color-change escape
215 sequences. It sets the colorMode resource to “false”.
216
217 +cm This option enables recognition of ANSI color-change escape
218 sequences. This is the same as the vt100 resource colorMode.
219
220 -cn This option indicates that newlines should not be cut in line-
221 mode selections. It sets the cutNewline resource to “false”.
222
223 +cn This option indicates that newlines should be cut in line-mode
224 selections. It sets the cutNewline resource to “true”.
225
226 -cr color
227 This option specifies the color to use for text cursor. The
228 default is to use the same foreground color that is used for
229 text. It sets the cursorColor resource according to the param‐
230 eter.
231
232 -cu This option indicates that xterm should work around a bug in
233 the more(1) program that causes it to incorrectly display lines
234 that are exactly the width of the window and are followed by a
235 line beginning with a tab (the leading tabs are not displayed).
236 This option is so named because it was originally thought to be
237 a bug in the curses(3x) cursor motion package.
238
239 +cu This option indicates that xterm should not work around the
240 more(1) bug mentioned above.
241
242 -dc This option disables the escape sequence to change dynamic col‐
243 ors: the vt100 foreground and background colors, its text cur‐
244 sor color, the pointer cursor foreground and background colors,
245 the Tektronix emulator foreground and background colors, its
246 text cursor color and highlight color. The option sets the
247 dynamicColors option to “false”.
248
249 +dc This option enables the escape sequence to change dynamic col‐
250 ors. The option sets the dynamicColors option to “true”.
251
252 -e program [ arguments ... ]
253 This option specifies the program (and its command line argu‐
254 ments) to be run in the xterm window. It also sets the window
255 title and icon name to be the basename of the program being
256 executed if neither -T nor -n are given on the command line.
257 This must be the last option on the command line.
258
259 -en encoding
260 This option determines the encoding on which xterm runs. It
261 sets the locale resource. Encodings other than UTF-8 are sup‐
262 ported by using luit. The -lc option should be used instead of
263 -en for systems with locale support.
264
265 -fb font
266 This option specifies a font to be used when displaying bold
267 text. It sets the boldFont resource.
268
269 This font must be the same height and width as the normal font,
270 otherwise it is ignored. If only one of the normal or bold
271 fonts is specified, it will be used as the normal font and the
272 bold font will be produced by overstriking this font.
273
274 See also the discussion of boldMode and alwaysBoldMode
275 resources.
276
277 -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.
283
284 See also the renderFont resource, which combines with this to
285 determine whether FreeType fonts are initially active.
286
287 -fbb This option indicates that xterm should compare normal and bold
288 fonts bounding boxes to ensure they are compatible. It sets
289 the freeBoldBox resource to “false”.
290
291 +fbb This option indicates that xterm should not compare normal and
292 bold fonts bounding boxes to ensure they are compatible. It
293 sets the freeBoldBox resource to “true”.
294
295 -fbx This option indicates that xterm should not assume that the
296 normal and bold fonts have VT100 line-drawing characters. If
297 any are missing, xterm will draw the characters directly. It
298 sets the forceBoxChars resource to “false”.
299
300 +fbx This option indicates that xterm should assume that the normal
301 and bold fonts have VT100 line-drawing characters. It sets the
302 forceBoxChars resource to “true”.
303
304 -fd pattern
305 This option sets the pattern for double-width fonts selected
306 from the FreeType library if support for that library was com‐
307 piled into xterm. This corresponds to the faceNameDoublesize
308 resource.
309
310 -fi font
311 This option sets the font for active icons if that feature was
312 compiled into xterm.
313
314 See also the discussion of the iconFont resource.
315
316 -fs size
317 This option sets the pointsize for fonts selected from the
318 FreeType library if support for that library was compiled into
319 xterm. This corresponds to the faceSize resource.
320
321 -fw font
322 This option specifies the font to be used for displaying wide
323 text. By default, it will attempt to use a font twice as wide
324 as the font that will be used to draw normal text. If no dou‐
325 ble-width font is found, it will improvise, by stretching the
326 normal font. This corresponds to the wideFont resource.
327
328 -fwb font
329 This option specifies the font to be used for displaying bold
330 wide text. By default, it will attempt to use a font twice as
331 wide as the font that will be used to draw bold text. If no
332 double-width font is found, it will improvise, by stretching
333 the bold font. This corresponds to the wideBoldFont resource.
334
335 -fx font
336 This option specifies the font to be used for displaying the
337 preedit string in the "OverTheSpot" input method.
338
339 See also the discussion of the ximFont resource.
340
341 -hc color
342 (see -selbg).
343
344 -hf This option indicates that HP Function Key escape codes should
345 be generated for function keys. It sets the hpFunctionKeys
346 resource to “true”.
347
348 +hf This option indicates that HP Function Key escape codes should
349 not be generated for function keys. It sets the hpFunctionKeys
350 resource to “false”.
351
352 -hm Tells xterm to use highlightTextColor and highlightColor to
353 override the reversed foreground/background colors in a selec‐
354 tion. It sets the highlightColorMode resource to “true”.
355
356 +hm Tells xterm not to use highlightTextColor and highlightColor to
357 override the reversed foreground/background colors in a selec‐
358 tion. It sets the highlightColorMode resource to “false”.
359
360 -hold Turn on the hold resource, i.e., xterm will not immediately
361 destroy its window when the shell command completes. It will
362 wait until you use the window manager to destroy/kill the win‐
363 dow, or if you use the menu entries that send a signal, e.g.,
364 HUP or KILL.
365
366 +hold Turn off the hold resource, i.e., xterm will immediately
367 destroy its window when the shell command completes.
368
369 -ie Turn on the ptyInitialErase resource, i.e., use the pseudo-ter‐
370 minal's sense of the stty erase value.
371
372 +ie Turn off the ptyInitialErase resource, i.e., set the stty erase
373 value using the kb string from the termcap entry as a refer‐
374 ence, if available.
375
376 -im Turn on the useInsertMode resource, which forces use of insert
377 mode by adding appropriate entries to the TERMCAP environment
378 variable.
379
380 +im Turn off the useInsertMode resource.
381
382 -into windowId
383 Given an X window identifier (a decimal integer), xterm will
384 reparent its top-level shell widget to that window. This is
385 used to embed xterm within other applications.
386
387 -j This option indicates that xterm should do jump scrolling. It
388 corresponds to the jumpScroll resource. Normally, text is
389 scrolled one line at a time; this option allows xterm to move
390 multiple lines at a time so that it does not fall as far
391 behind. Its use is strongly recommended since it makes xterm
392 much faster when scanning through large amounts of text. The
393 VT100 escape sequences for enabling and disabling smooth scroll
394 as well as the “VT Options” menu can be used to turn this fea‐
395 ture on or off.
396
397 +j This option indicates that xterm should not do jump scrolling.
398
399 -k8 This option sets the allowC1Printable resource. When
400 allowC1Printable is set, xterm overrides the mapping of C1 con‐
401 trol characters (code 128-159) to treat them as printable.
402
403 +k8 This option resets the allowC1Printable resource.
404
405 -kt keyboardtype
406 This option sets the keyboardType resource. Possible values
407 include: “unknown”, “default”, “hp”, “sco”, “sun”, “tcap” and
408 “vt220”.
409
410 The value “unknown”, causes the corresponding resource to be
411 ignored.
412
413 The value “default”, suppresses the associated resources
414 hpFunctionKeys, scoFunctionKeys, sunFunctionKeys, tcapFunction‐
415 Keys and sunKeyboard, using the Sun/PC keyboard layout.
416
417 -l Turn logging on. Normally logging is not supported, due to
418 security concerns. Some versions of xterm may have logging
419 enabled. The logfile is written to the directory from which
420 xterm is invoked. The filename is generated, of the form
421
422 XtermLog.XXXXXX
423
424 or
425
426 Xterm.log.hostname.yyyy.mm.dd.hh.mm.ss.XXXXXX
427
428 depending on how xterm was built.
429
430 +l Turn logging off.
431
432 -lc Turn on support of various encodings according to the users'
433 locale setting, i.e., LC_ALL, LC_CTYPE, or LANG environment
434 variables. This is achieved by turning on UTF-8 mode and by
435 invoking luit for conversion between locale encodings and
436 UTF-8. (luit is not invoked in UTF-8 locales.) This corre‐
437 sponds to the locale resource.
438
439 The actual list of encodings which are supported is determined
440 by luit. Consult the luit manual page for further details.
441
442 See also the discussion of the -u8 option which supports UTF-8
443 locales.
444
445 +lc Turn off support of automatic selection of locale encodings.
446 Conventional 8bit mode or, in UTF-8 locales or with -u8 option,
447 UTF-8 mode will be used.
448
449 -lcc path
450 File name for the encoding converter from/to locale encodings
451 and UTF-8 which is used with -lc option or locale resource.
452 This corresponds to the localeFilter resource.
453
454 -leftbar
455 Force scrollbar to the left side of VT100 screen. This is the
456 default, unless you have set the rightScrollBar resource.
457
458 -lf filename
459 Specify the log-filename. See the -l option.
460
461 -ls This option indicates that the shell that is started in the
462 xterm window will be a login shell (i.e., the first character
463 of argv[0] will be a dash, indicating to the shell that it
464 should read the user's .login or .profile).
465
466 The -ls flag and the loginShell resource are ignored if -e is
467 also given, because xterm does not know how to make the shell
468 start the given command after whatever it does when it is a
469 login shell - the user's shell of choice need not be a Bourne
470 shell after all. Also, xterm -e is supposed to provide a con‐
471 sistent functionality for other applications that need to start
472 text-mode programs in a window, and if loginShell were not
473 ignored, the result of ~/.profile might interfere with that.
474
475 If you do want the effect of -ls and -e simultaneously, you may
476 get away with something like
477 xterm -e /bin/bash -l -c "my command here"
478
479 Finally, -ls is not completely ignored, because xterm -ls -e
480 does write a /etc/wtmp entry (if configured to do so), whereas
481 xterm -e does not.
482
483 -maximized
484 This option indicates that xterm should ask the window manager
485 to maximize its layout on startup. This corresponds to the
486 maximized resource.
487
488 Maximizing is not the reverse of iconifying; it is possible to
489 do both with certain window managers.
490
491 +maximized
492 This option indicates that xterm should ask the window manager
493 to maximize its layout on startup.
494
495 +ls This option indicates that the shell that is started should not
496 be a login shell (i.e., it will be a normal “subshell”).
497
498 -mb This option indicates that xterm should ring a margin bell when
499 the user types near the right end of a line.
500
501 +mb This option indicates that margin bell should not be rung.
502
503 -mc milliseconds
504 This option specifies the maximum time between multi-click
505 selections.
506
507 -mesg Turn off the messages resource, i.e., disallow write access to
508 the terminal.
509
510 +mesg Turn on the messages resource, i.e., allow write access to the
511 terminal.
512
513 -mk_width
514 Set the mkWidth resource to “true”. This makes xterm use a
515 built-in version of the wide-character width calculation. The
516 default is “false”
517
518 +mk_width
519 Reset the mkWidth resource.
520
521 -ms color
522 This option specifies the color to be used for the pointer cur‐
523 sor. The default is to use the foreground color. This sets
524 the pointerColor resource.
525
526 -nb number
527 This option specifies the number of characters from the right
528 end of a line at which the margin bell, if enabled, will ring.
529 The default is 10.
530
531 -nul This option disables the display of underlining.
532
533 +nul This option enables the display of underlining.
534
535 -pc This option enables the PC-style use of bold colors (see bold‐
536 Colors resource).
537
538 +pc This option disables the PC-style use of bold colors.
539
540 -pob This option indicates that the window should be raised whenever
541 a Control-G is received.
542
543 +pob This option indicates that the window should not be raised
544 whenever a Control-G is received.
545
546 -rightbar
547 Force scrollbar to the right side of VT100 screen.
548
549 -rvc This option disables the display of characters with reverse
550 attribute as color.
551
552 +rvc This option enables the display of characters with reverse
553 attribute as color.
554
555 -rw This option indicates that reverse-wraparound should be
556 allowed. This allows the cursor to back up from the leftmost
557 column of one line to the rightmost column of the previous
558 line. This is very useful for editing long shell command lines
559 and is encouraged. This option can be turned on and off from
560 the “VT Options” menu.
561
562 +rw This option indicates that reverse-wraparound should not be
563 allowed.
564
565 -s This option indicates that xterm may scroll asynchronously,
566 meaning that the screen does not have to be kept completely up
567 to date while scrolling. This allows xterm to run faster when
568 network latencies are very high and is typically useful when
569 running across a very large internet or many gateways.
570
571 +s This option indicates that xterm should scroll synchronously.
572
573 -samename
574 Does not send title and icon name change requests when the
575 request would have no effect: the name is not changed. This
576 has the advantage of preventing flicker and the disadvantage of
577 requiring an extra round trip to the server to find out the
578 previous value. In practice this should never be a problem.
579
580 +samename
581 Always send title and icon name change requests.
582
583 -sb This option indicates that some number of lines that are
584 scrolled off the top of the window should be saved and that a
585 scrollbar should be displayed so that those lines can be
586 viewed. This option may be turned on and off from the “VT
587 Options” menu.
588
589 +sb This option indicates that a scrollbar should not be displayed.
590
591 -selbg color
592 This option specifies the color to use for the background of
593 selected text. If not specified, reverse video is used. See
594 the discussion of the highlightColor resource.
595
596 -selfg color
597 This option specifies the color to use for selected text. If
598 not specified, reverse video is used. See the discussion of
599 the highlightTextColor resource.
600
601 -sf This option indicates that Sun Function Key escape codes should
602 be generated for function keys.
603
604 +sf This option indicates that the standard escape codes should be
605 generated for function keys.
606
607 -si This option indicates that output to a window should not auto‐
608 matically reposition the screen to the bottom of the scrolling
609 region. This option can be turned on and off from the “VT
610 Options” menu.
611
612 +si This option indicates that output to a window should cause it
613 to scroll to the bottom.
614
615 -sk This option indicates that pressing a key while using the
616 scrollbar to review previous lines of text should cause the
617 window to be repositioned automatically in the normal position
618 at the bottom of the scroll region.
619
620 +sk This option indicates that pressing a key while using the
621 scrollbar should not cause the window to be repositioned.
622
623 -sl number
624 This option specifies the number of lines to save that have
625 been scrolled off the top of the screen. This corresponds to
626 the saveLines resource. The default is 64.
627
628 -sm This option, corresponding to the sessionMgt resource, indi‐
629 cates that xterm should set up session manager callbacks.
630
631 +sm This option indicates that xterm should not set up session man‐
632 ager callbacks.
633
634 -sp This option indicates that Sun/PC keyboard should be assumed,
635 providing mapping for keypad “+' to “,', and CTRL-F1 to F13,
636 CTRL-F2 to F14, etc.
637
638 +sp This option indicates that the standard escape codes should be
639 generated for keypad and function keys.
640
641 -t This option indicates that xterm should start in Tektronix
642 mode, rather than in VT102 mode. Switching between the two
643 windows is done using the “Options” menus. Termcap(5) entries
644 that work with xterm “tek4014,” “tek4015,” “tek4012,”
645 “tek4013,” “tek4010,” and “dumb.” xterm automatically searches
646 the termcap file in this order for these entries and then sets
647 the “TERM” and the “TERMCAP” environment variables.
648
649 +t This option indicates that xterm should start in VT102 mode.
650
651 -tb This option, corresponding to the toolBar resource, indicates
652 that xterm should display a toolbar (or menubar) at the top of
653 its window. The buttons in the toolbar correspond to the popup
654 menus, e.g., control/left/mouse for "Main Options".
655
656 +tb This option indicates that xterm should not set up a toolbar.
657
658 -ti term_id
659 Specify the name used by xterm to select the correct response
660 to terminal ID queries. It also specifies the emulation level,
661 used to determine the type of response to a DA control
662 sequence. Valid values include vt52, vt100, vt101, vt102, and
663 vt220 (the "vt" is optional). The default is vt100. The
664 term_id argument specifies the terminal ID to use. (This is
665 the same as the decTerminalID resource).
666
667 -tm string
668 This option specifies a series of terminal setting keywords
669 followed by the characters that should be bound to those func‐
670 tions, similar to the stty program. The keywords and their
671 values are described in detail in the ttyModes resource.
672
673 -tn name
674 This option specifies the name of the terminal type to be set
675 in the TERM environment variable. It corresponds to the
676 termName resource. This terminal type must exist in the termi‐
677 nal database (termcap or terminfo, depending on how xterm is
678 built) and should have li# and co# entries. If the terminal
679 type is not found, xterm uses the built-in list “xterm”,
680 “vt102”, etc.
681
682 -u8 This option sets the utf8 resource. When utf8 is set, xterm
683 interprets incoming data as UTF-8. This sets the wideChars
684 resource as a side-effect, but the UTF-8 mode set by this
685 option prevents it from being turned off. If you must turn it
686 on and off, use the wideChars resource.
687
688 This option and the utf8 resource are overridden by the -lc and
689 -en options and locale resource. That is, if xterm has been
690 compiled to support luit, and the locale resource is not
691 “false” this option is ignored. We recommend using the -lc
692 option or the “locale: true” resource in UTF-8 locales when
693 your operating system supports locale, or -en UTF-8 option or
694 the “locale: UTF-8” resource when your operating system does
695 not support locale.
696
697 +u8 This option resets the utf8 resource.
698
699 -uc This option makes the cursor underlined instead of a box.
700
701 +uc This option makes the cursor a box instead of underlined.
702
703 -ulc This option disables the display of characters with underline
704 attribute as color rather than with underlining.
705
706 +ulc This option enables the display of characters with underline
707 attribute as color rather than with underlining.
708
709 -ulit This option, corresponding to the italicULMode resource, dis‐
710 ables the display of characters with underline attribute as
711 italics rather than with underlining.
712
713 +ulit This option, corresponding to the italicULMode resource,
714 enables the display of characters with underline attribute as
715 italics rather than with underlining.
716
717 -ut This option indicates that xterm should not write a record into
718 the the system utmp log file.
719
720 +ut This option indicates that xterm should write a record into the
721 system utmp log file.
722
723 -vb This option indicates that a visual bell is preferred over an
724 audible one. Instead of ringing the terminal bell whenever a
725 Control-G is received, the window will be flashed.
726
727 +vb This option indicates that a visual bell should not be used.
728
729 -wc This option sets the wideChars resource. When wideChars is
730 set, xterm maintains internal structures for 16-bit characters.
731 If you do not set this resource to “true”, xterm will ignore
732 the escape sequence which turns UTF-8 mode on and off. The
733 default is “false”.
734
735 +wc This option resets the wideChars resource.
736
737 -wf This option indicates that xterm should wait for the window to
738 be mapped the first time before starting the subprocess so that
739 the initial terminal size settings and environment variables
740 are correct. It is the application's responsibility to catch
741 subsequent terminal size changes.
742
743 +wf This option indicates that xterm should not wait before start‐
744 ing the subprocess.
745
746 -ziconbeep percent
747 Same as zIconBeep resource. If percent is non-zero, xterms
748 that produce output while iconified will cause an XBell sound
749 at the given volume and have "***" prepended to their icon
750 titles. Most window managers will detect this change immedi‐
751 ately, showing you which window has the output. (A similar
752 feature was in x10 xterm.)
753
754 -C This option indicates that this window should receive console
755 output. This is not supported on all systems. To obtain con‐
756 sole output, you must be the owner of the console device, and
757 you must have read and write permission for it. If you are
758 running X under xdm on the console screen you may need to have
759 the session startup and reset programs explicitly change the
760 ownership of the console device in order to get this option to
761 work.
762
763 -Sccn This option allows xterm to be used as an input and output
764 channel for an existing program and is sometimes used in spe‐
765 cialized applications. The option value specifies the last few
766 letters of the name of a pseudo-terminal to use in slave mode,
767 plus the number of the inherited file descriptor. If the
768 option contains a “/” character, that delimits the characters
769 used for the pseudo-terminal name from the file descriptor.
770 Otherwise, exactly two characters are used from the option for
771 the pseudo-terminal name, the remainder is the file descriptor.
772 Examples:
773 -S123/45
774 -Sab34
775
776 Note that xterm does not close any file descriptor which it did
777 not open for its own use. It is possible (though probably not
778 portable) to have an application which passes an open file
779 descriptor down to xterm past the initialization or the -S
780 option to a process running in the xterm.
781
782 The following command line arguments are provided for compatibility
783 with older versions. They may not be supported in the next release as
784 the X Toolkit provides standard options that accomplish the same task.
785
786 %geom This option specifies the preferred size and position of the
787 Tektronix window. It is shorthand for specifying the “*tekGe‐
788 ometry” resource.
789
790 #geom This option specifies the preferred position of the icon win‐
791 dow. It is shorthand for specifying the “*iconGeometry”
792 resource.
793
794 -T string
795 This option specifies the title for xterm's windows. It is
796 equivalent to -title.
797
798 -n string
799 This option specifies the icon name for xterm's windows. It is
800 shorthand for specifying the “*iconName” resource. Note that
801 this is not the same as the toolkit option -name (see below).
802 The default icon name is the application name.
803
804 -r This option indicates that reverse video should be simulated by
805 swapping the foreground and background colors. It is equiva‐
806 lent to -rv.
807
808 -w number
809 This option specifies the width in pixels of the border sur‐
810 rounding the window. It is equivalent to -borderwidth or -bw.
811
812 The following standard X Toolkit command line arguments are commonly
813 used with xterm:
814
815 -bd color
816 This option specifies the color to use for the border of the
817 window. The corresponding resource name is borderColor. xterm
818 uses the X Toolkit default, which is “XtDefaultForeground”.
819
820 -bg color
821 This option specifies the color to use for the background of
822 the window. The corresponding resource name is background.
823 The default is “XtDefaultBackground.”
824
825 -bw number
826 This option specifies the width in pixels of the border sur‐
827 rounding the window.
828
829 This appears to be a legacy of older X releases. It sets the
830 borderWidth resource of the shell widget, and may provide
831 advice to your window manager to set the thickness of the win‐
832 dow frame. Most window managers do not use this information.
833 See the -b option, which controls the inner border of the xterm
834 window.
835
836 -display display
837 This option specifies the X server to contact; see X(7).
838
839 -fg color
840 This option specifies the color to use for displaying text.
841 The corresponding resource name is foreground. The default is
842 “XtDefaultForeground.”
843
844 -fn font
845 This option specifies the font to be used for displaying normal
846 text. The corresponding resource name is font. The resource
847 value default is fixed.
848
849 -font font
850 This is the same as -fn.
851
852 -geometry geometry
853 This option specifies the preferred size and position of the
854 VT102 window; see X(7).
855
856 -iconic This option indicates that xterm should ask the window manager
857 to start it as an icon rather than as the normal window. The
858 corresponding resource name is iconic.
859
860 -name name
861 This option specifies the application name under which
862 resources are to be obtained, rather than the default exe‐
863 cutable file name. Name should not contain “.” or “*” charac‐
864 ters.
865
866 -rv This option indicates that reverse video should be simulated by
867 swapping the foreground and background colors. The correspond‐
868 ing resource name is reverseVideo.
869
870 +rv Disable the simulation of reverse video by swapping foreground
871 and background colors.
872
873 -title string
874 This option specifies the window title string, which may be
875 displayed by window managers if the user so chooses. The
876 default title is the command line specified after the -e
877 option, if any, otherwise the application name.
878
879 -xrm resourcestring
880 This option specifies a resource string to be used. This is
881 especially useful for setting resources that do not have sepa‐
882 rate command line options.
883
885 The program understands all of the core X Toolkit resource names and
886 classes. Application specific resources (e.g., "XTerm.NAME") follow:
887
888 backarrowKeyIsErase (class BackarrowKeyIsErase)
889 Tie the VTxxx backarrowKey and ptyInitialErase resources
890 together by setting the DECBKM state according to whether the
891 initial value of stty erase is a backspace (8) or delete (127)
892 character. The default is “false”, which disables this fea‐
893 ture.
894
895 hold (class Hold)
896 If true, xterm will not immediately destroy its window when the
897 shell command completes. It will wait until you use the window
898 manager to destroy/kill the window, or if you use the menu
899 entries that send a signal, e.g., HUP or KILL. You may scroll
900 back, select text, etc., to perform most graphical operations.
901 Resizing the display will lose data, however, since this
902 involves interaction with the shell which is no longer running.
903
904 hpFunctionKeys (class HpFunctionKeys)
905 Specifies whether or not HP Function Key escape codes should be
906 generated for function keys instead of standard escape
907 sequences.
908
909 See also the keyboardType resource.
910
911 iconGeometry (class IconGeometry)
912 Specifies the preferred size and position of the application
913 when iconified. It is not necessarily obeyed by all window
914 managers.
915
916 iconName (class IconName)
917 Specifies the icon name. The default is the application name.
918
919 keyboardType (class KeyboardType)
920 Enables one (or none) of the various keyboard-type resources:
921 hpFunctionKeys, scoFunctionKeys, sunFunctionKeys, tcapFunction‐
922 Keys and sunKeyboard. The resource's value should be one of
923 the corresponding strings “hp”, “sco”, “sun”, “tcap” or
924 “vt220”. The individual resources are provided for legacy sup‐
925 port; this resource is simpler to use.
926
927 maxBufSize (class MaxBufSize)
928 Specify the maximum size of the input buffer. The default is
929 32768. You cannot set this to a value less than the minBufSize
930 resource. It will be increased as needed to make that value
931 evenly divide this one.
932
933 On some systems you may want to increase one or both of the
934 maxBufSize and minBufSize resource values to achieve better
935 performance if the operating system prefers larger buffer
936 sizes.
937
938 maximized (class Maximized)
939 Specifies whether or not xterm should ask the window manager to
940 maximize its layout on startup. The default is “false.”
941
942 messages (class Messages)
943 Specifies whether write access to the terminal is allowed ini‐
944 tially. See mesg(1). The default is “true”.
945
946 menuLocale (class MenuLocale)
947 Specify the locale used for character-set computations when
948 loading the popup menus. Use this to improve initialization
949 performance of the Athena popup menus, which may load unneces‐
950 sary (and very large) fonts, e.g., in a locale having UTF-8
951 encoding. The default is the "C" (POSIX).
952
953 To use the current locale (only useful if you have localized
954 the resource settings for the menu entries), set the resource
955 to an empty string.
956
957 minBufSize (class MinBufSize)
958 Specify the minimum size of the input buffer, i.e., the amount
959 of data that xterm requests on each read. The default is 4096.
960 You cannot set this to a value less than 64.
961
962 ptyHandshake (class PtyHandshake)
963 If “true”, xterm will perform handshaking during initialization
964 to ensure that the parent and child processes update the utmp
965 and stty state.
966
967 See also waitForMap which waits for the pseudo-terminal's
968 notion of the screen size, and ptySttySize which resets the
969 screen size after other terminal initialization is complete.
970 The default is “true”.
971
972 ptyInitialErase (class PtyInitialErase)
973 If “true”, xterm will use the pseudo-terminal's sense of the
974 stty erase value. If “false”, xterm will set the stty erase
975 value to match its own configuration, using the kb string from
976 the termcap entry as a reference, if available. In either
977 case, the result is applied to the TERMCAP variable which xterm
978 sets.
979
980 See also the ttyModes resource, which may modify this. The
981 default is “false”.
982
983 ptySttySize (class PtySttySize)
984 If “true”, xterm will reset the screen size after terminal ini‐
985 tialization is complete. This is needed for some systems whose
986 pseudo-terminals cannot propagate terminal characteristics.
987 Where it is not needed, it can interfere with other methods for
988 setting the intial screen size, e.g., via window manager inter‐
989 action.
990
991 See also waitForMap which waits for a handshake-message giving
992 the pseudo-terminal's notion of the screen size. The default
993 is “false” on Linux and OS X systems, “true” otherwise.
994
995 sameName (class SameName)
996 If the value of this resource is “true”, xterm does not send
997 title and icon name change requests when the request would have
998 no effect: the name is not changed. This has the advantage of
999 preventing flicker and the disadvantage of requiring an extra
1000 round trip to the server to find out the previous value. In
1001 practice this should never be a problem. The default is
1002 “true”.
1003
1004 scoFunctionKeys (class ScoFunctionKeys)
1005 Specifies whether or not SCP Function Key escape codes should
1006 be generated for function keys instead of standard escape
1007 sequences.
1008
1009 See also the keyboardType resource.
1010
1011 sessionMgt (class SessionMgt)
1012 If the value of this resource is “true”, xterm sets up session
1013 manager callbacks for XtNdieCallback and XtNsaveCallback. The
1014 default is “true”.
1015
1016 sunFunctionKeys (class SunFunctionKeys)
1017 Specifies whether or not Sun Function Key escape codes should
1018 be generated for function keys instead of standard escape
1019 sequences.
1020
1021 See also the keyboardType resource.
1022
1023 sunKeyboard (class SunKeyboard)
1024 Specifies whether or not Sun/PC keyboard layout should be
1025 assumed rather than DEC VT220. This causes the keypad “+' to
1026 be mapped to “,'. and CTRL F1-F12 to F11-F20, depending on the
1027 setting of the ctrlFKeys resource. so xterm emulates a DEC
1028 VT220 more accurately. Otherwise (the default, with sunKey‐
1029 board set to “false”), xterm uses PC-style bindings for the
1030 function keys and keypad.
1031
1032 PC-style bindings use the Shift, Alt, Control and Meta keys as
1033 modifiers for function-keys and keypad (see the document Xterm
1034 Control Sequences for details). The PC-style bindings are
1035 analogous to PCTerm, but not the same thing. Normally these
1036 bindings do not conflict with the use of the Meta key as
1037 described for the eightBitInput resource. If they do, note
1038 that the PC-style bindings are evaluated first.
1039
1040 See also the keyboardType resource.
1041
1042 tcapFunctionKeys (class TcapFunctionKeys)
1043 Specifies whether or not function key escape codes read from
1044 the termcap/terminfo entry should be generated for function
1045 keys instead of standard escape sequences.
1046
1047 See also the keyboardType resource.
1048
1049 termName (class TermName)
1050 Specifies the terminal type name to be set in the TERM environ‐
1051 ment variable.
1052
1053 title (class Title)
1054 Specifies a string that may be used by the window manager when
1055 displaying this application.
1056
1057 toolBar (class ToolBar)
1058 Specifies whether or not the toolbar should be displayed. The
1059 default is “true.”
1060
1061 ttyModes (class TtyModes)
1062 Specifies a string containing terminal setting keywords and the
1063 characters to which they may be bound. Allowable keywords
1064 include: brk, dsusp, eof, eol, eol2, erase, erase2, flush,
1065 intr, kill, lnext, quit, rprnt, start, status, stop, susp,
1066 swtch and weras. Control characters may be specified as ^char
1067 (e.g., ^c or ^u) and ^? may be used to indicate delete (127).
1068 Use ^- to denote undef. Use \034 to represent ^\, since a lit‐
1069 eral backslash in an X resource escapes the next character.
1070
1071 This is very useful for overriding the default terminal set‐
1072 tings without having to do an stty every time an xterm is
1073 started. Note, however, that the stty program on a given host
1074 may use different keywords; xterm's table is built-in.
1075
1076 If the ttyModes resource specifies a value for erase, that
1077 overrides the ptyInitialErase resource setting, i.e., xterm
1078 initializes the terminal to match that value.
1079
1080 useInsertMode (class UseInsertMode)
1081 Force use of insert mode by adding appropriate entries to the
1082 TERMCAP environment variable. This is useful if the system
1083 termcap is broken. The default is “false.”
1084
1085 utmpDisplayId (class UtmpDisplayId)
1086 Specifies whether or not xterm should try to record the display
1087 identifier (display number and screen number) as well as the
1088 hostname in the system utmp log file. The default is “true.”
1089
1090 utmpInhibit (class UtmpInhibit)
1091 Specifies whether or not xterm should try to record the user's
1092 terminal in the system utmp log file. If true, xterm will not
1093 try. The default is “false.”
1094
1095 waitForMap (class WaitForMap)
1096 Specifies whether or not xterm should wait for the initial win‐
1097 dow map before starting the subprocess. This is part of the
1098 ptyHandshake logic. When xterm is directed to wait in this
1099 fashion, it passes the terminal size from the display end of
1100 the pseudo-terminal to the terminal I/O connection, e.g.,
1101 according to the window manager. Otherwise, it uses the size
1102 as given in resource values or command-line option -geom. The
1103 default is “false.”
1104
1105 zIconBeep (class ZIconBeep)
1106 Same as -ziconbeep command line argument. If the value of this
1107 resource is non-zero, xterms that produce output while iconi‐
1108 fied will cause an XBell sound at the given volume and have
1109 "***" prepended to their icon titles. Most window managers
1110 will detect this change immediately, showing you which window
1111 has the output. (A similar feature was in x10 xterm.) The
1112 default is “false.”
1113
1114 VT100 Widget Resources
1115 The following resources are specified as part of the vt100 widget
1116 (class VT100). They are specified by patterns such as
1117 "XTerm.vt100.NAME".
1118
1119 If your xterm is configured to support the "toolbar", then those pat‐
1120 terns need an extra level for the form-widget which holds the toolbar
1121 and vt100 widget. A wildcard between the top-level "XTerm" and the
1122 "vt100" widget makes the resource settings work for either, e.g.,
1123 "XTerm*vt100.NAME".
1124
1125 activeIcon (class ActiveIcon)
1126 Specifies whether or not active icon windows are to be used
1127 when the xterm window is iconified, if this feature is compiled
1128 into xterm. The active icon is a miniature representation of
1129 the content of the window and will update as the content
1130 changes. Not all window managers necessarily support applica‐
1131 tion icon windows. Some window managers will allow you to
1132 enter keystrokes into the active icon window. The default is
1133 “false.”
1134
1135 allowC1Printable (class AllowC1Printable)
1136 If true, overrides the mapping of C1 controls (codes 128-159)
1137 to make them be treated as if they were printable characters.
1138 Although this corresponds to no particular standard, some users
1139 insist it is a VT100. The default is “false.”
1140
1141 allowColorOps (class AllowColorOps)
1142 Specifies whether control sequences that set/query the dynamic
1143 colors should be allowed. ANSI colors are unaffected by this
1144 resource setting. The default is “true.”
1145
1146 allowFontOps (class AllowFontOps)
1147 Specifies whether control sequences that set/query the font
1148 should be allowed. The default is “true.”
1149
1150 allowScrollLock (class AllowScrollLock)
1151 Specifies whether control sequences that set/query the Scroll
1152 Lock key should be allowed, as well as whether the Scroll Lock
1153 key responds to user's keypress. The default is “false.”
1154
1155 When this feature is enabled, xterm will sense the state of the
1156 Scroll Lock key each time it acquires focus. Pressing the
1157 Scroll Lock key toggles xterm's internal state, as well as tog‐
1158 gling the associated LED. While the Scroll Lock is active,
1159 xterm attempts to keep a viewport on the same set of lines. If
1160 the current viewport is scrolled past the limit set by the
1161 saveLines resource, then Scroll Lock has no further effect.
1162
1163 The reason for setting the default to “false.” is to avoid user
1164 surprise. This key is generally unused in keyboard configura‐
1165 tions, and has not acquired a standard meaning even when it is
1166 used in that manner. Consequently, users have assigned it for
1167 ad hoc purposes.
1168
1169 allowSendEvents (class AllowSendEvents)
1170 Specifies whether or not synthetic key and button events (gen‐
1171 erated using the X protocol SendEvent request) should be inter‐
1172 preted or discarded. The default is “false” meaning they are
1173 discarded. Note that allowing such events would create a very
1174 large security hole, therefore enabling this resource force‐
1175 fully disables the allowXXXOps resources. The default is
1176 “false.”
1177
1178 allowTcapOps (class AllowTcapOps)
1179 Specifies whether control sequences that query the terminal's
1180 notion of its function-key strings, as termcap or terminfo
1181 capabilities should be allowed. The default is “false.”
1182
1183 A few programs, e.g,. vim, use this feature to get an accurate
1184 description of the terminal's capabilities, independent of the
1185 termcap/terminfo setting:
1186
1187 - xterm can tell the querying program how many colors it sup‐
1188 ports. This is a constant, depending on how it is compiled,
1189 typically 16. It does not change if you alter resource set‐
1190 tings, e.g., the boldColors resource.
1191
1192 - xterm can tell the querying program what strings are sent by
1193 modified (shift-, control-, alt-) function- and keypad-keys.
1194 Reporting control- and alt-modifiers is a feature that
1195 relies on the ncurses extended naming.
1196
1197 allowTitleOps (class AllowTitleOps)
1198 Specifies whether control sequences that modify the window
1199 title or icon name should be allowed. The default is “true.”
1200
1201 allowWindowOps (class AllowWindowOps)
1202 Specifies whether extended window control sequences (as used in
1203 dtterm) should be allowed. These include several control
1204 sequences which manipulate the window size or position, as well
1205 as reporting these values and the title or icon name. Each of
1206 these can be abused in a script; curiously enough most terminal
1207 emulators that implement these restrict only a small part of
1208 the repertoire. For fine-tuning, see disallowedWindowOps. The
1209 default is “false.”
1210
1211 altIsNotMeta (class AltIsNotMeta)
1212 If “true”, treat the Alt-key as if it were the Meta-key. Your
1213 keyboard may happen to be configured so they are the same. But
1214 if they are not, this allows you to use the same prefix- and
1215 shifting operations with the Alt-key as with the Meta-key. See
1216 altSendsEscape and metaSendsEscape. The default is “false.”
1217
1218 altSendsEscape (class AltSendsEscape)
1219 This is an additional keyboard operation that may be processed
1220 after the logic for metaSendsEscape. It is only available if
1221 the altIsNotMeta resource is set.
1222
1223 If “true”, Alt characters (a character combined with the modi‐
1224 fier associated with left/right Alt-keys) are converted into a
1225 two-character sequence with the character itself preceded by
1226 ESC. This applies as well to function key control sequences,
1227 unless xterm sees that Alt is used in your key translations.
1228 If “false”, Alt characters input from the keyboard cause a
1229 shift to 8-bit characters (just like metaSendsEscape). By com‐
1230 bining the Alt- and Meta-modifiers, you can create correspond‐
1231 ing combinations of ESC-prefix and 8-bit characters. The
1232 default is “false.”
1233
1234 alwaysBoldMode (class AlwaysBoldMode)
1235 Specifies whether xterm should check if the normal and bold
1236 fonts are distinct before deciding whether to use overstriking
1237 to simulate bold fonts. If this resource is true, xterm does
1238 not make the check for distinct fonts when deciding how to han‐
1239 dle the boldMode resource. The default is “false.”
1240
1241 boldMode alwaysBoldMode Comparison Action
1242 ────────────────────────────────────────────────────
1243 false false ignored use font
1244 false true ignored use font
1245 true false same overstrike
1246 true false different use font
1247 true true ignored overstrike
1248
1249 alwaysHighlight (class AlwaysHighlight)
1250 Specifies whether or not xterm should always display a high‐
1251 lighted text cursor. By default (if this resource is false), a
1252 hollow text cursor is displayed whenever the pointer moves out
1253 of the window or the window loses the input focus. The default
1254 is “false.”
1255
1256 alwaysUseMods (class AlwaysUseMods)
1257 Override the numLock resource, telling xterm to use the Alt and
1258 Meta modifiers to construct parameters for function key
1259 sequences even if those modifiers appear in the translations
1260 resource. Normally xterm checks if Alt or Meta is used in a
1261 translation that would conflict with function key modifiers,
1262 and will ignore these modifiers in that special case. The
1263 default is “false.”
1264
1265 answerbackString (class AnswerbackString)
1266 Specifies the string that xterm sends in response to an ENQ
1267 (control/E) character from the host. The default is a blank
1268 string, i.e., “”. A hardware VT100 implements this feature as
1269 a setup option.
1270
1271 appcursorDefault (class AppcursorDefault)
1272 If “true,” the cursor keys are initially in application mode.
1273 This is the same as the VT102 private DECCKM mode, The default
1274 is “false.”
1275
1276 appkeypadDefault (class AppkeypadDefault)
1277 If “true,” the keypad keys are initially in application mode.
1278 The default is “false.”
1279
1280 autoWrap (class AutoWrap)
1281 Specifies whether or not auto-wraparound should be enabled.
1282 This is the same as the VT102 DECAWM. The default is “true.”
1283
1284 awaitInput (class AwaitInput)
1285 Specifies whether or not the xterm uses a 50 millisecond time‐
1286 out to await input (i.e., to support the Xaw3d arrow scroll‐
1287 bar). The default is “false.”
1288
1289 backarrowKey (class BackarrowKey)
1290 Specifies whether the backarrow key transmits a backspace (8)
1291 or delete (127) character. This corresponds to the DECBKM con‐
1292 trol sequence. The default (backspace) is “true.” Pressing
1293 the control key toggles this behavior.
1294
1295 background (class Background)
1296 Specifies the color to use for the background of the window.
1297 The default is “XtDefaultBackground.”
1298
1299 bellIsUrgent (class BellIsUrgent)
1300 Specifies whether to set the Urgency hint for the window man‐
1301 ager when making a bell sound. The default is “false.”
1302
1303 bellOnReset (class BellOnReset)
1304 Specifies whether to sound a bell when doing a hard reset. The
1305 default is “true.”
1306
1307 bellSuppressTime (class BellSuppressTime)
1308 Number of milliseconds after a bell command is sent during
1309 which additional bells will be suppressed. Default is 200. If
1310 set non-zero, additional bells will also be suppressed until
1311 the server reports that processing of the first bell has been
1312 completed; this feature is most useful with the visible bell.
1313
1314 boldColors (class ColorMode)
1315 Specifies whether to combine bold attribute with colors like
1316 the IBM PC, i.e., map colors 0 through 7 to colors 8 through
1317 15. These normally are the brighter versions of the first 8
1318 colors, hence bold. The default is “true.”
1319
1320 boldFont (class BoldFont)
1321 Specifies the name of the bold font to use instead of over‐
1322 striking. There is no default for this resource.
1323
1324 This font must be the same height and width as the normal font,
1325 otherwise it is ignored. If only one of the normal or bold
1326 fonts is specified, it will be used as the normal font and the
1327 bold font will be produced by overstriking this font.
1328
1329 See also the discussion of boldMode and alwaysBoldMode
1330 resources.
1331
1332 boldMode (class BoldMode)
1333 This specifies whether or not text with the bold attribute
1334 should be overstruck to simulate bold fonts if the resolved
1335 bold font is the same as the normal font. It may be desirable
1336 to disable bold fonts when color is being used for the bold
1337 attribute.
1338
1339 Note that xterm has one bold font which you may set explicitly.
1340 Xterm attempts to derive a bold font for the other font selec‐
1341 tions (font1 through font6). If it cannot find a bold font, it
1342 will use the normal font. In each case (whether the explicit
1343 resource or the derived font), if the normal and bold fonts are
1344 distinct, this resource has no effect. The default is “true.”
1345
1346 See the alwaysBoldMode resource which can modify the behavior
1347 of this resource.
1348
1349 Although xterm attempts to derive a bold font for other font
1350 selections, the font server may not cooperate. Since X11R6,
1351 bitmap fonts have been scaled. The font server claims to pro‐
1352 vide the bold font that xterm requests, but the result is not
1353 always readable. XFree86 provides a feature which can be used
1354 to suppress the scaling. In the X server's configuration file
1355 (e.g., /etc/X11/xorg.conf), you can add ":unscaled" to the end
1356 of the directory specification for the "misc" fonts, which com‐
1357 prise the fixed-pitch fonts that are used by xterm. For exam‐
1358 ple
1359 FontPath "/usr/share/X11/fonts"
1360
1361 would become
1362 FontPath "/usr/share/X11/fonts/misc/:unscaled"
1363
1364 Depending on your configuration, the font server may have its
1365 own configuration file. The same ":unscaled" can be added to
1366 its configuration file at the end of the directory specifica‐
1367 tion for "misc".
1368
1369 The bitmap scaling feature is also used by xterm to implement
1370 VT102 double-width and double-height characters.
1371
1372 brokenLinuxOSC (class BrokenLinuxOSC)
1373 If true, xterm applies a workaround to ignore malformed control
1374 sequences that a Linux script might send. Compare the palette
1375 control sequences documented in console_codes with ECMA-48.
1376 The default is “true.”
1377
1378 brokenSelections (class BrokenSelections)
1379 If true, xterm in 8-bit mode will interpret STRING selections
1380 as carrying text in the current locale's encoding. Normally
1381 STRING selections carry ISO-8859-1 encoded text. Setting this
1382 resource to “true” violates the ICCCM; it may, however, be use‐
1383 ful for interacting with some broken X clients. The default is
1384 “false.”
1385
1386 brokenStringTerm (class BrokenStringTerm)
1387 provides a work-around for some ISDN routers which start an
1388 application control string without completing it. Set this to
1389 “true” if xterm appears to freeze when connecting. The default
1390 is “false.”
1391
1392 Xterm's state parser recognizes several types of control
1393 strings which can contain text, e.g.,
1394
1395 APC (Application Program Command),
1396 DCS (Device Control String),
1397 OSC (Operating System Command),
1398 PM (Privacy Message), and
1399 SOS (Start of String),
1400
1401 Each should end with a string-terminator (a special character
1402 which cannot appear in these strings). Ordinary control char‐
1403 acters found within the string are not ignored; they are pro‐
1404 cessed without interfering with the process of accumulating the
1405 control string's content. Xterm recognizes these controls in
1406 all modes, although some of the functions may be suppressed
1407 after parsing the control.
1408
1409 When enabled, this feature allows the user to exit from an
1410 unterminated control string when any of these ordinary control
1411 characters are found:
1412
1413 control/D (used as an end of file in many shells),
1414 control/H (backspace),
1415 control/I (tab-feed),
1416 control/J (line feed aka newline),
1417 control/K (vertical tab),
1418 control/L (form feed),
1419 control/M (carriage return),
1420 control/N (shift-out),
1421 control/O (shift-in),
1422 control/Q (XOFF),
1423 control/X (cancel)
1424
1425 c132 (class C132)
1426 Specifies whether or not the VT102 DECCOLM escape sequence,
1427 used to switch between 80 and 132 columns, should be honored.
1428 The default is “false.”
1429
1430 cacheDoublesize (class CacheDoublesize)
1431 Tells whether to cache double-sized fonts by xterm. Set this
1432 to zero to disable double-sized fonts altogether.
1433
1434 charClass (class CharClass)
1435 Specifies comma-separated lists of character class bindings of
1436 the form [low-]high:value. These are used in determining which
1437 sets of characters should be treated the same when doing cut
1438 and paste. See the CHARACTER CLASSES section.
1439
1440 cjkWidth (class CjkWidth)
1441 Specifies whether xterm should follow the traditional East
1442 Asian width convention. When turned on, characters with East
1443 Asian Ambiguous (A) category in UTR 11 have a column width of
1444 2. You may have to set this option to “true” if you have some
1445 old East Asian terminal based programs that assume that line-
1446 drawing characters have a column width of 2. If this resource
1447 is false, the mkWidth resource controls the choice between the
1448 system's wcwidth and xterm's built-in tables. The default is
1449 “false.”
1450
1451 color0 (class Color0)
1452
1453 color1 (class Color1)
1454
1455 color2 (class Color2)
1456
1457 color3 (class Color3)
1458
1459 color4 (class Color4)
1460
1461 color5 (class Color5)
1462
1463 color6 (class Color6)
1464
1465 color7 (class Color7)
1466 These specify the colors for the ISO-6429 extension. The
1467 defaults are, respectively, black, red3, green3, yellow3, a
1468 customizable dark blue, magenta3, cyan3, and gray90. The
1469 default shades of color are chosen to allow the colors 8-15 to
1470 be used as brighter versions.
1471
1472 color8 (class Color8)
1473
1474 color9 (class Color9)
1475
1476 color10 (class Color10)
1477
1478 color11 (class Color11)
1479
1480 color12 (class Color12)
1481
1482 color13 (class Color13)
1483
1484 color14 (class Color14)
1485
1486 color15 (class Color15)
1487 These specify the colors for the ISO-6429 extension if the bold
1488 attribute is also enabled. The default resource values are
1489 respectively, gray30, red, green, yellow, a customizable light
1490 blue, magenta, cyan, and white.
1491
1492 color16 (class Color16)
1493
1494 through
1495
1496 color255 (class Color255)
1497 These specify the colors for the 256-color extension. The
1498 default resource values are for colors 16 through 231 to make a
1499 6x6x6 color cube, and colors 232 through 255 to make a
1500 grayscale ramp.
1501
1502 Resources past color15 are available as a compile-time option.
1503 Due to a hardcoded limit in the X libraries on the total number
1504 of resources (to 400), the resources for 256-colors are omitted
1505 when wide-character support and luit are enabled. Besides
1506 inconsistent behavior if only part of the resources were
1507 allowed, determining the exact cutoff is difficult, and the X
1508 libraries tend to crash if the number of resources exceeds the
1509 limit. The color palette is still initialized to the same
1510 default values, and can be modified via control sequences.
1511
1512 On the other hand, the resource limit does permit including the
1513 entire range for 88-colors.
1514
1515 colorAttrMode (class ColorAttrMode)
1516 Specifies whether colorBD, colorBL, colorRV, and colorUL should
1517 override ANSI colors. If not, these are displayed only when no
1518 ANSI colors have been set for the corresponding position. The
1519 default is “false.”
1520
1521 colorBD (class ColorBD)
1522 This specifies the color to use to display bold characters if
1523 the “colorBDMode” resource is enabled. The default is “XtDe‐
1524 faultForeground.”
1525
1526 colorBDMode (class ColorAttrMode)
1527 Specifies whether characters with the bold attribute should be
1528 displayed in color or as bold characters. Note that setting
1529 colorMode off disables all colors, including bold. The default
1530 is “false.”
1531
1532 colorBL (class ColorBL)
1533 This specifies the color to use to display blink characters if
1534 the “colorBLMode” resource is enabled. The default is “XtDe‐
1535 faultForeground.”
1536
1537 colorBLMode (class ColorAttrMode)
1538 Specifies whether characters with the blink attribute should be
1539 displayed in color. Note that setting colorMode off disables
1540 all colors, including this. The default is “false.”
1541
1542 colorMode (class ColorMode)
1543 Specifies whether or not recognition of ANSI (ISO-6429) color
1544 change escape sequences should be enabled. The default is
1545 “true.”
1546
1547 colorRV (class ColorRV)
1548 This specifies the color to use to display reverse characters
1549 if the “colorRVMode” resource is enabled. The default is
1550 “XtDefaultForeground.”
1551
1552 colorRVMode (class ColorAttrMode)
1553 Specifies whether characters with the reverse attribute should
1554 be displayed in color. Note that setting colorMode off dis‐
1555 ables all colors, including this. The default is “false.”
1556
1557 colorUL (class ColorUL)
1558 This specifies the color to use to display underlined charac‐
1559 ters if the “colorULMode” resource is enabled. The default is
1560 “XtDefaultForeground.”
1561
1562 colorULMode (class ColorAttrMode)
1563 Specifies whether characters with the underline attribute
1564 should be displayed in color or as underlined characters. Note
1565 that setting colorMode off disables all colors, including
1566 underlining. The default is “false.”
1567
1568 combiningChars (class CombiningChars)
1569 Specifies the number of wide-characters which can be stored in
1570 a cell to overstrike (combine) with the base character of the
1571 cell. This can be set to values in the range 0 to 4. The
1572 default is “2”.
1573
1574 ctrlFKeys (class CtrlFKeys)
1575 In VT220 keyboard mode (see sunKeyboard resource), specifies
1576 the amount by which to shift F1-F12 given a control modifier
1577 (CTRL). This allows you to generate key symbols for F10-F20 on
1578 a Sun/PC keyboard. The default is “10”, which means that CTRL
1579 F1 generates the key symbol for F11.
1580
1581 curses (class Curses)
1582 Specifies whether or not the last column bug in more(1) should
1583 be worked around. See the -cu option for details. The default
1584 is “false.”
1585
1586 cursorBlink (class CursorBlink)
1587 Specifies whether to make the cursor blink. The default is
1588 “false.”
1589
1590 cursorColor (class CursorColor)
1591 Specifies the color to use for the text cursor. The default is
1592 “XtDefaultForeground.” By default, xterm attempts to keep this
1593 color from being the same as the background color, since it
1594 draws the cursor by filling the background of a text cell. The
1595 same restriction applies to control sequences which may change
1596 this color.
1597
1598 Setting this resource overrides most of xterm's adjustments to
1599 cursor color. It will still use reverse-video to disallow some
1600 cases, such as a black cursor on a black background.
1601
1602 cursorOffTime (class CursorOffTime)
1603 Specifies the duration of the "off" part of the cursor blink
1604 cycle-time in milliseconds. The same timer is used for text
1605 blinking. The default is 300.
1606
1607 cursorOnTime (class CursorOnTime)
1608 Specifies the duration of the "on" part of the cursor blink
1609 cycle-time, in milliseconds. The same timer is used for text
1610 blinking. The default is 600.
1611
1612 cutNewline (class CutNewline)
1613 If “false”, triple clicking to select a line does not include
1614 the Newline at the end of the line. If “true”, the Newline is
1615 selected. The default is “true.”
1616
1617 cursorUnderLine (class CursorUnderLine)
1618 Specifies whether to make the cursor underlined or a box. The
1619 default is “false.”
1620
1621 cutToBeginningOfLine (class CutToBeginningOfLine)
1622 If “false”, triple clicking to select a line selects only from
1623 the current word forward. If “true”, the entire line is
1624 selected. The default is “true.”
1625
1626 decTerminalID (class DecTerminalID)
1627 Specifies the emulation level (100=VT100, 220=VT220, etc.),
1628 used to determine the type of response to a DA control
1629 sequence. Leading non-digit characters are ignored, e.g.,
1630 "vt100" and "100" are the same. The default is 100.
1631
1632 defaultString (class DefaultString)
1633 Specify the character (or string) which xterm will substitute
1634 when pasted text includes a character which cannot be repre‐
1635 sented in the current encoding. For instance, pasting UTF-8
1636 text into a display of ISO-8859-1 characters will only be able
1637 to display codes 0-255, while UTF-8 text can include Unicode
1638 values above 255. The default is “#” (a single pound sign).
1639
1640 If the undisplayable text would be double-width, xterm will add
1641 a space after the “#” character, to give roughly the same lay‐
1642 out on the screen as the original text.
1643
1644 deleteIsDEL (class DeleteIsDEL)
1645 Specifies whether the Delete key on the editing keypad should
1646 send DEL (127) or the VT220-style Remove escape sequence. The
1647 default is “false,” for the latter.
1648
1649 disallowedColorOps (class DisallowedColorOps)
1650 Specify which features will be disabled if allowColorOps is
1651 false. This is a comma-separated list of names. The default
1652 value is
1653 SetColor,GetColor,GetAnsiColor
1654
1655 The names are listed below. xterm ignores capitalization, but
1656 they are shown in mixed-case for clarity.
1657
1658 SetColor
1659 Set a specific dynamic color.
1660
1661 GetColor
1662 Report the current setting of a given dynamic color.
1663
1664 GetAnsiColor
1665 Report the current setting of a given ANSI color (actually
1666 any of the colors set via ANSI-style controls).
1667
1668 disallowedFontOps (class DisallowedFontOps)
1669 Specify which features will be disabled if allowFontOps is
1670 false. This is a comma-separated list of names. The default
1671 value is
1672 SetFont,GetFont
1673
1674 The names are listed below. xterm ignores capitalization, but
1675 they are shown in mixed-case for clarity.
1676
1677 SetFont
1678 Set the specified font.
1679
1680 GetFont
1681 Report the specified font.
1682
1683 disallowedTcapOps (class DisallowedTcapOps)
1684 Specify which features will be disabled if allowTcapOps is
1685 false. This is a comma-separated list of names. The default
1686 value is
1687 SetTcap,GetTcap
1688
1689 The names are listed below. xterm ignores capitalization, but
1690 they are shown in mixed-case for clarity.
1691
1692 SetTcap
1693 (not implemented)
1694
1695 GetTcap
1696 Report specified function- and other special keys.
1697
1698 disallowedWindowOps (class DisallowedWindowOps)
1699 Specify which features will be disabled if allowWindowOps is
1700 false. This is a comma-separated list of names, or (for the
1701 controls adapted from dtterm the operation number). The
1702 default value is
1703 20,21,SetXprop,SetSelection
1704
1705 The names are listed below. xterm ignores capitalization, but
1706 they are shown in mixed-case for clarity. Where a number can
1707 be used as an alternative, it is given in parentheses after the
1708 name.
1709
1710 GetIconTitle (20)
1711 Report xterm window's icon label as a string.
1712
1713 GetScreenSizeChars (19)
1714 Report the size of the screen in characters as numbers.
1715
1716 GetSelection
1717 Report selection data as a base64 string.
1718
1719 GetWinPosition (13)
1720 Report xterm window position as numbers.
1721
1722 GetWinSizeChars (18)
1723 Report the size of the text area in characters as numbers.
1724
1725 GetWinSizePixels (14)
1726 Report xterm window in pixels as numbers.
1727
1728 GetWinState (11)
1729 Report xterm window state as a number.
1730
1731 GetWinTitle (21)
1732 Report xterm window's title as a string.
1733
1734 LowerWin (6)
1735 Lower the xterm window to the bottom of the stacking
1736 order.
1737
1738 MaximizeWin (9)
1739 Maximize window (i.e., resize to screen size).
1740
1741 MinimizeWin (2)
1742 Iconify window.
1743
1744 PopTitle (23)
1745 Pop title from internal stack.
1746
1747 PushTitle (22)
1748 Push title to internal stack.
1749
1750 RaiseWin (5)
1751 Raise the xterm window to the front of the stacking order.
1752
1753 RefreshWin (7)
1754 Refresh the xterm window.
1755
1756 RestoreWin (1)
1757 De-iconify window.
1758
1759 SetSelection
1760 Set selection data.
1761
1762 SetWinLines
1763 Resize to a given number of lines, at least 24.
1764
1765 SetWinPosition (3)
1766 Move window to given coordinates.
1767
1768 SetWinSizeChars (8)
1769 Resize the text area to given size in characters.
1770
1771 SetWinSizePixels (4)
1772 Resize the xterm window to given size in pixels.
1773
1774 SetXprop
1775 Set X property on top-level window.
1776
1777 dynamicColors (class DynamicColors)
1778 Specifies whether or not escape sequences to change colors
1779 assigned to different attributes are recognized.
1780
1781 eightBitControl (class EightBitControl)
1782 Specifies whether or not control sequences sent by the terminal
1783 should be eight-bit characters or escape sequences. The
1784 default is “false.”
1785
1786 eightBitInput (class EightBitInput)
1787 If “true”, Meta characters (a single-byte character combined
1788 with the Meta modifier key) input from the keyboard are pre‐
1789 sented as a single character with the eighth bit turned on.
1790 The terminal is put into 8-bit mode. If “false”, Meta charac‐
1791 ters are converted into a two-character sequence with the char‐
1792 acter itself preceded by ESC. On startup, xterm tries to put
1793 the terminal into 7-bit mode. The metaSendsEscape and altSend‐
1794 sEscape resources may override this. The default is “true.”
1795
1796 Generally keyboards do not have a key labeled "Meta", but "Alt"
1797 keys are common, and they are conventionally used for "Meta".
1798 If they were synonymous, it would have been reasonable to name
1799 this resource "altSendsEscape", reversing its sense. For more
1800 background on this, see the meta function in curses.
1801
1802 Note that the Alt key is not necessarily the same as the Meta
1803 modifier. xmodmap lists your key modifiers. X defines modi‐
1804 fiers for shift, (caps) lock and control, as well as 5 addi‐
1805 tional modifiers which are generally used to configure key mod‐
1806 ifiers. xterm inspects the same information to find the modi‐
1807 fier associated with either Meta key (left or right), and uses
1808 that key as the Meta modifier. It also looks for the NumLock
1809 key, to recognize the modifier which is associated with that.
1810
1811 If your xmodmap configuration uses the same keycodes for Alt-
1812 and Meta-keys, xterm will only see the Alt-key definitions,
1813 since those are tested before Meta-keys. NumLock is tested
1814 first. It is important to keep these keys distinct; otherwise
1815 some of xterm's functionality is not available.
1816
1817 eightBitOutput (class EightBitOutput)
1818 Specifies whether or not eight-bit characters sent from the
1819 host should be accepted as is or stripped when printed. The
1820 default is “true,” which means that they are accepted as is.
1821
1822 eightBitSelectTypes (class EightBitSelectTypes)
1823 Override xterm's default selection target list (see
1824 SELECT/PASTE) for selections in normal (ISO-8859-1) mode. The
1825 default is an empty string, which does not override anything.
1826
1827 faceName (class FaceName)
1828 Specify the pattern for fonts selected from the FreeType
1829 library if support for that library was compiled into xterm.
1830 There is no default value.
1831
1832 If not specified, or if there is no match for both normal and
1833 bold fonts, xterm uses the font and related resources.
1834
1835 faceNameDoublesize (class FaceNameDoublesize)
1836 Specify an double-width font for cases where an application
1837 requires this, e.g., in CJK applications. There is no default
1838 value.
1839
1840 If the application uses double-wide characters and this
1841 resource is not given, xterm will use a scaled version of the
1842 font given by faceName.
1843
1844 faceSize (class FaceSize)
1845 Specify the pointsize for fonts selected from the FreeType
1846 library if support for that library was compiled into xterm.
1847 The default is “14.” On the VT Fonts menu, this corresponds to
1848 the Default entry.
1849
1850 Although the default is “14.”, this may not be the same as the
1851 pointsize for the default bitmap font, i.e., that assigned with
1852 the -fn option, or the font resource. For example, the "fixed"
1853 font usually has a pointsize of “8.”. If you set faceSize to
1854 match the size of the bitmap font, then switching between bit‐
1855 map and TrueType fonts via the font menu will give comparable
1856 sizes for the window.
1857
1858 You can specify the pointsize for TrueType fonts selected with
1859 the other size-related menu entries such as Medium, Huge, etc.,
1860 by using one of the following resource values. If you do not
1861 specify a value, they default to “0.0”, which causes xterm to
1862 use the ratio of font sizes from the corresponding bitmap font
1863 resources to obtain a TrueType pointsize.
1864
1865 If all of the faceSize resources are set, then xterm will use
1866 this information to determine the next smaller/larger TrueType
1867 font for the larger-vt-font() and smaller-vt-font() actions.
1868 If any are not set, xterm will use only the areas of the bitmap
1869 fonts.
1870
1871 faceSize1 (class FaceSize1)
1872 Specifies the pointsize of the first alternative font.
1873
1874 faceSize2 (class FaceSize2)
1875 Specifies the pointsize of the second alternative font.
1876
1877 faceSize3 (class FaceSize3)
1878 Specifies the pointsize of the third alternative font.
1879
1880 faceSize4 (class FaceSize4)
1881 Specifies the pointsize of the fourth alternative font.
1882
1883 faceSize5 (class FaceSize5)
1884 Specifies the pointsize of the fifth alternative font.
1885
1886 faceSize6 (class FaceSize6)
1887 Specifies the pointsize of the sixth alternative font.
1888
1889 font (class Font)
1890 Specifies the name of the normal font. The default is “fixed.”
1891
1892 See the discussion of the locale resource, which describes how
1893 this font may be overridden.
1894
1895 NOTE: some resource files use patterns such as
1896 *font: fixed
1897
1898 which are overly broad, affecting both
1899 xterm.vt100.font
1900
1901 and
1902 xterm.vt100.utf8fonts.font
1903
1904 which is probably not what you intended.
1905
1906 fastScroll (class FastScroll)
1907 Modifies the effect of jump scroll (jumpScroll) by suppressing
1908 screen refreshes for the special case when output to the screen
1909 has completely shifted the contents off-screen. For instance,
1910 cat'ing a large file to the screen does this.
1911
1912 font1 (class Font1)
1913 Specifies the name of the first alternative font.
1914
1915 font2 (class Font2)
1916 Specifies the name of the second alternative font.
1917
1918 font3 (class Font3)
1919 Specifies the name of the third alternative font.
1920
1921 font4 (class Font4)
1922 Specifies the name of the fourth alternative font.
1923
1924 font5 (class Font5)
1925 Specifies the name of the fifth alternative font.
1926
1927 font6 (class Font6)
1928 Specifies the name of the sixth alternative font.
1929
1930 fontDoublesize (class FontDoublesize)
1931 Specifies whether xterm should attempt to use font scaling to
1932 draw double-sized characters. Some older font servers cannot
1933 do this properly, will return misleading font metrics. The
1934 default is “true”. If disabled, xterm will simulate double-
1935 sized characters by drawing normal characters with spaces
1936 between them.
1937
1938 fontWarnings (class FontWarnings)
1939 Specify whether xterm should report an error if it fails to
1940 load a font:
1941
1942 0 Never report an error (though the X libraries may).
1943
1944 1 Report an error if the font name was given as a resource
1945 setting.
1946
1947 2 Always report an error on failure to load a font.
1948
1949 forceBoxChars (class ForceBoxChars)
1950 Specifies whether xterm should assume the normal and bold fonts
1951 have VT100 line-drawing characters:
1952
1953 - The fixed-pitch ISO-8859-*-encoded fonts used by xterm
1954 normally have the VT100 line-drawing glyphs in cells 1-31.
1955 Other fixed-pitch fonts may be more attractive, but lack
1956 these glyphs.
1957
1958 - When using an ISO-10646-1 font and the wideChars resource
1959 is true, xterm uses the Unicode glyphs which match the
1960 VT100 line-drawing glyphs.
1961
1962 If “false”, xterm checks for missing glyphs in the font and
1963 makes line-drawing characters directly as needed. If “true”,
1964 xterm assumes the font does not contain the line-drawing char‐
1965 acters, and draws them directly. The default is “false.”
1966
1967 forcePackedFont (class ForcePackedFont)
1968 Specifies whether xterm should use the maximum or minimum glyph
1969 width when displaying using a bitmap font. Use the maximum
1970 width to help with proportional fonts. The default is “true,”
1971 denoting the minimum width.
1972
1973 foreground (class Foreground)
1974 Specifies the color to use for displaying text in the window.
1975 Setting the class name instead of the instance name is an easy
1976 way to have everything that would normally appear in the text
1977 color change color. The default is “XtDefaultForeground.”
1978
1979 formatOtherKeys (class FormatOtherKeys)
1980 Overrides the format of the escape sequence used to report mod‐
1981 ified keys with the modifyOtherKeys resource.
1982
1983 0 send modified keys as parameters for function-key 27
1984 (default).
1985
1986 1 send modified keys as parameters for CSI u.
1987
1988 freeBoldBox (class FreeBoldBox)
1989 Specifies whether xterm should assume the bounding boxes for
1990 normal and bold fonts are compatible. If “false”, xterm com‐
1991 pares them and will reject choices of bold fonts that do not
1992 match the size of the normal font. The default is “false”,
1993 which means that the comparison is performed.
1994
1995 geometry (class Geometry)
1996 Specifies the preferred size and position of the VT102 window.
1997 There is no default for this resource.
1998
1999 highlightColor (class HighlightColor)
2000 Specifies the color to use for the background of selected
2001 (highlighted) text. If not specified (i.e., matching the
2002 default foreground), reverse video is used. The default is
2003 “XtDefaultForeground.”
2004
2005 highlightColorMode (class HighlightColorMode)
2006 Specifies whether xterm should use highlightTextColor and high‐
2007 lightColor to override the reversed foreground/background col‐
2008 ors in a selection. The default is unspecified: at startup,
2009 xterm checks if those resources are set to something other than
2010 the default foreground and background colors. Setting this
2011 resource disables the check.
2012
2013 The following table shows the interaction of the highlighting
2014 resources, abbreviated as shown to fit in this page:
2015
2016 HCM
2017 highlightColorMode
2018
2019 HR highlightReverse
2020
2021 HBG
2022 highlightColor
2023
2024 HFG
2025 highlightTextColor
2026
2027 HCM HR HBG HFG Highlight
2028 ──────────────────────────────────────────────────────
2029 false false default default bg/fg
2030 false false default set bg/fg
2031 false false set default fg/HBG
2032 false false set set fg/HBG
2033 ──────────────────────────────────────────────────────
2034 false true default default bg/fg
2035 false true default set bg/fg
2036 false true set default fg/HBG
2037 false true set set fg/HBG
2038 ──────────────────────────────────────────────────────
2039 true false default default bg/fg
2040 true false default set HFG/fg
2041 true false set default bg/HBG
2042 true false set set HFG/HBG
2043 ──────────────────────────────────────────────────────
2044 true true default default fg/fg (useless)
2045 true true default set HFG/fg
2046 true true set default fg/HBG
2047 true true set set HFG/HBG
2048 ──────────────────────────────────────────────────────
2049 default false default default bg/fg
2050 default false default set bg/fg
2051 default false set default fg/HBG
2052 default false set set HFG/HBG
2053 ──────────────────────────────────────────────────────
2054 default true default default bg/fg
2055 default true default set bg/fg
2056 default true set default fg/HBG
2057 default true set set HFG/HBG
2058 ──────────────────────────────────────────────────────
2059
2060 highlightReverse (class HighlightReverse)
2061 Specifies whether xterm should reverse the selection foreground
2062 and background colors when selecting text with reverse-video
2063 attribute. This applies only to the highlightColor and high‐
2064 lightTextColor resources, e.g., to match the color scheme of
2065 xwsh. If “true”, xterm reverses the colors, If “false”, xterm
2066 does not reverse colors, The default is “true.”
2067
2068 highlightSelection (class HighlightSelection)
2069 If “false”, selecting with the mouse highlights all positions
2070 on the screen between the beginning of the selection and the
2071 current position. If “true”, xterm highlights only the posi‐
2072 tions that contain text that can be selected. The default is
2073 “false.”
2074
2075 Depending on the way your applications write to the screen,
2076 there may be trailing blanks on a line. Xterm stores data as
2077 it is shown on the screen. Erasing the display changes the
2078 internal state of each cell so it is not considered a blank for
2079 the purpose of selection. Blanks written since the last erase
2080 are selectable. If you do not wish to have trailing blanks in
2081 a selection, use the trimSelection resource.
2082
2083 highlightTextColor (class HighlightTextColor)
2084 Specifies the color to use for the foreground of selected
2085 (highlighted) text. If not specified (i.e., matching the
2086 default background), reverse video is used. The default is
2087 “XtDefaultBackground.”
2088
2089 hpLowerleftBugCompat (class HpLowerleftBugCompat)
2090 Specifies whether to work around a bug in HP's xdb, which
2091 ignores termcap and always sends ESC F to move to the lower
2092 left corner. “true” causes xterm to interpret ESC F as a
2093 request to move to the lower left corner of the screen. The
2094 default is “false.”
2095
2096 i18nSelections (class I18nSelections)
2097 If false, xterm will not request the targets COMPOUND_TEXT or
2098 TEXT. The default is “true.” It may be set to false in order
2099 to work around ICCCM violations by other X clients.
2100
2101 iconBorderColor (class BorderColor)
2102 Specifies the border color for the active icon window if this
2103 feature is compiled into xterm. Not all window managers will
2104 make the icon border visible.
2105
2106 iconBorderWidth (class BorderWidth)
2107 Specifies the border width for the active icon window if this
2108 feature is compiled into xterm. The default is 2. Not all
2109 window managers will make the border visible.
2110
2111 iconFont (class IconFont)
2112 Specifies the font for the miniature active icon window, if
2113 this feature is compiled into xterm. The default is "nil2".
2114
2115 initialFont (class InitialFont)
2116 Specifies which of the VT100 fonts to use initially. Values
2117 are the same as for the set-vt-font action. The default is
2118 “d”, i.e., "default".
2119
2120 inputMethod (class XtCInputMethod)
2121 Tells xterm which type of input method to use. There is no
2122 default method.
2123
2124 internalBorder (class BorderWidth)
2125 Specifies the number of pixels between the characters and the
2126 window border. The default is 2.
2127
2128 italicULMode (class ColorAttrMode)
2129 Specifies whether characters with the underline attribute
2130 should be displayed in an italic font or as underlined charac‐
2131 ters. It is implemented only for TrueType fonts.
2132
2133 jumpScroll (class JumpScroll)
2134 Specifies whether or not jump scroll should be used. This cor‐
2135 responds to the VT102 DECSCLM private mode. The default is
2136 “true.” See fastScroll for a variation.
2137
2138 keepSelection (class KeepSelection)
2139 Specifies whether xterm will keep the selection even after the
2140 selected area was touched by some output to the terminal. The
2141 default is “true”.
2142
2143 keyboardDialect (class KeyboardDialect)
2144 Specifies the initial keyboard dialect, as well as the default
2145 value when the terminal is reset. The value given is the same
2146 as the final character in the control sequences which change
2147 character sets. The default is “B”, which corresponds to US
2148 ASCII.
2149
2150 nameKeymap (class NameKeymap)
2151 See the discussion of the keymap() action.
2152
2153 limitResize (class LimitResize)
2154 Limits resizing of the screen via control sequence to a given
2155 multiple of the display dimensions. The default is “1”.
2156
2157 locale (class Locale)
2158 Specifies how to use luit, an encoding converter between UTF-8
2159 and locale encodings. The resource value (ignoring case) may
2160 be:
2161
2162 true
2163 xterm will use the encoding specified by the users'
2164 LC_CTYPE locale (i.e., LC_ALL, LC_CTYPE, or LANG variables)
2165 as far as possible. This is realized by always enabling
2166 UTF-8 mode and invoking luit in non-UTF-8 locales.
2167
2168 medium
2169 xterm will follow users' LC_CTYPE locale only for UTF-8,
2170 east Asian, and Thai locales, where the encodings were not
2171 supported by conventional 8bit mode with changing fonts.
2172 For other locales, xterm will use conventional 8bit mode.
2173
2174 checkfont
2175 If mini-luit is compiled-in, xterm will check if a Unicode
2176 font has been specified. If so, it checks if the character
2177 encoding for the current locale is POSIX, Latin-1 or
2178 Latin-9, uses the appropriate mapping to support those with
2179 the Unicode font. For other encodings, xterm assumes that
2180 UTF-8 encoding is required.
2181
2182 false
2183 xterm will use conventional 8bit mode or UTF-8 mode accord‐
2184 ing to utf8 resource or -u8 option.
2185
2186 Any other value, e.g., “UTF-8” or “ISO8859-2”, is assumed to be
2187 an encoding name; luit will be invoked to support the encoding.
2188 The actual list of supported encodings depends on luit. The
2189 default is “medium”.
2190
2191 Regardless of your locale and encoding, you need an ISO-10646-1
2192 font to display the result. Your configuration may not include
2193 this font, or locale-support by xterm may not be needed. At
2194 startup, xterm uses a mechanism equivalent to the load-vt-
2195 fonts(utf8Fonts, Utf8Fonts) action to load font name subre‐
2196 sources of the VT100 widget. That is, resource patterns such
2197 as "*vt100.utf8Fonts.font" will be loaded, and (if this
2198 resource is enabled), override the normal fonts. If no subre‐
2199 sources are found, the normal fonts such as "*vt100.font",
2200 etc., are used. The resource files distributed with xterm use
2201 ISO-10646-1 fonts, but do not rely on them unless you are using
2202 the locale mechanism.
2203
2204 localeFilter (class LocaleFilter)
2205 Specifies the file name for the encoding converter from/to
2206 locale encodings and UTF-8 which is used with the -lc option or
2207 locale resource. The help message shown by “xterm -help” lists
2208 the default value, which depends on your system configuration.
2209
2210 If the encoding converter requires command-line parameters, you
2211 should put those within a shell script to execute the con‐
2212 verter, and set this resource to point to the shell script.
2213
2214 loginShell (class LoginShell)
2215 Specifies whether or not the shell to be run in the window
2216 should be started as a login shell. The default is “false.”
2217
2218 marginBell (class MarginBell)
2219 Specifies whether or not the bell should be rung when the user
2220 types near the right margin. The default is “false.”
2221
2222 metaSendsEscape (class MetaSendsEscape)
2223 If “true”, Meta characters (a character combined with the Meta
2224 modifier key) are converted into a two-character sequence with
2225 the character itself preceded by ESC. This applies as well to
2226 function key control sequences, unless xterm sees that Meta is
2227 used in your key translations. If “false”, Meta characters
2228 input from the keyboard are handled according to the eightBit‐
2229 Input resource. The default is “false.”
2230
2231 mkSamplePass (class MkSamplePass)
2232 If mkSampleSize is nonzero, and mkWidth (and cjkWidth) are
2233 false, on startup xterm compares its built-in tables to the
2234 system's wide character width data to decide if it will use the
2235 system's data. It tests the first mkSampleSize character val‐
2236 ues, and allows up to mkSamplePass mismatches before the test
2237 fails. The default (for the allowed number of mismatches) is
2238 256.
2239
2240 mkSampleSize (class MkSampleSize)
2241 With mkSamplePass, this specifies a startup test used for ini‐
2242 tializing wide character width calculations. The default (num‐
2243 ber of characters to check) is 1024.
2244
2245 mkWidth (class MkWidth)
2246 Specifies whether xterm should use a built-in version of the
2247 wide character width calculation. See also the cjkWidth
2248 resource which can override this. The default is “false.”
2249
2250 Here is a summary of the resources which control the choice of
2251 wide character width calculation:
2252
2253 cjkWidth mkWidth Action
2254 ───────────────────────────────────────────────────────────────
2255 false false use system tables subject to mkSamplePass
2256 false true use built-in tables
2257 true false use built-in CJK tables
2258 true true use built-in CJK tables
2259
2260 modifyCursorKeys (class ModifyCursorKeys)
2261 Tells how to handle the special case where Control-, Shift-,
2262 Alt- or Meta-modifiers are used to add a parameter to the
2263 escape sequence returned by a cursor-key. The default is “2”:
2264
2265 Set it to -1 to disable it.
2266 Set it to 0 to use the old/obsolete behavior.
2267 Set it to 1 to prefix modified sequences with CSI.
2268 Set it to 2 to force the modifier to be the second parameter if
2269 it would otherwise be the first.
2270 Set it to 3 to mark the sequence with a “>” to hint that it is
2271 private.
2272
2273 modifyFunctionKeys (class ModifyFunctionKeys)
2274 Tells how to handle the special case where Control-, Shift-,
2275 Alt- or Meta-modifiers are used to add a parameter to the
2276 escape sequence returned by a (numbered) function-key. The
2277 default is “2”. The resource values are similar to modifyCur‐
2278 sorKeys:
2279
2280 Set it to -1 to permit the user to use shift- and control-modi‐
2281 fiers to construct function-key strings using the normal encod‐
2282 ing scheme.
2283 Set it to 0 to use the old/obsolete behavior.
2284 Set it to 1 to prefix modified sequences with CSI.
2285 Set it to 2 to force the modifier to be the second parameter if
2286 it would otherwise be the first.
2287 Set it to 3 to mark the sequence with a “>” to hint that it is
2288 private.
2289
2290 If modifyFunctionKeys is zero, xterm uses Control- and Shift-
2291 modifiers to allow the user to construct numbered function-keys
2292 beyond the set provided by the keyboard:
2293
2294 Control
2295 adds the value given by the ctrlFKeys resource.
2296
2297 Shift
2298 adds twice the value given by the ctrlFKeys resource.
2299
2300 Control/Shift
2301 adds three times the value given by the ctrlFKeys
2302 resource.
2303
2304 As a special case, legacy (when oldFunctionKeys is true) or
2305 vt220 (when sunKeyboard is true) keyboards interpret only the
2306 Control-modifier when constructing numbered function-keys.
2307 This is done to provide compatible keyboards for DEC VT220 and
2308 related terminals that implement user-defined keys (UDK).
2309
2310 modifyOtherKeys (class ModifyOtherKeys)
2311 Like modifyCursorKeys, tells xterm to construct an escape
2312 sequence for other keys (such as "2") when modified by Con‐
2313 trol-, Alt- or Meta-modifiers. This feature does not apply to
2314 function keys and well-defined keys such as ESC or the control
2315 keys. The default is “0”:
2316
2317 0 disables this feature.
2318
2319 1 enables this feature for keys except for those with well-
2320 known behavior, e.g., Tab, Backarrow and some special con‐
2321 trol character cases, e.g., Control-Space to make a NUL.
2322
2323 2 enables this feature for keys including the exceptions
2324 listed.
2325
2326 multiClickTime (class MultiClickTime)
2327 Specifies the maximum time in milliseconds between multi-click
2328 select events. The default is 250 milliseconds.
2329
2330 multiScroll (class MultiScroll)
2331 Specifies whether or not scrolling should be done asyn‐
2332 chronously. The default is “false.”
2333
2334 nMarginBell (class Column)
2335 Specifies the number of characters from the right margin at
2336 which the margin bell should be rung, when enabled by the
2337 marginBell resource. The default is 10.
2338
2339 numLock (class NumLock)
2340 If “true”, xterm checks if NumLock is used as a modifier (see
2341 xmodmap(1)). If so, this modifier is used to simplify the
2342 logic when implementing special NumLock for the sunKeyboard
2343 resource. Also (when sunKeyboard is false), similar logic is
2344 used to find the modifier associated with the left and right
2345 Alt keys. The default is “true.”
2346
2347 oldXtermFKeys (class OldXtermFKeys)
2348 If “true”, xterm will use old-style control sequences for func‐
2349 tion keys F1 to F4, for compatibility with X Consortium xterm.
2350 Otherwise, it uses the VT100-style codes for PF1 to PF4. The
2351 default is “false.”
2352
2353 on2Clicks (class On2Clicks)
2354
2355 on3Clicks (class On3Clicks)
2356
2357 on4Clicks (class On4Clicks)
2358
2359 on5Clicks (class On5Clicks)
2360 Specify selection behavior in response to multiple mouse
2361 clicks. A single mouse click is always interpreted as
2362 described in the SELECTION section (see POINTER USAGE). Multi‐
2363 ple mouse clicks (using the button which activates the select-
2364 start action) are interpreted according to the resource values
2365 of on2Clicks, etc. The resource value can be one of these:
2366
2367 word
2368 Select a “word” as determined by the charClass resource.
2369 See the CHARACTER CLASSES section.
2370
2371 line
2372 Select a line (counting wrapping).
2373
2374 group
2375 Select a group of adjacent lines (counting wrapping). The
2376 selection stops on a blank line, and does not extend outside
2377 the current page.
2378
2379 page
2380 Select all visible lines, i.e., the page.
2381
2382 all
2383 Select all lines, i.e., including the saved lines.
2384
2385 regex
2386 Select a “word” as determined by the regular expression
2387 which follows in the resource value.
2388
2389 none
2390 No selection action is associated with this resource. xterm
2391 interprets it as the end of the list. For example, you may
2392 use it to disable triple (and higher) clicking by setting
2393 on3Clicks to “none”.
2394
2395 The default values for on2Clicks and on3Clicks are “word” and
2396 “line”, respectively. There is no default value for on4Clicks
2397 or on5Clicks, making those inactive. On startup, xterm deter‐
2398 mines the maximum number of clicks by the onXClicks resource
2399 values which are set.
2400
2401 openIm (class XtCOpenIm)
2402 Tells xterm whether to open the input method at startup. The
2403 default is “true”.
2404
2405 pointerColor (class PointerColor)
2406 Specifies the foreground color of the pointer. The default is
2407 “XtDefaultForeground.”
2408
2409 pointerColorBackground (class PointerColorBackground)
2410 Specifies the background color of the pointer. The default is
2411 “XtDefaultBackground.”
2412
2413 pointerMode (class PointerMode)
2414 Specifies when the pointer may be hidden as the user types. It
2415 will be redisplayed if the user moves the mouse, or clicks one
2416 of its buttons.
2417
2418 0 never
2419
2420 1 the application running in xterm has not activated mouse
2421 mode. This is the default.
2422
2423 2 always.
2424
2425 pointerShape (class Cursor)
2426 Specifies the name of the shape of the pointer. The default is
2427 “xterm.”
2428
2429 popOnBell (class PopOnBell)
2430 Specifies whether the window would be raised when Control-G is
2431 received. The default is “false.”
2432
2433 If the window is iconified, this has no effect. However, the
2434 zIconBeep resource provides you with the ability to see which
2435 iconified windows have sounded a bell.
2436
2437 preeditType (class XtCPreeditType)
2438 Tells xterm which types of preedit (preconversion) string to
2439 display. The default is “OverTheSpot,Root”.
2440
2441 printAttributes (class PrintAttributes)
2442 Specifies whether to print graphic attributes along with the
2443 text. A real DEC VTxxx terminal will print the underline,
2444 highlighting codes but your printer may not handle these. A
2445 “0” disables the attributes. A “1” prints the normal set of
2446 attributes (bold, underline, inverse and blink) as VT100-style
2447 control sequences. A “2” prints ANSI color attributes as well.
2448 The default is “1.”
2449
2450 printerAutoClose (class PrinterAutoClose)
2451 If “true”, xterm will close the printer (a pipe) when the
2452 application switches the printer offline with a Media Copy com‐
2453 mand. The default is “false.”
2454
2455 printerCommand (class PrinterCommand)
2456 Specifies a shell command to which xterm will open a pipe when
2457 the first MC (Media Copy) command is initiated. The default is
2458 a blank string. If the resource value is given as a blank
2459 string, the printer is disabled.
2460
2461 printerControlMode (class PrinterControlMode)
2462 Specifies the printer control mode. A “1” selects autoprint
2463 mode, which causes xterm to print a line from the screen when
2464 you move the cursor off that line with a line feed, form feed
2465 or vertical tab character, or an autowrap occurs. Autoprint
2466 mode is overridden by printer controller mode (a “2”), which
2467 causes all of the output to be directed to the printer. The
2468 default is “0.”
2469
2470 printerExtent (class PrinterExtent)
2471 Controls whether a print page function will print the entire
2472 page (true), or only the the portion within the scrolling mar‐
2473 gins (false). The default is “false.”
2474
2475 printerFormFeed (class PrinterFormFeed)
2476 Controls whether a form feed is sent to the printer at the end
2477 of a print page function. The default is “false.”
2478
2479 printerNewLine (class PrinterNewLine)
2480 Controls whether a newline is sent to the printer at the end of
2481 a print page function. The default is “true.”
2482
2483 quietGrab (class QuietGrab)
2484 Controls whether the cursor is repainted when NotifyGrab and
2485 NotifyUngrab event types are received during change of focus.
2486 The default is “false.”
2487
2488 renderFont (class RenderFont)
2489 If xterm is built with the Xft library, this controls whether
2490 the faceName resource is used. The default is “default.”
2491
2492 The resource values are strings, evaluated as booleans after
2493 startup.
2494
2495 false
2496 disable the feature and use the normal (bitmap) font.
2497
2498 true
2499 startup using the TrueType font specified by the faceName
2500 and faceSize resource settings. If there is no value for
2501 faceName, disable the feature and use the normal (bitmap)
2502 font.
2503
2504 After startup, you can still switch to/from the bitmap
2505 font using the “TrueType Fonts” menu entry.
2506
2507 default
2508 startup using the normal (bitmap) font, but enable the
2509 “TrueType Fonts” menu entry to allow runtime switching
2510 to/from TrueType fonts.
2511
2512 If there is no faceName resource set, then runtime switch‐
2513 ing to TrueType fonts is disabled. Xterm has a separate
2514 compiled-in value for faceName for the special case where
2515 renderFont is “default”. That is normally “mono”.
2516
2517 resizeGravity (class ResizeGravity)
2518 Affects the behavior when the window is resized to be taller or
2519 shorter. NorthWest specifies that the top line of text on the
2520 screen stay fixed. If the window is made shorter, lines are
2521 dropped from the bottom; if the window is made taller, blank
2522 lines are added at the bottom. This is compatible with the
2523 behavior in R4. SouthWest (the default) specifies that the
2524 bottom line of text on the screen stay fixed. If the window is
2525 made taller, additional saved lines will be scrolled down onto
2526 the screen; if the window is made shorter, lines will be
2527 scrolled off the top of the screen, and the top saved lines
2528 will be dropped.
2529
2530 retryInputMethod (class XtCRetryInputMethod)
2531 Tells xterm how many times to retry, in case the input-method
2532 server is not responding. This is a different issue than
2533 unsupported preedit type, etc. You may encounter retries if
2534 your X configuration (and its libraries) are missing pieces.
2535 Setting this resource to zero ``0'' will cancel the retrying.
2536 The default is ``3''.
2537
2538 reverseVideo (class ReverseVideo)
2539 Specifies whether or not reverse video should be simulated.
2540 The default is “false.”
2541
2542 reverseWrap (class ReverseWrap)
2543 Specifies whether or not reverse-wraparound should be enabled.
2544 This corresponds to xterm's private mode 45. The default is
2545 “false.”
2546
2547 rightScrollBar (class RightScrollBar)
2548 Specifies whether or not the scrollbar should be displayed on
2549 the right rather than the left. The default is “false.”
2550
2551 saveLines (class SaveLines)
2552 Specifies the number of lines to save beyond the top of the
2553 screen when a scrollbar is turned on. The default is 64.
2554
2555 scrollBar (class ScrollBar)
2556 Specifies whether or not the scrollbar should be displayed.
2557 The default is “false.”
2558
2559 scrollBarBorder (class ScrollBarBorder)
2560 Specifies the width of the scrollbar border. Note that this is
2561 drawn to overlap the border of the xterm window. Modifying the
2562 scrollbar's border affects only the line between the VT100 wid‐
2563 get and the scrollbar. The default value is 1.
2564
2565 scrollKey (class ScrollCond)
2566 Specifies whether or not pressing a key should automatically
2567 cause the scrollbar to go to the bottom of the scrolling
2568 region. This corresponds to xterm's private mode 1011. The
2569 default is “false.”
2570
2571 scrollLines (class ScrollLines)
2572 Specifies the number of lines that the scroll-back and scroll-
2573 forw actions should use as a default. The default value is 1.
2574
2575 scrollTtyOutput (class ScrollCond)
2576 Specifies whether or not output to the terminal should automat‐
2577 ically cause the scrollbar to go to the bottom of the scrolling
2578 region. The default is “true.”
2579
2580 selectToClipboard (class SelectToClipboard)
2581 Tells xterm whether to use the PRIMARY or CLIPBOARD for SELECT
2582 tokens in the selection mechanism. The set-select action can
2583 change this at runtime, allowing the user to work with programs
2584 that handle only one of these mechanisms. The default is
2585 “false”, which tells it to use PRIMARY.
2586
2587 shiftFonts (class ShiftFonts)
2588 Specifies whether to enable the actions larger-vt-font() and
2589 smaller-vt-font(), which are normally bound to the shifted
2590 KP_Add and KP_Subtract. The default is “true.”
2591
2592 showBlinkAsBold (class ShowBlinkAsBold)
2593 Tells xterm whether to display text with blink-attribute the
2594 same as bold. If xterm has not been configured to support
2595 blinking text, the default is “true.”, which corresponds to
2596 older versions of xterm, otherwise the default is “false.”
2597
2598 showMissingGlyphs (class ShowMissingGlyphs)
2599 Tells xterm whether to display a box outlining places where a
2600 character has been used that the font does not represent. The
2601 default is “false.”
2602
2603 signalInhibit (class SignalInhibit)
2604 Specifies whether or not the entries in the “Main Options” menu
2605 for sending signals to xterm should be disallowed. The default
2606 is “false.”
2607
2608 tekGeometry (class Geometry)
2609 Specifies the preferred size and position of the Tektronix win‐
2610 dow. There is no default for this resource.
2611
2612 tekInhibit (class TekInhibit)
2613 Specifies whether or not the escape sequence to enter Tektronix
2614 mode should be ignored. The default is “false.”
2615
2616 tekSmall (class TekSmall)
2617 Specifies whether or not the Tektronix mode window should start
2618 in its smallest size if no explicit geometry is given. This is
2619 useful when running xterm on displays with small screens. The
2620 default is “false.”
2621
2622 tekStartup (class TekStartup)
2623 Specifies whether or not xterm should start up in Tektronix
2624 mode. The default is “false.”
2625
2626 tiXtraScroll (class TiXtraScroll)
2627 Specifies whether xterm should scroll to a new page when pro‐
2628 cessing the ti termcap entry, i.e., the private modes 47, 1047
2629 or 1049. This is only in effect if titeInhibit is “true”,
2630 because the intent of this option is to provide a picture of
2631 the full-screen application's display on the scrollback without
2632 wiping out the text that would be shown before the application
2633 was initialized. The default for this resource is “false.”
2634
2635 titeInhibit (class TiteInhibit)
2636 Specifies whether or not xterm should remove ti and te termcap
2637 entries (used to switch between alternate screens on startup of
2638 many screen-oriented programs) from the TERMCAP string. If
2639 set, xterm also ignores the escape sequence to switch to the
2640 alternate screen. Xterm supports terminfo in a different way,
2641 supporting composite control sequences (also known as private
2642 modes) 1047, 1048 and 1049 which have the same effect as the
2643 original 47 control sequence. The default for this resource is
2644 “false.”
2645
2646 titleModes (class TitleModes)
2647 Tells xterm whether to accept or return window- and icon-labels
2648 in ISO-8859-1 (the default) or UTF-8. Either can be encoded in
2649 hexadecimal. The default for this resource is “0.”
2650
2651 Each bit (bit "0" is 1, bit "1" is 2, etc) corresponds to one
2652 of the parameters set by the title modes control sequence:
2653
2654 0 Set window/icon labels using hexadecimal
2655
2656 1 Query window/icon labels using hexadecimal
2657
2658 2 Set window/icon labels using UTF-8 (overrides utf8Titles
2659 resource).
2660
2661 3 Query window/icon labels using UTF-8
2662
2663 translations (class Translations)
2664 Specifies the key and button bindings for menus, selections,
2665 “programmed strings,” etc. The translations resource, which
2666 provides much of xterm's configurability, is a feature of the X
2667 Toolkit Intrinsics library (Xt). See the ACTIONS section.
2668
2669 trimSelection (class TrimSelection)
2670 If you set highlightSelection, you can see the text which is
2671 selected, including any trailing spaces. Clearing the screen
2672 (or a line) resets it to a state containing no spaces. Some
2673 lines may contain trailing spaces when an application writes
2674 them to the screen. However, you may not wish to paste lines
2675 with trailing spaces. If this resource is true, xterm will
2676 trim trailing spaces from text which is selected. It does not
2677 affect spaces which result in a wrapped line, nor will it trim
2678 the trailing newline from your selection. The default is
2679 “false.”
2680
2681 underLine (class UnderLine)
2682 This specifies whether or not text with the underline attribute
2683 should be underlined. It may be desirable to disable underlin‐
2684 ing when color is being used for the underline attribute. The
2685 default is “true.”
2686
2687 useClipping (class UseClipping)
2688 Tell xterm whether to use clipping to keep from producing dots
2689 outside the text drawing area. Originally used to work around
2690 for overstriking effects, this is also needed to work with some
2691 incorrectly-sized fonts. The default is “true.”
2692
2693 utf8 (class Utf8)
2694 This specifies whether xterm will run in UTF-8 mode. If you
2695 set this resource, xterm also sets the wideChars resource as a
2696 side-effect. The resource is an integer, expected to range
2697 from 0 to 3:
2698
2699 0 UTF-8 mode is initially off. The command-line option +u8
2700 sets the resource to this value. Escape sequences for turn‐
2701 ing UTF-8 mode on/off are allowed.
2702
2703 1 UTF-8 mode is initially on. Escape sequences for turning
2704 UTF-8 mode on/off are allowed.
2705
2706 2 The command-line option -u8 sets the resource to this value.
2707 Escape sequences for turning UTF-8 mode on/off are ignored.
2708
2709 3 This is the default value of the resource. It is changed
2710 during initialization depending on whether the locale
2711 resource was set, to 0 or 2. See the locale resource for
2712 additional discussion of non-UTF-8 locales.
2713
2714 If you want to set the value of utf8, it should be in this
2715 range. Other nonzero values are treated the same as “1”, i.e.,
2716 UTF-8 mode is initially on, and escape sequences for turning
2717 UTF-8 mode on/off are allowed.
2718
2719 utf8Fonts (class Utf8Fonts)
2720 See the discussion of the locale resource.
2721
2722 utf8Latin1 (class Utf8Latin1)
2723 If true, allow an ISO-8859-1 normal font to be combined with an
2724 ISO-10646 font if the latter is given via the -fw option or its
2725 corresponding resource value. The default is “false.”
2726
2727 utf8SelectTypes (class Utf8SelectTypes)
2728 Override xterm's default selection target list (see
2729 SELECT/PASTE) for selections in wide-character (UTF-8) mode.
2730 The default is an empty string, which does not override any‐
2731 thing.
2732
2733 utf8Title (class Utf8Title)
2734 Applications can set xterm's title by writing a control
2735 sequence. Normally this control sequence follows the VT220
2736 convention, which encodes the string in ISO-8859-1 and allows
2737 for an 8-bit string terminator. If xterm is started in a UTF-8
2738 locale, it translates the ISO-8859-1 string to UTF-8 to work
2739 with the X libraries which assume the string is UTF-8.
2740
2741 However, some users may wish to write a title string encoded in
2742 UTF-8. Set this resource to “true” to allow UTF-8 encoded
2743 title strings. That cancels the translation to UTF-8, allowing
2744 UTF-8 strings to be displayed as is.
2745
2746 This feature is available as a menu entry, since it is related
2747 to the particular applications you are running within xterm.
2748 You can also use a control sequence (see the discussion of
2749 "Title Modes" in the control sequences document), to set an
2750 equivalent flag. The titleModes resource sets the same value,
2751 which overrides this resource.
2752
2753 The default is “false.”
2754
2755 veryBoldColors (class VeryBoldColors)
2756 Specifies whether to combine video attributes with colors spec‐
2757 ified by colorBD, colorBL, colorRV and colorUL. The resource
2758 value is the sum of values for each attribute:
2759 1 for reverse,
2760 2 for underline,
2761 4 for bold and
2762 8 for blink.
2763
2764 The default is “0.”
2765
2766 visualBell (class VisualBell)
2767 Specifies whether or not a visible bell (i.e., flashing) should
2768 be used instead of an audible bell when Control-G is received.
2769 The default is “false.”
2770
2771 visualBellDelay (class VisualBellDelay)
2772 Number of milliseconds to delay when displaying a visual bell.
2773 Default is 100. If set to zero, no visual bell is displayed.
2774 This is useful for very slow displays, e.g., an LCD display on
2775 a laptop.
2776
2777 vt100Graphics (class VT100Graphics)
2778 This specifies whether xterm will interpret VT100 graphic char‐
2779 acter escape sequences while in UTF-8 mode. The default is
2780 “true”, to provide support for various legacy applications.
2781
2782 wideBoldFont (class WideBoldFont)
2783 This option specifies the font to be used for displaying bold
2784 wide text. By default, it will attempt to use a font twice as
2785 wide as the font that will be used to draw bold text. If no
2786 double-width font is found, it will improvise, by stretching
2787 the bold font.
2788
2789 wideChars (class WideChars)
2790 Specifies if xterm should respond to control sequences that
2791 process 16-bit characters. The default is “false.”
2792
2793 wideFont (class WideFont)
2794 This option specifies the font to be used for displaying wide
2795 text. By default, it will attempt to use a font twice as wide
2796 as the font that will be used to draw normal text. If no dou‐
2797 ble-width font is found, it will improvise, by stretching the
2798 normal font.
2799
2800 ximFont (class XimFont)
2801 This option specifies the font to be used for displaying the
2802 preedit string in the "OverTheSpot" input method.
2803
2804 In "OverTheSpot" preedit type, the preedit (preconversion)
2805 string is displayed at the position of the cursor. It is the
2806 XIM server's responsibility to display the preedit string. The
2807 XIM client must inform the XIM server of the cursor position.
2808 For best results, the preedit string must be displayed with a
2809 proper font. Therefore, xterm informs the XIM server of the
2810 proper font. The font is be supplied by a "fontset", whose
2811 default value is "*". This matches every font, the X library
2812 automatically chooses fonts with proper charsets. The ximFont
2813 resource is provided to override this default font setting.
2814
2815 Tek4014 Widget Resources
2816 The following resources are specified as part of the tek4014 widget
2817 (class Tek4014). These are specified by patterns such as
2818 "XTerm.tek4014.NAME":
2819
2820 font2 (class Font)
2821 Specifies font number 2 to use in the Tektronix window.
2822
2823 font3 (class Font)
2824 Specifies font number 3 to use in the Tektronix window.
2825
2826 fontLarge (class Font)
2827 Specifies the large font to use in the Tektronix window.
2828
2829 fontSmall (class Font)
2830 Specifies the small font to use in the Tektronix window.
2831
2832 ginTerminator (class GinTerminator)
2833 Specifies what character(s) should follow a GIN report or sta‐
2834 tus report. The possibilities are “none,” which sends no ter‐
2835 minating characters, “CRonly,” which sends CR, and “CR&EOT,”
2836 which sends both CR and EOT. The default is “none.”
2837
2838 height (class Height)
2839 Specifies the height of the Tektronix window in pixels.
2840
2841 initialFont (class InitialFont)
2842 Specifies which of the four Tektronix fonts to use initially.
2843 Values are the same as for the set-tek-text action. The
2844 default is “large.”
2845
2846 width (class Width)
2847 Specifies the width of the Tektronix window in pixels.
2848
2849 Menu Resources
2850 The resources that may be specified for the various menus are described
2851 in the documentation for the Athena SimpleMenu widget. The name and
2852 classes of the entries in each of the menus are listed below.
2853 Resources named "lineN" where N is a number are separators with class
2854 SmeLine.
2855
2856 The mainMenu has the following entries:
2857
2858 toolbar (class SmeBSB)
2859 This entry invokes the set-toolbar(toggle) action.
2860
2861 securekbd (class SmeBSB)
2862 This entry invokes the secure() action.
2863
2864 allowsends (class SmeBSB)
2865 This entry invokes the allow-send-events(toggle) action.
2866
2867 redraw (class SmeBSB)
2868 This entry invokes the redraw() action.
2869
2870 logging (class SmeBSB)
2871 This entry invokes the logging(toggle) action.
2872
2873 print (class SmeBSB)
2874 This entry invokes the print() action.
2875
2876 print-redir (class SmeBSB)
2877 This entry invokes the print-redir() action.
2878
2879 8-bit-control (class SmeBSB)
2880 This entry invokes the set-8-bit-control(toggle) action.
2881
2882 backarrow key (class SmeBSB)
2883 This entry invokes the set-backarrow(toggle) action.
2884
2885 num-lock (class SmeBSB)
2886 This entry invokes the set-num-lock(toggle) action.
2887
2888 alt-esc (class SmeBSB)
2889 This entry invokes the alt-sends-escape(toggle) action.
2890
2891 meta-esc (class SmeBSB)
2892 This entry invokes the meta-sends-escape(toggle) action.
2893
2894 delete-is-del (class SmeBSB)
2895 This entry invokes the delete-is-del(toggle) action.
2896
2897 oldFunctionKeys (class SmeBSB)
2898 This entry invokes the old-function-keys(toggle) action.
2899
2900 hpFunctionKeys (class SmeBSB)
2901 This entry invokes the hp-function-keys(toggle) action.
2902
2903 scoFunctionKeys (class SmeBSB)
2904 This entry invokes the sco-function-keys(toggle) action.
2905
2906 sunFunctionKeys (class SmeBSB)
2907 This entry invokes the sun-function-keys(toggle) action.
2908
2909 sunKeyboard (class SmeBSB)
2910 This entry invokes the sunKeyboard(toggle) action.
2911
2912 suspend (class SmeBSB)
2913 This entry invokes the send-signal(tstp) action on systems that
2914 support job control.
2915
2916 continue (class SmeBSB)
2917 This entry invokes the send-signal(cont) action on systems that
2918 support job control.
2919
2920 interrupt (class SmeBSB)
2921 This entry invokes the send-signal(int) action.
2922
2923 hangup (class SmeBSB)
2924 This entry invokes the send-signal(hup) action.
2925
2926 terminate (class SmeBSB)
2927 This entry invokes the send-signal(term) action.
2928
2929 kill (class SmeBSB)
2930 This entry invokes the send-signal(kill) action.
2931
2932 quit (class SmeBSB)
2933 This entry invokes the quit() action.
2934
2935 The vtMenu has the following entries:
2936
2937 scrollbar (class SmeBSB)
2938 This entry invokes the set-scrollbar(toggle) action.
2939
2940 jumpscroll (class SmeBSB)
2941 This entry invokes the set-jumpscroll(toggle) action.
2942
2943 reversevideo (class SmeBSB)
2944 This entry invokes the set-reverse-video(toggle) action.
2945
2946 autowrap (class SmeBSB)
2947 This entry invokes the set-autowrap(toggle) action.
2948
2949 reversewrap (class SmeBSB)
2950 This entry invokes the set-reversewrap(toggle) action.
2951
2952 autolinefeed (class SmeBSB)
2953 This entry invokes the set-autolinefeed(toggle) action.
2954
2955 appcursor (class SmeBSB)
2956 This entry invokes the set-appcursor(toggle) action.
2957
2958 appkeypad (class SmeBSB)
2959 This entry invokes the set-appkeypad(toggle) action.
2960
2961 scrollkey (class SmeBSB)
2962 This entry invokes the set-scroll-on-key(toggle) action.
2963
2964 scrollttyoutput (class SmeBSB)
2965 This entry invokes the set-scroll-on-tty-output(toggle) action.
2966
2967 allow132 (class SmeBSB)
2968 This entry invokes the set-allow132(toggle) action.
2969
2970 cursesemul (class SmeBSB)
2971 This entry invokes the set-cursesemul(toggle) action.
2972
2973 visualbell (class SmeBSB)
2974 This entry invokes the set-visualbell(toggle) action.
2975
2976 bellIsUrgent (class SmeBSB)
2977 This entry invokes the set-bellIsUrgent(toggle) action.
2978
2979 poponbell (class SmeBSB)
2980 This entry invokes the set-poponbell(toggle) action.
2981
2982 cursorblink (class SmeBSB)
2983 This entry invokes the set-cursorblink(toggle) action.
2984
2985 titeInhibit (class SmeBSB)
2986 This entry invokes the set-titeInhibit(toggle) action.
2987
2988 activeicon (class SmeBSB)
2989 This entry toggles active icons on and off if this feature was
2990 compiled into xterm. It is enabled only if xterm was started
2991 with the command line option +ai or the activeIcon resource is
2992 set to “true.”
2993
2994 softreset (class SmeBSB)
2995 This entry invokes the soft-reset() action.
2996
2997 hardreset (class SmeBSB)
2998 This entry invokes the hard-reset() action.
2999
3000 clearsavedlines (class SmeBSB)
3001 This entry invokes the clear-saved-lines() action.
3002
3003 tekshow (class SmeBSB)
3004 This entry invokes the set-visibility(tek,toggle) action.
3005
3006 tekmode (class SmeBSB)
3007 This entry invokes the set-terminal-type(tek) action.
3008
3009 vthide (class SmeBSB)
3010 This entry invokes the set-visibility(vt,off) action.
3011
3012 altscreen (class SmeBSB)
3013 This entry invokes the set-altscreen(toggle) action.
3014
3015 The fontMenu has the following entries:
3016
3017 fontdefault (class SmeBSB)
3018 This entry invokes the set-vt-font(d) action.
3019
3020 font1 (class SmeBSB)
3021 This entry invokes the set-vt-font(1) action.
3022
3023 font2 (class SmeBSB)
3024 This entry invokes the set-vt-font(2) action.
3025
3026 font3 (class SmeBSB)
3027 This entry invokes the set-vt-font(3) action.
3028
3029 font4 (class SmeBSB)
3030 This entry invokes the set-vt-font(4) action.
3031
3032 font5 (class SmeBSB)
3033 This entry invokes the set-vt-font(5) action.
3034
3035 font6 (class SmeBSB)
3036 This entry invokes the set-vt-font(6) action.
3037
3038 fontescape (class SmeBSB)
3039 This entry invokes the set-vt-font(e) action.
3040
3041 fontsel (class SmeBSB)
3042 This entry invokes the set-vt-font(s) action.
3043
3044 font-linedrawing (class SmeBSB)
3045 This entry invokes the set-font-linedrawing(s) action.
3046
3047 font-packed (class SmeBSB)
3048 This entry invokes the set-font-packed(s) action.
3049
3050 font-doublesize (class SmeBSB)
3051 This entry invokes the set-font-doublesize(s) action.
3052
3053 render-font (class SmeBSB)
3054 This entry invokes the set-render-font(s) action.
3055
3056 utf8-mode (class SmeBSB)
3057 This entry invokes the set-utf8-mode(s) action.
3058
3059 utf8-title (class SmeBSB)
3060 This entry invokes the set-utf8-title(s) action.
3061
3062 The tekMenu has the following entries:
3063
3064 tektextlarge (class SmeBSB)
3065 This entry invokes the set-tek-text(large) action.
3066
3067 tektext2 (class SmeBSB)
3068 This entry invokes the set-tek-text(2) action.
3069
3070 tektext3 (class SmeBSB)
3071 This entry invokes the set-tek-text(3) action.
3072
3073 tektextsmall (class SmeBSB)
3074 This entry invokes the set-tek-text(small) action.
3075
3076 tekpage (class SmeBSB)
3077 This entry invokes the tek-page() action.
3078
3079 tekreset (class SmeBSB)
3080 This entry invokes the tek-reset() action.
3081
3082 tekcopy (class SmeBSB)
3083 This entry invokes the tek-copy() action.
3084
3085 vtshow (class SmeBSB)
3086 This entry invokes the set-visibility(vt,toggle) action.
3087
3088 vtmode (class SmeBSB)
3089 This entry invokes the set-terminal-type(vt) action.
3090
3091 tekhide (class SmeBSB)
3092 This entry invokes the set-visibility(tek,toggle) action.
3093
3094 Scrollbar Resources
3095 The following resources are useful when specified for the Athena
3096 Scrollbar widget:
3097
3098 thickness (class Thickness)
3099 Specifies the width in pixels of the scrollbar.
3100
3101 background (class Background)
3102 Specifies the color to use for the background of the scrollbar.
3103
3104 foreground (class Foreground)
3105 Specifies the color to use for the foreground of the scrollbar.
3106 The “thumb” of the scrollbar is a simple checkerboard pattern
3107 alternating pixels for foreground and background color.
3108
3110 Once the VT102 window is created, xterm allows you to select text and
3111 copy it within the same or other windows.
3112
3113 SELECTION
3114 The selection functions are invoked when the pointer buttons are used
3115 with no modifiers, and when they are used with the “shift” key. The
3116 assignment of the functions described below to keys and buttons may be
3117 changed through the resource database; see ACTIONS below.
3118
3119 Pointer button one (usually left) is used to save text into the cut
3120 buffer. Move the cursor to beginning of the text, and then hold the
3121 button down while moving the cursor to the end of the region and
3122 releasing the button. The selected text is highlighted and is saved in
3123 the global cut buffer and made the PRIMARY selection when the button is
3124 released. Normally (but see the discussion of on2Clicks, etc):
3125
3126 - Double-clicking selects by words.
3127
3128 - Triple-clicking selects by lines.
3129
3130 - Quadruple-clicking goes back to characters, etc.
3131
3132 Multiple-click is determined by the time from button up to button down,
3133 so you can change the selection unit in the middle of a selection.
3134 Logical words and lines selected by double- or triple-clicking may wrap
3135 across more than one screen line if lines were wrapped by xterm itself
3136 rather than by the application running in the window. If the key/but‐
3137 ton bindings specify that an X selection is to be made, xterm will
3138 leave the selected text highlighted for as long as it is the selection
3139 owner.
3140
3141 Pointer button two (usually middle) “types” (pastes) the text from the
3142 PRIMARY selection, if any, otherwise from the cut buffer, inserting it
3143 as keyboard input.
3144
3145 Pointer button three (usually right) extends the current selection.
3146 (Without loss of generality, you can swap “right” and “left” everywhere
3147 in the rest of this paragraph.) If pressed while closer to the right
3148 edge of the selection than the left, it extends/contracts the right
3149 edge of the selection. If you contract the selection past the left
3150 edge of the selection, xterm assumes you really meant the left edge,
3151 restores the original selection, then extends/contracts the left edge
3152 of the selection. Extension starts in the selection unit mode that the
3153 last selection or extension was performed in; you can multiple-click to
3154 cycle through them.
3155
3156 By cutting and pasting pieces of text without trailing new lines, you
3157 can take text from several places in different windows and form a com‐
3158 mand to the shell, for example, or take output from a program and
3159 insert it into your favorite editor. Since cut buffers are globally
3160 shared among different applications, you may regard each as a “file”
3161 whose contents you know. The terminal emulator and other text programs
3162 should be treating it as if it were a text file, i.e., the text is
3163 delimited by new lines.
3164
3165 SCROLLING
3166 The scroll region displays the position and amount of text currently
3167 showing in the window (highlighted) relative to the amount of text
3168 actually saved. As more text is saved (up to the maximum), the size of
3169 the highlighted area decreases.
3170
3171 Clicking button one with the pointer in the scroll region moves the
3172 adjacent line to the top of the display window.
3173
3174 Clicking button three moves the top line of the display window down to
3175 the pointer position.
3176
3177 Clicking button two moves the display to a position in the saved text
3178 that corresponds to the pointer's position in the scrollbar.
3179
3180 TEKTRONIX POINTER
3181 Unlike the VT102 window, the Tektronix window does not allow the copy‐
3182 ing of text. It does allow Tektronix GIN mode, and in this mode the
3183 cursor will change from an arrow to a cross. Pressing any key will
3184 send that key and the current coordinate of the cross cursor. Pressing
3185 button one, two, or three will return the letters “l”, “m”, and “r”,
3186 respectively. If the “shift” key is pressed when a pointer button is
3187 pressed, the corresponding upper case letter is sent. To distinguish a
3188 pointer button from a key, the high bit of the character is set (but
3189 this is bit is normally stripped unless the terminal mode is RAW; see
3190 tty(4) for details).
3191
3193 X clients provide select and paste support by responding to requests
3194 conveyed by the server.
3195
3196 PRIMARY
3197 When configured to use the primary selection, (the default) xterm can
3198 provide the selection data in ways which help to retain character
3199 encoding information as it is pasted.
3200
3201 A user "selects" text on xterm, which highlights the selected text. A
3202 subsequent "paste" to another client forwards a request to the client
3203 owning the selection. If xterm owns the primary selection, it makes
3204 the data available in the form of one or more "selection targets". If
3205 it does not own the primary selection, e.g., if it has released it or
3206 another client has asserted ownership, it relies on cut-buffers to pass
3207 the data. But cut-buffers handle only ISO-8859-1 data (officially -
3208 some clients ignore the rules).
3209
3210 CLIPBOARD
3211 When configured to use the clipboard (see resource selectToClipboard),
3212 the problem with persistence of ownership is bypassed. Otherwise,
3213 there is no difference regarding the data which can be passed via
3214 selection.
3215
3216 SELECTION TARGETS
3217 The different types of data which are passed depend on what the receiv‐
3218 ing client asks for. These are termed selection targets.
3219
3220 When asking for the selection data, xterm tries the following types in
3221 this order:
3222
3223 UTF8_STRING
3224 This is an XFree86 extension, which denotes that the data
3225 is encoded in UTF-8. When xterm is built with wide-charac‐
3226 ter support, it both accepts and provides this type.
3227
3228 TEXT the text is in the encoding which corresponds to your cur‐
3229 rent locale.
3230
3231 COMPOUND_TEXT
3232 this is a format for multiple character set data, such as
3233 multi-lingual text. It can store UTF-8 data as a special
3234 case.
3235
3236 STRING
3237 This is Latin 1 (ISO-8859-1) data.
3238
3239 The middle two (TEXT and COMPOUND_TEXT) are added if xterm is config‐
3240 ured with the i18nSelections resource set to “true”.
3241
3242 UTF8_STRING is preferred (therefore first in the list) since xterm
3243 stores text as Unicode data when running in wide-character mode, and no
3244 translation is needed. On the other hand, TEXT and COMPOUND_TEXT may
3245 require translation. If the translation is incomplete, they will
3246 insert X's “defaultString” whose value cannot be set, and may simply be
3247 empty. Xterm's defaultString resource specifies the string to use for
3248 incomplete translations of the UTF8_STRING.
3249
3250 You can alter the types which xterm tries using the eightBitSelectTypes
3251 or utf8SelectTypes resources. For instance, you might have some spe‐
3252 cific locale setting which does not use UTF-8 encoding. The resource
3253 value is a comma-separated list of the selection targets, which consist
3254 of the names shown. You can use the special name I18N to denote the
3255 optional inclusion of TEXT and COMPOUND_TEXT. The names are matched
3256 ignoring case, and can be abbreviated. The default list can be
3257 expressed in several ways, e.g.,
3258
3259 UTF8_STRING,I18N,STRING
3260 utf8,i18n,string
3261 u,i,s
3262
3264 Xterm has four menus, named mainMenu, vtMenu, fontMenu, and tekMenu.
3265 Each menu pops up under the correct combinations of key and button
3266 presses. Each menu is divided into sections, separated by a horizontal
3267 line. Some menu entries correspond to modes that can be altered. A
3268 check mark appears next to a mode that is currently active. Selecting
3269 one of these modes toggles its state. Other menu entries are commands;
3270 selecting one of these performs the indicated function.
3271
3272 All of the menu entries correspond to X actions. In the list below,
3273 the menu label is shown followed by the action's name in parenthesis.
3274
3275 Main Options
3276 The xterm mainMenu pops up when the “control” key and pointer button
3277 one are pressed in a window. This menu contains items that apply to
3278 both the VT102 and Tektronix windows. There are several sections:
3279
3280 Commands for managing X events:
3281
3282 Toolbar
3283 Clicking on the "Toolbar" menu entry hides the toolbar if
3284 it is visible, and shows it if it is not.
3285
3286 Secure Keyboard (securekbd)
3287 The Secure Keyboard mode is helpful when typing in pass‐
3288 words or other sensitive data in an unsecure environment;
3289 see SECURITY below (but read the limitations carefully).
3290
3291 Allow SendEvents (allowsends)
3292 Specifies whether or not synthetic key and button events
3293 generated using the X protocol SendEvent request should
3294 be interpreted or discarded. This corresponds to the
3295 allowSendEvents resource.
3296
3297 Redraw Window (redraw)
3298 Forces the X display to repaint; useful in some environ‐
3299 ments.
3300
3301 Commands for capturing output:
3302
3303 Log to File (logging)
3304 Captures text sent to the screen in a logfile, as in the
3305 -l logging option.
3306
3307 Print Window (print)
3308 Sends the text of the current window to the program given
3309 in the printerCommand resource.
3310
3311 Redirect to Printer (print-redir)
3312 This sets the printerControlMode to 0 or 2. You can use
3313 this to turn the printer on as if an application had sent
3314 the appropriate control sequence. It is also useful for
3315 switching the printer off if an application turns it on
3316 without resetting the print control mode.
3317
3318 Modes for setting keyboard style:
3319
3320 8-Bit Controls (8-bit-control)
3321 Enabled for VT220 emulation, this controls whether xterm
3322 will send 8-bit control sequences rather than using 7-bit
3323 (ASCII) controls, e.g., sending a byte in the range
3324 128-159 rather than the escape character followed by a
3325 second byte. Xterm always interprets both 8-bit and
3326 7-bit control sequences (see the document Xterm Control
3327 Sequences). This corresponds to the eightBitControl
3328 resource.
3329
3330 Backarrow Key (BS/DEL) (backarrow key)
3331 Modifies the behavior of the backarrow key, making it
3332 transmit either a backspace (8) or delete (127) charac‐
3333 ter. This corresponds to the backarrowKey resource.
3334
3335 Alt/NumLock Modifiers (num-lock)
3336 Controls the treatment of Alt- and NumLock-key modifiers.
3337 This corresponds to the numLock resource.
3338
3339 Meta Sends Escape (meta-esc)
3340 Controls whether Meta keys are converted into a two-char‐
3341 acter sequence with the character itself preceded by ESC.
3342 This corresponds to the metaSendsEscape resource.
3343
3344 Delete is DEL (delete-is-del)
3345 Controls whether the Delete key on the editing keypad
3346 should send DEL (127) or the VT220-style Remove escape
3347 sequence. This corresponds to the deleteIsDEL resource.
3348
3349 Old Function-Keys (oldFunctionKeys)
3350
3351 HP Function-Keys (hpFunctionKeys)
3352
3353 SCO Function-Keys (scoFunctionKeys)
3354
3355 Sun Function-Keys (sunFunctionKeys)
3356
3357 VT220 Keyboard (sunKeyboard)
3358 These act as a radio-button, selecting one style for the
3359 keyboard layout. It corresponds to more than one
3360 resource setting: sunKeyboard, sunFunctionKeys, scoFunc‐
3361 tionKeys and hpFunctionKeys ."
3362
3363 Commands for process signalling:
3364
3365 Send STOP Signal (suspend)
3366
3367 Send CONT Signal (continue)
3368
3369 Send INT Signal (interrupt)
3370
3371 Send HUP Signal (hangup)
3372
3373 Send TERM Signal (terminate)
3374
3375 Send KILL Signal (kill)
3376 These send the SIGTSTP, SIGCONT, SIGINT, SIGHUP, SIGTERM
3377 and SIGKILL signals respectively, to the process group of
3378 the process running under xterm (usually the shell). The
3379 SIGCONT function is especially useful if the user has
3380 accidentally typed CTRL-Z, suspending the process.
3381
3382 Quit (quit)
3383 Stop processing X events except to support the -hold
3384 option, and then send a SIGHUP signal to the the process
3385 group of the process running under xterm (usually the
3386 shell).
3387
3388 VT Options
3389 The vtMenu sets various modes in the VT102 emulation, and is popped up
3390 when the “control” key and pointer button two are pressed in the VT102
3391 window.
3392
3393 VT102/VT220 Modes:
3394
3395 Enable Scrollbar (scrollbar)
3396 Enable (or disable) the scrollbar. This corresponds to
3397 the -sb option and the scrollBar resource.
3398
3399 Enable Jump Scroll (jumpscroll)
3400 Enable (or disable) jump scrolling. This corresponds to
3401 the -j option and the jumpScroll resource.
3402
3403 Enable Reverse Video (reversevideo)
3404 Enable (or disable) reverse-video. This corresponds to
3405 the -rv option and the reverseVideo resource.
3406
3407 Enable Auto Wraparound (autowrap)
3408 Enable (or disable) auto-wraparound. This corresponds to
3409 the -aw option and the autoWrap resource.
3410
3411 Enable Reverse Wraparound (reversewrap)
3412 Enable (or disable) reverse wraparound. This corresponds
3413 to the -rw option and the reverseWrap resource.
3414
3415 Enable Auto Linefeed (autolinefeed)
3416 Enable (or disable) auto-linefeed. This is the VT102 NEL
3417 function, which causes the emulator to emit a linefeed
3418 after each carriage return. There is no corresponding
3419 command-line option or resource setting.
3420
3421 Enable Application Cursor Keys (appcursor)
3422 Enable (or disable) application cursor keys. This corre‐
3423 sponds to the appcursorDefault resource. There is no
3424 corresponding command-line option.
3425
3426 Enable Application Keypad (appkeypad)
3427 Enable (or disable) application keypad keys. This corre‐
3428 sponds to the appkeypadDefault resource. There is no
3429 corresponding command-line option.
3430
3431 Scroll to Bottom on Key Press (scrollkey)
3432 Enable (or disable) scrolling to the bottom of the
3433 scrolling region on a keypress. This corresponds to the
3434 -sk option and the scrollKey resource.
3435
3436 As a special case, the XON / XOFF keys (control/S and
3437 control/Q) are ignored.
3438
3439 Scroll to Bottom on Tty Output (scrollttyoutput)
3440 Enable (or disable) scrolling to the bottom of the
3441 scrolling region on output to the terminal. This corre‐
3442 sponds to the -si option and the scrollTtyOutput
3443 resource.
3444
3445 Allow 80/132 Column Switching (allow132)
3446 Enable (or disable) switching between 80 and 132 columns.
3447 This corresponds to the -132 option and the c132
3448 resource.
3449
3450 Keep Selection (keepSelection)
3451 Tell xterm whether to disown the selection when it stops
3452 highlighting it, e.g., when an application modifies the
3453 display so that it no longer matches the text which has
3454 been highlighted. As long as xterm continues to own the
3455 selection, it can provide the corresponding text to other
3456 clients via cut/paste. This corresponds to the keepSe‐
3457 lection resource. There is no corresponding command-line
3458 option.
3459
3460 Select to Clipboard (selectToClipboard)
3461 Tell xterm whether to use the PRIMARY or CLIPBOARD for
3462 SELECT tokens in the translations resource which maps
3463 keyboard and mouse actions to select/paste actions. This
3464 corresponds to the selectToClipboard resource. There is
3465 no corresponding command-line option.
3466
3467 Enable Visual Bell (visualbell)
3468 Enable (or disable) visible bell (i.e., flashing) instead
3469 of an audible bell. This corresponds to the -vb option
3470 and the visualBell resource.
3471
3472 Enable Bell Urgency (bellIsUrgent)
3473 Enable (or disable) Urgency window manager hint when Con‐
3474 trol-G is received. This corresponds to the bellIsUrgent
3475 resource.
3476
3477 Enable Pop on Bell (poponbell)
3478 Enable (or disable) raising of the window when Control-G
3479 is received. This corresponds to the -pop option and the
3480 popOnBell resource.
3481
3482 Enable Blinking Cursor (cursorblink)
3483 Enable (or disable) the blinking-cursor feature. This
3484 corresponds to the -bc option and the cursorBlink
3485 resource. There is also an escape sequence (see the doc‐
3486 ument Xterm Control Sequences). The menu entry and the
3487 escape sequence states are XOR'd: if both are enabled,
3488 the cursor will not blink, if only one is enabled, the
3489 cursor will blink.
3490
3491 Enable Alternate Screen Switching (titeInhibit)
3492 Enable (or disable) switching between the normal and
3493 alternate screens. This corresponds to the titeInhibit
3494 resource. There is no corresponding command-line option.
3495
3496 Enable Active Icon (activeicon)
3497 Enable (or disable) the active-icon feature. This corre‐
3498 sponds to the -ai option and the activeIcon resource.
3499
3500 VT102/VT220 Commands:
3501
3502 Do Soft Reset (softreset)
3503 Reset scroll regions. This can be convenient when some
3504 program has left the scroll regions set incorrectly
3505 (often a problem when using VMS or TOPS-20). This corre‐
3506 sponds to the VT220 DECSTR control sequence.
3507
3508 Do Full Reset (hardreset)
3509 The full reset entry will clear the screen, reset tabs to
3510 every eight columns, and reset the terminal modes (such
3511 as wrap and smooth scroll) to their initial states just
3512 after xterm has finished processing the command line
3513 options. This corresponds to the VT102 RIS control
3514 sequence, with a few obvious differences. For example,
3515 your session is not disconnected as a real VT102 would
3516 do.
3517
3518 Reset and Clear Saved Lines (clearsavedlines)
3519 Perform a full reset, and also clear the saved lines.
3520
3521 Commands for setting the current screen:
3522
3523 Show Tek Window (tekshow)
3524 When enabled, pops the Tektronix 4014 window up (makes it
3525 visible). When disabled, hides the Tektronix 4014 win‐
3526 dow.
3527
3528 Switch to Tek Mode (tekmode)
3529 When enabled, pops the Tektronix 4014 window up if it is
3530 not already visible, and switches the input stream to
3531 that window. When disabled, hides the Tektronix 4014
3532 window and switches input back to the VTxxx window.
3533
3534 Hide VT Window (vthide)
3535 When enabled, hides the VTxxx window, shows the Tektronix
3536 4014 window if it was not already visible and switches
3537 the input stream to that window. When disabled, shows
3538 the VTxxx window, and switches the input stream to that
3539 window.
3540
3541 Show Alternate Screen (altscreen)
3542 When enabled, shows the alternate screen. When disabled,
3543 shows the normal screen. Note that the normal screen may
3544 have saved lines; the alternate screen does not.
3545
3546 VT Fonts
3547 The fontMenu pops up when when the “control” key and pointer button
3548 three are pressed in a window. It sets the font used in the VT102 win‐
3549 dow, or modifies the way the font is specified or displayed. There are
3550 several sections.
3551
3552 The first section allows you to select the font from a set of alterna‐
3553 tives:
3554
3555 Default (fontdefault)
3556 Set the font to the default, i.e., that given by the
3557 *VT100.font resource.
3558
3559 Unreadable (font1)
3560 Set the font to that given by the *VT100.font1 resource.
3561
3562 Tiny (font2)
3563 Set the font to that given by the *VT100.font2 resource.
3564
3565 Small (font3)
3566 Set the font to that given by the *VT100.font3 resource.
3567
3568 Medium (font4)
3569 Set the font to that given by the *VT100.font4 resource.
3570
3571 Large (font5)
3572 Set the font to that given by the *VT100.font5 resource.
3573
3574 Huge (font6)
3575 Set the font to that given by the *VT100.font6 resource.
3576
3577 Escape Sequence
3578 This allows you to set the font last specified by the Set
3579 Font escape sequence (see the document Xterm Control
3580 Sequences).
3581
3582 Selection (fontsel)
3583 This allows you to set the font specified the current
3584 selection as a font name (if the PRIMARY selection is
3585 owned).
3586
3587 The second section allows you to modify the way it is displayed:
3588
3589 Line-Drawing Characters (font-linedrawing)
3590 When set, tells xterm to draw its own line-drawing char‐
3591 acters. Otherwise it relies on the font containing
3592 these. Compare to the forceBoxChars resource.
3593
3594 Packed Font (font-packed)
3595 When set, tells xterm to use the minimum glyph-width from
3596 a font when displaying characters. Use the maximum width
3597 (unchecked) to help display proportional fonts. Compare
3598 to the forcePackedFont resource.
3599
3600 Doublesized Characters (font-doublesize)
3601 When set, xterm may ask the font server to produce scaled
3602 versions of the normal font, for VT102 double-size char‐
3603 acters.
3604
3605 The third section allows you to modify the way it is specified:
3606
3607 TrueType Fonts (render-font)
3608 If the renderFont and corresponding resources were set,
3609 this is a further control whether xterm will actually use
3610 the Xft library calls to obtain a font.
3611
3612 UTF-8 (utf8-mode)
3613 This controls whether xterm uses UTF-8 encoding of
3614 input/output. It is useful for temporarily switching
3615 xterm to display text from an application which does not
3616 follow the locale settings.
3617
3618 The fourth section allows you to enable or disable special operations
3619 which can be controlled by writing escape sequences to the terminal.
3620 These are disabled if the SendEvents feature is enabled:
3621
3622 Allow Color Ops (allow-font-ops)
3623 This corresponds to the allowColorOps resource. Enable
3624 or disable control sequences that set/query the colors.
3625
3626 Allow Font Ops (allow-font-ops)
3627 This corresponds to the allowFontOps resource. Enable or
3628 disable control sequences that set/query the font.
3629
3630 Allow Tcap Ops (allow-tcap-ops)
3631 Enable or disable control sequences that query the termi‐
3632 nal's notion of its function-key strings, as termcap or
3633 terminfo capabilities. This corresponds to the allowT‐
3634 capOps resource.
3635
3636 Allow Title Ops (allow-title-ops)
3637 Enable or disable control sequences that modify the win‐
3638 dow title or icon name. This corresponds to the allowTi‐
3639 tleOps resource.
3640
3641 Allow Window Ops (allow-window-ops)
3642 Enable or disable extended window control sequences (as
3643 used in dtterm). This corresponds to the allowWindowOps
3644 resource.
3645
3646 TEK Options
3647 The tekMenu sets various modes in the Tektronix emulation, and is
3648 popped up when the “control” key and pointer button two are pressed in
3649 the Tektronix window. The current font size is checked in the modes
3650 section of the menu.
3651
3652 Large Characters (tektextlarge)
3653
3654 #2 Size Characters (tektext2)
3655
3656 #3 Size Characters (tektext3)
3657
3658 Small Characters (tektextsmall)
3659
3660 Commands:
3661
3662 PAGE (tekpage)
3663 Clear the Tektronix window.
3664
3665 RESET (tekreset)
3666
3667 COPY (tekcopy)
3668
3669 Windows:
3670
3671 Show VT Window (vtshow)
3672
3673 Switch to VT Mode (vtmode)
3674
3675 Hide Tek Window (tekhide)
3676
3678 X environments differ in their security consciousness. Most servers,
3679 run under xdm, are capable of using a “magic cookie” authorization
3680 scheme that can provide a reasonable level of security for many people.
3681 If your server is only using a host-based mechanism to control access
3682 to the server (see xhost(1)), then if you enable access for a host and
3683 other users are also permitted to run clients on that same host, it is
3684 possible that someone can run an application which uses the basic ser‐
3685 vices of the X protocol to snoop on your activities, potentially cap‐
3686 turing a transcript of everything you type at the keyboard. Any
3687 process which has access to your X display can manipulate it in ways
3688 that you might not anticipate, even redirecting your keyboard to itself
3689 and sending events to your application's windows. This is true even
3690 with the “magic cookie” authorization scheme. While the allowSendE‐
3691 vents provides some protection against rogue applications tampering
3692 with your programs, guarding against a snooper is harder.
3693
3694 The possibility of an application spying on your keystrokes is of par‐
3695 ticular concern when you want to type in a password or other sensitive
3696 data. The best solution to this problem is to use a better authoriza‐
3697 tion mechanism than is provided by X. Given all of these caveats, a
3698 simple mechanism exists for protecting keyboard input in xterm.
3699
3700 The xterm menu (see MENUS above) contains a Secure Keyboard entry
3701 which, when enabled, attempts to ensure that all keyboard input is
3702 directed only to xterm (using the GrabKeyboard protocol request). When
3703 an application prompts you for a password (or other sensitive data),
3704 you can enable Secure Keyboard using the menu, type in the data, and
3705 then disable Secure Keyboard using the menu again. This ensures that
3706 you know which window is accepting your keystrokes. It cannot ensure
3707 that there are no processes which have access to your X display that
3708 might be observing the keystrokes as well.
3709
3710 Only one X client at a time can grab the keyboard, so when you attempt
3711 to enable Secure Keyboard it may fail. In this case, the bell will
3712 sound. If the Secure Keyboard succeeds, the foreground and background
3713 colors will be exchanged (as if you selected the Reverse Video entry in
3714 the Modes menu); they will be exchanged again when you exit secure
3715 mode. If the colors do not switch, then you should be very suspicious
3716 that you are being spoofed. If the application you are running dis‐
3717 plays a prompt before asking for the password, it is safest to enter
3718 secure mode before the prompt gets displayed, and to make sure that the
3719 prompt gets displayed correctly (in the new colors), to minimize the
3720 probability of spoofing. You can also bring up the menu again and make
3721 sure that a check mark appears next to the entry.
3722
3723 Secure Keyboard mode will be disabled automatically if your xterm win‐
3724 dow becomes iconified (or otherwise unmapped), or if you start up a
3725 reparenting window manager (that places a title bar or other decoration
3726 around the window) while in Secure Keyboard mode. (This is a feature
3727 of the X protocol not easily overcome.) When this happens, the fore‐
3728 ground and background colors will be switched back and the bell will
3729 sound in warning.
3730
3732 Clicking the left pointer button twice in rapid succession (double-
3733 clicking) causes all characters of the same class (e.g., letters, white
3734 space, punctuation) to be selected as a “word”. Since different people
3735 have different preferences for what should be selected (for example,
3736 should filenames be selected as a whole or only the separate subnames),
3737 the default mapping can be overridden through the use of the charClass
3738 (class CharClass) resource.
3739
3740 This resource is a series of comma-separated of range:value pairs. The
3741 range is either a single number or low-high in the range of 0 to 65535,
3742 corresponding to the code for the character or characters to be set.
3743 The value is arbitrary, although the default table uses the character
3744 number of the first character occurring in the set. When not in UTF-8
3745 mode, only the first 256 bytes of this table will be used.
3746
3747 The default table starts as follows -
3748
3749 static int charClass[256] = {
3750 /∗ NUL SOH STX ETX EOT ENQ ACK BEL */
3751 32, 1, 1, 1, 1, 1, 1, 1,
3752 /∗ BS HT NL VT NP CR SO SI */
3753 1, 32, 1, 1, 1, 1, 1, 1,
3754 /∗ DLE DC1 DC2 DC3 DC4 NAK SYN ETB */
3755 1, 1, 1, 1, 1, 1, 1, 1,
3756 /∗ CAN EM SUB ESC FS GS RS US */
3757 1, 1, 1, 1, 1, 1, 1, 1,
3758 /∗ SP ! " # $ % & ' */
3759 32, 33, 34, 35, 36, 37, 38, 39,
3760 /∗ ( ) * + , - . / */
3761 40, 41, 42, 43, 44, 45, 46, 47,
3762 /∗ 0 1 2 3 4 5 6 7 */
3763 48, 48, 48, 48, 48, 48, 48, 48,
3764 /∗ 8 9 : ; < = > ? */
3765 48, 48, 58, 59, 60, 61, 62, 63,
3766 /∗ @ A B C D E F G */
3767 64, 48, 48, 48, 48, 48, 48, 48,
3768 /∗ H I J K L M N O */
3769 48, 48, 48, 48, 48, 48, 48, 48,
3770 /∗ P Q R S T U V W */
3771 48, 48, 48, 48, 48, 48, 48, 48,
3772 /∗ X Y Z [ \ ] ^ _ */
3773 48, 48, 48, 91, 92, 93, 94, 48,
3774 /∗ ` a b c d e f g */
3775 96, 48, 48, 48, 48, 48, 48, 48,
3776 /∗ h i j k l m n o */
3777 48, 48, 48, 48, 48, 48, 48, 48,
3778 /∗ p q r s t u v w */
3779 48, 48, 48, 48, 48, 48, 48, 48,
3780 /∗ x y z { | } ~ DEL */
3781 48, 48, 48, 123, 124, 125, 126, 1,
3782 /∗ x80 x81 x82 x83 IND NEL SSA ESA */
3783 1, 1, 1, 1, 1, 1, 1, 1,
3784 /∗ HTS HTJ VTS PLD PLU RI SS2 SS3 */
3785 1, 1, 1, 1, 1, 1, 1, 1,
3786 /∗ DCS PU1 PU2 STS CCH MW SPA EPA */
3787 1, 1, 1, 1, 1, 1, 1, 1,
3788 /∗ x98 x99 x9A CSI ST OSC PM APC */
3789 1, 1, 1, 1, 1, 1, 1, 1,
3790 /∗ - i c/ L ox Y- | So */
3791 160, 161, 162, 163, 164, 165, 166, 167,
3792 /∗ .. c0 ip << _ R0 - */
3793 168, 169, 170, 171, 172, 173, 174, 175,
3794 /∗ o +- 2 3 ' u q| . */
3795 176, 177, 178, 179, 180, 181, 182, 183,
3796 /∗ , 1 2 >> 1/4 1/2 3/4 ? */
3797 184, 185, 186, 187, 188, 189, 190, 191,
3798 /∗ A` A' A^ A~ A: Ao AE C, */
3799 48, 48, 48, 48, 48, 48, 48, 48,
3800 /∗ E` E' E^ E: I` I' I^ I: */
3801 48, 48, 48, 48, 48, 48, 48, 48,
3802 /∗ D- N~ O` O' O^ O~ O: X */
3803 48, 48, 48, 48, 48, 48, 48, 215,
3804 /∗ O/ U` U' U^ U: Y' P B */
3805 48, 48, 48, 48, 48, 48, 48, 48,
3806 /∗ a` a' a^ a~ a: ao ae c, */
3807 48, 48, 48, 48, 48, 48, 48, 48,
3808 /∗ e` e' e^ e: i` i' i^ i: */
3809 48, 48, 48, 48, 48, 48, 48, 48,
3810 /∗ d n~ o` o' o^ o~ o: -: */
3811 48, 48, 48, 48, 48, 48, 48, 247,
3812 /∗ o/ u` u' u^ u: y' P y: */
3813 48, 48, 48, 48, 48, 48, 48, 48};
3814
3815 For example, the string “33:48,37:48,45-47:48,38:48” indicates that the
3816 exclamation mark, percent sign, dash, period, slash, and ampersand
3817 characters should be treated the same way as characters and numbers.
3818 This is useful for cutting and pasting electronic mailing addresses and
3819 filenames.
3820
3822 It is possible to rebind keys (or sequences of keys) to arbitrary
3823 strings for input, by changing the translations resources for the vt100
3824 or tek4014 widgets. Changing the translations resource for events
3825 other than key and button events is not expected, and will cause unpre‐
3826 dictable behavior. The following actions are provided for use within
3827 the vt100 or tek4014 translations resources:
3828
3829 allow-color-ops(on/off/toggle)
3830 This action set or toggles the allowColorOps resource and is
3831 also invoked by the allow-color-ops entry in fontMenu.
3832
3833 allow-font-ops(on/off/toggle)
3834 This action set or toggles the allowFontOps resource and is
3835 also invoked by the allow-font-ops entry in fontMenu.
3836
3837 allow-send-events(on/off/toggle)
3838 This action set or toggles the allowSendEvents resource and is
3839 also invoked by the allowsends entry in mainMenu.
3840
3841 allow-tcap-ops(on/off/toggle)
3842 This action set or toggles the allowTcapOps resource and is
3843 also invoked by the allow-tcap-ops entry in fontMenu.
3844
3845 allow-title-ops(on/off/toggle)
3846 This action set or toggles the allowTitleOps resource and is
3847 also invoked by the allow-title-ops entry in fontMenu.
3848
3849 allow-window-ops(on/off/toggle)
3850 This action set or toggles the allowWindowOps resource and is
3851 also invoked by the allow-window-ops entry in fontMenu.
3852
3853 alt-sends-escape()
3854 This action toggles the state of the eightBitInput resource.
3855
3856 bell([percent])
3857 This action rings the keyboard bell at the specified percentage
3858 above or below the base volume.
3859
3860 clear-saved-lines()
3861 This action does hard-reset() (see below) and also clears the
3862 history of lines saved off the top of the screen. It is also
3863 invoked from the clearsavedlines entry in vtMenu. The effect
3864 is identical to a hardware reset (RIS) control sequence.
3865
3866 create-menu(m/v/f/t)
3867 This action creates one of the menus used by xterm, if it has
3868 not been previously created. The parameter values are the menu
3869 names: mainMenu, vtMenu, fontMenu, tekMenu, respectively.
3870
3871 dabbrev-expand()
3872 Expands the word before cursor by searching in the preceding
3873 text on the screen and in the scrollback buffer for words
3874 starting with that abbreviation. Repeating dabbrev-expand()
3875 several times in sequence searches for an alternative expansion
3876 by looking farther back. Lack of more matches is signaled by a
3877 beep(). Attempts to expand an empty word (i.e., when cursor is
3878 preceded by a space) yield successively all previous words.
3879 Consecutive identical expansions are ignored. The word here is
3880 defined as a sequence of non-whitespace characters. This fea‐
3881 ture partially emulates the behavior of “dynamic abbreviation”
3882 expansion in Emacs (bound there to M-/). Here is a resource
3883 setting for xterm which will do the same thing:
3884
3885 *VT100*translations: #override \n\
3886 Meta <KeyPress> /:dabbrev-expand()
3887
3888
3889 deiconify()
3890 Changes the window state back to normal, if it was iconified.
3891
3892 delete-is-del()
3893 This action toggles the state of the deleteIsDEL resource.
3894
3895 dired-button()
3896 Handles a button event (other than press and release) by echo‐
3897 ing the event's position (i.e., character line and column) in
3898 the following format:
3899
3900 ^X ESC G <line+“ ”> <col+“ ”>
3901
3902 iconify()
3903 Iconifies the window.
3904
3905 hard-reset()
3906 This action resets the scrolling region, tabs, window size, and
3907 cursor keys and clears the screen. It is also invoked from the
3908 hardreset entry in vtMenu.
3909
3910 ignore()
3911 This action ignores the event but checks for special pointer
3912 position escape sequences.
3913
3914 insert()
3915 This action inserts the character or string associated with the
3916 key that was pressed.
3917
3918 insert-eight-bit()
3919 This action inserts an eight-bit (Meta) version of the charac‐
3920 ter or string associated with the key that was pressed. This
3921 only applies to single-byte values. The exact action depends
3922 on the value of the metaSendsEscape and the eightBitInput
3923 resources. The metaSendsEscape resource is tested first.
3924
3925 The term "eight-bit" is misleading: xterm checks if the key's
3926 value is less than 128. If so, xterm adds 128 to the value,
3927 setting its eighth bit. Otherwise xterm sends an ESC byte
3928 before the key. In other applications' documentation, that is
3929 referred to as a "meta key".
3930
3931 insert-selection(sourcename [, ...])
3932 This action inserts the string found in the selection or cut‐
3933 buffer indicated by sourcename. Sources are checked in the
3934 order given (case is significant) until one is found. Com‐
3935 monly-used selections include: PRIMARY, SECONDARY, and CLIP‐
3936 BOARD. Cut buffers are typically named CUT_BUFFER0 through
3937 CUT_BUFFER7.
3938
3939 insert-seven-bit()
3940 This action is a synonym for insert() The term "seven-bit" is
3941 misleading: it only implies that xterm does not try to add 128
3942 to the key's value as in insert-eight-bit().
3943
3944 interpret(control-sequence)
3945 Interpret the given control sequence locally, i.e., without
3946 passing it to the host. This works by inserting the control
3947 sequence at the front of the input buffer. Use "\" to escape
3948 octal digits in the string. Xt does not allow you to put a
3949 null character (i.e., "\000") in the string.
3950
3951 keymap(name)
3952 This action dynamically defines a new translation table whose
3953 resource name is name with the suffix Keymap (case is signifi‐
3954 cant). The name None restores the original translation table.
3955
3956 larger-vt-font()
3957 Set the font to the next larger one, based on the font dimen‐
3958 sions. See also set-vt-font().
3959
3960 load-vt-fonts(name[,class])
3961 Load fontnames from the given subresource name and class. That
3962 is, load the "*VT100.name.font", resource as "*VT100.font" etc.
3963 If no name is given, the original set of fontnames is restored.
3964
3965 Unlike set-vt-font(), this does not affect the escape- and
3966 select-fonts, since those are not based on resource values. It
3967 does affect the fonts loosely organized under the “Default”
3968 menu entry, including font, boldFont, wideFont and wideBold‐
3969 Font.
3970
3971 maximize()
3972 Resizes the window to fill the screen.
3973
3974 meta-sends-escape()
3975 This action toggles the state of the metaSendsEscape resource.
3976
3977 popup-menu(menuname)
3978 This action displays the specified popup menu. Valid names
3979 (case is significant) include: mainMenu, vtMenu, fontMenu, and
3980 tekMenu.
3981
3982 print(printer-flags)
3983 This action prints the window and is also invoked by the print
3984 entry in mainMenu.
3985
3986 The action accepts optional parameters, which temporarily over‐
3987 ride resource settings. The parameter values are matched
3988 ignoring case:
3989
3990 noFormFeed
3991 no form feed will be sent at the end of the last line
3992 printed (i.e., printerFormFeed is ``false'').
3993
3994 FormFeed
3995 a form feed will be sent at the end of the last line
3996 printed (i.e., printerFormFeed is ``true'').
3997
3998 noNewLine
3999 no newline will be sent at the end of the last line
4000 printed, and wrapped lines will be combined into long
4001 lines (i.e., printerNewLine is ``false'').
4002
4003 NewLine
4004 a newline will be sent at the end of the last line
4005 printed, and each line will be limited (by adding a new‐
4006 line) to the screen width (i.e., printerNewLine is
4007 ``true'').
4008
4009 noAttrs
4010 the page is printed without attributes (i.e., printAt‐
4011 tributes is ``0'').
4012
4013 monoAttrs
4014 the page is printed with monochrome (vt220) attributes
4015 (i.e., printAttributes is ``1'').
4016
4017 colorAttrs
4018 the page is printed with ANSI color attributes (i.e.,
4019 printAttributes is ``2'').
4020
4021 print-everything(printer-flags)
4022 This action sends the entire text history, in addition to the
4023 text currently visible, to the program given in the printerCom‐
4024 mand resource. It allows the same optional parameters as the
4025 print action. With a suitable printer command, the action can
4026 be used to load the text history in an editor.
4027
4028 print-redir()
4029 This action toggles the printerControlMode between 0 and 2.
4030 The corresponding popup menu entry is useful for switching the
4031 printer off if you happen to change your mind after deciding to
4032 print random binary files on the terminal.
4033
4034 quit() This action sends a SIGHUP to the subprogram and exits. It is
4035 also invoked by the quit entry in mainMenu.
4036
4037 readline-button()
4038 Supports the optional readline feature by echoing repeated cur‐
4039 sor forward or backward control sequences on button release
4040 event, to request that the host application update its notion
4041 of the cursor's position to match the button event.
4042
4043 redraw()
4044 This action redraws the window and is also invoked by the
4045 redraw entry in mainMenu.
4046
4047 restore()
4048 Restores the window to the size before it was last maximized.
4049
4050 scroll-back(count [,units [,mouse] ])
4051 This action scrolls the text window backward so that text that
4052 had previously scrolled off the top of the screen is now visi‐
4053 ble.
4054
4055 The count argument indicates the number of units (which may be
4056 page, halfpage, pixel, or line) by which to scroll.
4057
4058 An adjustment can be specified for these values by appending a
4059 "+" or "-" sign followed by a number, e.g., page-2 to specify 2
4060 lines less than a page.
4061
4062 If the third parameter mouse is given, the action is ignored
4063 when mouse reporting is enabled.
4064
4065 scroll-forw(count [,units [,mouse] ])
4066 This action is similar to scroll-back except that it scrolls in
4067 the other direction.
4068
4069 secure()
4070 This action toggles the Secure Keyboard mode described in the
4071 section named SECURITY, and is invoked from the securekbd entry
4072 in mainMenu.
4073
4074 scroll-lock(on/off/toggle)
4075 This action toggles internal state which tells xterm whether
4076 Scroll Lock is active, subject to the allowScrollLock resource.
4077
4078 select-cursor-end(destname [, ...])
4079 This action is similar to select-end except that it should be
4080 used with select-cursor-start.
4081
4082 select-cursor-extend()
4083 This action is similar to select-extend except that it should
4084 be used with select-cursor-start.
4085
4086 select-cursor-start()
4087 This action is similar to select-start except that it begins
4088 the selection at the current text cursor position.
4089
4090 select-end(destname [, ...])
4091 This action puts the currently selected text into all of the
4092 selections or cutbuffers specified by destname.
4093
4094 select-extend()
4095 This action tracks the pointer and extends the selection. It
4096 should only be bound to Motion events.
4097
4098 select-set()
4099 This action stores text that corresponds to the current selec‐
4100 tion, without affecting the selection mode.
4101
4102 select-start()
4103 This action begins text selection at the current pointer loca‐
4104 tion. See the section on POINTER USAGE for information on mak‐
4105 ing selections.
4106
4107 send-signal(signame)
4108 This action sends the signal named by signame to the xterm sub‐
4109 process (the shell or program specified with the -e command
4110 line option) and is also invoked by the suspend, continue,
4111 interrupt, hangup, terminate, and kill entries in mainMenu.
4112 Allowable signal names are (case is not significant): tstp (if
4113 supported by the operating system), suspend (same as tstp),
4114 cont (if supported by the operating system), int, hup, term,
4115 quit, alrm, alarm (same as alrm) and kill.
4116
4117 set-8-bit-control(on/off/toggle)
4118 This action toggles the eightBitControl resource and is also
4119 invoked from the 8-bit-control entry in vtMenu.
4120
4121 set-allow132(on/off/toggle)
4122 This action toggles the c132 resource and is also invoked from
4123 the allow132 entry in vtMenu.
4124
4125 set-altscreen(on/off/toggle)
4126 This action toggles between the alternate and current screens.
4127
4128 set-appcursor(on/off/toggle)
4129 This action toggles the handling Application Cursor Key mode
4130 and is also invoked by the appcursor entry in vtMenu.
4131
4132 set-appkeypad(on/off/toggle)
4133 This action toggles the handling of Application Keypad mode and
4134 is also invoked by the appkeypad entry in vtMenu.
4135
4136 set-autolinefeed(on/off/toggle)
4137 This action toggles automatic insertion of linefeeds and is
4138 also invoked by the autolinefeed entry in vtMenu.
4139
4140 set-autowrap(on/off/toggle)
4141 This action toggles automatic wrapping of long lines and is
4142 also invoked by the autowrap entry in vtMenu.
4143
4144 set-backarrow(on/off/toggle)
4145 This action toggles the backarrowKey resource and is also
4146 invoked from the backarrow key entry in vtMenu.
4147
4148 set-bellIsUrgent(on/off/toggle)
4149 This action toggles the bellIsUrgent resource and is also
4150 invoked by the bellIsUrgent entry in vtMenu.
4151
4152 set-cursorblink(on/off/toggle)
4153 This action toggles the cursorBlink resource and is also
4154 invoked from the cursorblink entry in vtMenu.
4155
4156 set-cursesemul(on/off/toggle)
4157 This action toggles the curses resource and is also invoked
4158 from the cursesemul entry in vtMenu.
4159
4160 set-font-doublesize(on/off/toggle)
4161 This action toggles the fontDoublesize resource and is also
4162 invoked by the font-doublesize entry in fontMenu.
4163
4164 set-hp-function-keys(on/off/toggle)
4165 This action toggles the hpFunctionKeys resource and is also
4166 invoked by the hpFunctionKeys entry in mainMenu.
4167
4168 set-jumpscroll(on/off/toggle)
4169 This action toggles the jumpscroll resource and is also invoked
4170 by the jumpscroll entry in vtMenu.
4171
4172 set-font-linedrawing(on/off/toggle)
4173 This action toggles the xterm's state regarding whether the
4174 current font has line-drawing characters and whether it should
4175 draw them directly. It is also invoked by the font-linedrawing
4176 entry in fontMenu.
4177
4178 set-font-packed(on/off/toggle)
4179 This action toggles the forcePackedFont's resource which con‐
4180 trols use of the font's minimum or maximum glyph width. It is
4181 also invoked by the font-packed entry in fontMenu.
4182
4183 set-keep-selection(on/off/toggle)
4184 This action toggles the keepSelection resource and is also
4185 invoked by the keepSelection entry in vtMenu.
4186
4187 set-logging()
4188 This action toggles the state of the logging option.
4189
4190 set-old-function-keys(on/off/toggle)
4191 This action toggles the state of legacy function keys and is
4192 also invoked by the oldFunctionKeys entry in mainMenu.
4193
4194 set-marginbell(on/off/toggle)
4195 This action toggles the marginBell resource.
4196
4197 set-num-lock()
4198 This action toggles the state of the numLock resource.
4199
4200 set-pop-on-bell(on/off/toggle)
4201 This action toggles the popOnBell resource and is also invoked
4202 by the poponbell entry in vtMenu.
4203
4204 set-render-font(on/off/toggle)
4205 This action toggles the renderFont resource and is also invoked
4206 by the render-font entry in fontMenu.
4207
4208 set-reverse-video(on/off/toggle)
4209 This action toggles the reverseVideo resource and is also
4210 invoked by the reversevideo entry in vtMenu.
4211
4212 set-reversewrap(on/off/toggle)
4213 This action toggles the reverseWrap resource and is also
4214 invoked by the reversewrap entry in vtMenu.
4215
4216 set-scroll-on-key(on/off/toggle)
4217 This action toggles the scrollKey resource and is also invoked
4218 from the scrollkey entry in vtMenu.
4219
4220 set-scroll-on-tty-output(on/off/toggle)
4221 This action toggles the scrollTtyOutput resource and is also
4222 invoked from the scrollttyoutput entry in vtMenu.
4223
4224 set-scrollbar(on/off/toggle)
4225 This action toggles the scrollbar resource and is also invoked
4226 by the scrollbar entry in vtMenu.
4227
4228 set-select(on/off/toggle)
4229 This action toggles the selectToClipboard resource and is also
4230 invoked by the selectToClipboard entry in vtMenu.
4231
4232 set-sco-function-keys(on/off/toggle)
4233 This action toggles the scoFunctionKeys resource and is also
4234 invoked by the scoFunctionKeys entry in mainMenu.
4235
4236 set-sun-function-keys(on/off/toggle)
4237 This action toggles the sunFunctionKeys resource and is also
4238 invoked by the sunFunctionKeys entry in mainMenu.
4239
4240 set-sun-keyboard(on/off/toggle)
4241 This action toggles the sunKeyboard resource and is also
4242 invoked by the sunKeyboard entry in mainMenu.
4243
4244 set-tek-text(large/2/3/small)
4245 This action sets font used in the Tektronix window to the value
4246 of the resources tektextlarge, tektext2, tektext3, and tek‐
4247 textsmall according to the argument. It is also invoked by the
4248 entries of the same names as the resources in tekMenu.
4249
4250 set-terminal-type(type)
4251 This action directs output to either the vt or tek windows,
4252 according to the type string. It is also invoked by the tek‐
4253 mode entry in vtMenu and the vtmode entry in tekMenu.
4254
4255 set-titeInhibit(on/off/toggle)
4256 This action toggles the titeInhibit resource, which controls
4257 switching between the alternate and current screens.
4258
4259 set-toolbar(on/off/toggle)
4260 This action toggles the toolbar feature and is also invoked by
4261 the toolbar entry in mainMenu.
4262
4263 set-utf8-mode(on/off/toggle)
4264 This action toggles the utf8 resource and is also invoked by
4265 the utf8-mode entry in fontMenu.
4266
4267 set-utf8-title(on/off/toggle)
4268 This action toggles the utf8Title resource and is also invoked
4269 by the utf8-title entry in fontMenu.
4270
4271 set-visibility(vt/tek,on/off/toggle)
4272 This action controls whether or not the vt or tek windows are
4273 visible. It is also invoked from the tekshow and vthide
4274 entries in vtMenu and the vtshow and tekhide entries in tek‐
4275 Menu.
4276
4277 set-visual-bell(on/off/toggle)
4278 This action toggles the visualBell resource and is also invoked
4279 by the visualbell entry in vtMenu.
4280
4281 set-vt-font(d/1/2/3/4/5/6/e/s [,normalfont [, boldfont]])
4282 This action sets the font or fonts currently being used in the
4283 VT102 window. The first argument is a single character that
4284 specifies the font to be used:
4285
4286 d or D indicate the default font (the font initially used when
4287 xterm was started),
4288
4289 1 through 6 indicate the fonts specified by the font1 through
4290 font6 resources,
4291
4292 e or E indicate the normal and bold fonts that have been set
4293 through escape codes (or specified as the second and
4294 third action arguments, respectively), and
4295
4296 s or S indicate the font selection (as made by programs such as
4297 xfontsel(1)) indicated by the second action argument.
4298
4299 If xterm is configured to support wide characters, an addi‐
4300 tional two optional parameters are recognized for the e argu‐
4301 ment: wide font and wide bold font.
4302
4303 smaller-vt-font()
4304 Set the font to the next smaller one, based on the font dimen‐
4305 sions. See also set-vt-font().
4306
4307 soft-reset()
4308 This action resets the scrolling region and is also invoked
4309 from the softreset entry in vtMenu. The effect is identical to
4310 a soft reset (DECSTR) control sequence.
4311
4312 spawn-new-terminal(params)
4313 Spawn a new xterm process. This is available on systems which
4314 have a modern version of the process filesystem, e.g., "/proc",
4315 which xterm can read.
4316
4317 Use the "cwd" process entry, e.g., /proc/12345/cwd to obtain
4318 the working directory of the process which is running in the
4319 current xterm.
4320
4321 On systems which have the "exe" process entry, e.g.,
4322 /proc/12345/exe, use this to obtain the actual executable.
4323 Otherwise, use the $PATH variable to find xterm.
4324
4325 If parameters are given in the action, pass them to the new
4326 xterm process.
4327
4328 start-extend()
4329 This action is similar to select-start except that the selec‐
4330 tion is extended to the current pointer location.
4331
4332 start-cursor-extend()
4333 This action is similar to select-extend except that the selec‐
4334 tion is extended to the current text cursor position.
4335
4336 string(string)
4337 This action inserts the specified text string as if it had been
4338 typed. Quotation is necessary if the string contains white‐
4339 space or non-alphanumeric characters. If the string argument
4340 begins with the characters “0x”, it is interpreted as a hex
4341 character constant.
4342
4343 tek-copy()
4344 This action copies the escape codes used to generate the cur‐
4345 rent window contents to a file in the current directory begin‐
4346 ning with the name COPY. It is also invoked from the tekcopy
4347 entry in tekMenu.
4348
4349 tek-page()
4350 This action clears the Tektronix window and is also invoked by
4351 the tekpage entry in tekMenu.
4352
4353 tek-reset()
4354 This action resets the Tektronix window and is also invoked by
4355 the tekreset entry in tekMenu.
4356
4357 vi-button()
4358 Handles a button event (other than press and release) by echo‐
4359 ing a control sequence computed from the event's line number in
4360 the screen relative to the current line:
4361
4362 ESC ^P
4363 or
4364 ESC ^N
4365
4366 according to whether the event is before, or after the current
4367 line, respectively. The ^N (or ^P) is repeated once for each
4368 line that the event differs from the current line. The control
4369 sequence is omitted altogether if the button event is on the
4370 current line.
4371
4372 visual-bell()
4373 This action flashes the window quickly.
4374
4375 The Tektronix window also has the following action:
4376
4377 gin-press(l/L/m/M/r/R)
4378 This action sends the indicated graphics input code.
4379
4380 The default bindings in the VT102 window use the SELECT token, which is
4381 set by the selectToClipboard resource:
4382
4383 Shift <KeyPress> Prior:scroll-back(1,halfpage) \n\
4384 Shift <KeyPress> Next:scroll-forw(1,halfpage) \n\
4385 Shift <KeyPress> Select:select-cursor-start() \
4386 select-cursor-end(SELECT, CUT_BUFFER0) \n\
4387 Shift <KeyPress> Insert:insert-selection(SELECT, CUT_BUFFER0) \n\
4388 <KeyRelease> Scroll_Lock:scroll-lock() \n\
4389 Shift~Ctrl <KeyPress> KP_Add:larger-vt-font() \n\
4390 Shift Ctrl <KeyPress> KP_Add:smaller-vt-font() \n\
4391 Shift <KeyPress> KP_Subtract:smaller-vt-font() \n\
4392 ~Meta <KeyPress>:insert-seven-bit() \n\
4393 Meta <KeyPress>:insert-eight-bit() \n\
4394 !Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
4395 !Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
4396 !Lock Ctrl @Num_Lock <Btn1Down>:popup-menu(mainMenu) \n\
4397 ! @Num_Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
4398 ~Meta <Btn1Down>:select-start() \n\
4399 ~Meta <Btn1Motion>:select-extend() \n\
4400 !Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
4401 !Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
4402 !Lock Ctrl @Num_Lock <Btn2Down>:popup-menu(vtMenu) \n\
4403 ! @Num_Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
4404 ~Ctrl ~Meta <Btn2Down>:ignore() \n\
4405 Meta <Btn2Down>:clear-saved-lines() \n\
4406 ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0) \n\
4407 !Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
4408 !Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
4409 !Lock Ctrl @Num_Lock <Btn3Down>:popup-menu(fontMenu) \n\
4410 ! @Num_Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
4411 ~Ctrl ~Meta <Btn3Down>:start-extend() \n\
4412 ~Meta <Btn3Motion>:select-extend() \n\
4413 Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4414 Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4415 Lock @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4416 @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4417 <Btn4Down>:scroll-back(5,line,m) \n\
4418 Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4419 Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4420 Lock @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4421 @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4422 <Btn5Down>:scroll-forw(5,line,m) \n\
4423 <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n\
4424 <BtnDown>:ignore()
4425
4426
4427 The default bindings for the scrollbar widget are separate from the
4428 VT100 widget:
4429
4430 <Btn5Down>: StartScroll(Forward) \n\
4431 <Btn1Down>: StartScroll(Forward) \n\
4432 <Btn2Down>: StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
4433 <Btn3Down>: StartScroll(Backward) \n\
4434 <Btn4Down>: StartScroll(Backward) \n\
4435 <Btn2Motion>: MoveThumb() NotifyThumb() \n\
4436 <BtnUp>: NotifyScroll(Proportional) EndScroll()
4437
4438
4439 The default bindings in the Tektronix window are:
4440
4441 ~Meta<KeyPress>: insert-seven-bit() \n\
4442 Meta<KeyPress>: insert-eight-bit() \n\
4443 !Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
4444 !Lock Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
4445 !Lock Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
4446 !Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
4447 !Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
4448 !Lock Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
4449 !Lock Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
4450 !Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
4451 Shift ~Meta<Btn1Down>: gin-press(L) \n\
4452 ~Meta<Btn1Down>: gin-press(l) \n\
4453 Shift ~Meta<Btn2Down>: gin-press(M) \n\
4454 ~Meta<Btn2Down>: gin-press(m) \n\
4455 Shift ~Meta<Btn3Down>: gin-press(R) \n\
4456 ~Meta<Btn3Down>: gin-press(r)
4457
4458
4459 Here is an example which uses shifted select/paste to copy to the clip‐
4460 board, and unshifted select/paste for the primary selection. In each
4461 case, a (different) cut buffer is also a target or source of the
4462 select/paste operation. It is important to remember however, that cut
4463 buffers store data in ISO-8859-1 encoding, while selections can store
4464 data in a variety of formats and encodings. While xterm owns the
4465 selection, it highlights it. When it loses the selection, it removes
4466 the corresponding highlight. But you can still paste from the corre‐
4467 sponding cut buffer.
4468
4469 *VT100*translations: #override \n\
4470 ~Shift~Ctrl<Btn2Up>: insert-selection(PRIMARY, CUT_BUFFER0) \n\
4471 Shift~Ctrl<Btn2Up>: insert-selection(CLIPBOARD, CUT_BUFFER1) \n\
4472 ~Shift<BtnUp>: select-end(PRIMARY, CUT_BUFFER0) \n\
4473 Shift<BtnUp>: select-end(CLIPBOARD, CUT_BUFFER1)
4474
4475
4476 Below is a sample how of the keymap() action is used to add special
4477 keys for entering commonly-typed works:
4478
4479 *VT100.Translations: #override <Key>F13: keymap(dbx)
4480 *VT100.dbxKeymap.translations: \
4481 <Key>F14: keymap(None) \n\
4482 <Key>F17: string("next") string(0x0d) \n\
4483 <Key>F18: string("step") string(0x0d) \n\
4484 <Key>F19: string("continue") string(0x0d) \n\
4485 <Key>F20: string("print ") insert-selection(PRIMARY, CUT_BUFFER0)
4486
4487
4488 Some people prefer using the left pointer button for dragging the
4489 scrollbar thumb. That can be setup by altering the translations
4490 resource, e.g.,
4491
4492 *VT100.scrollbar.translations:#override \n\
4493 <Btn5Down>:StartScroll(Forward) \n\
4494 <Btn1Down>:StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
4495 <Btn4Down>:StartScroll(Backward) \n\
4496 <Btn1Motion>:MoveThumb() NotifyThumb() \n\
4497 <BtnUp>: NotifyScroll(Proportional) EndScroll()
4498
4499
4501 The Xterm Control Sequences document lists the control sequences which
4502 an application can send xterm to make it perform various operations.
4503 Most of these operations are standardized, from either the DEC or Tek‐
4504 tronix terminals, or from more widely used standards such as ISO-6429.
4505
4507 Xterm sets several environment variables:
4508
4509 DISPLAY
4510 is the display name, pointing to the X server (see DISPLAY NAMES
4511 in X(7)).
4512
4513 TERM is set according to the termcap (or terminfo) entry which it is
4514 using as a reference.
4515
4516 WINDOWID
4517 is set to the X window id number of the xterm window.
4518
4519 XTERM_LOCALE
4520 shows the locale which was used by xterm on startup. Some shell
4521 initialization scripts may set a different locale.
4522
4523 XTERM_SHELL
4524 is set to the pathname of the program which is invoked. Usually
4525 that is a shell program, e.g., /bin/sh. Since it is not necessar‐
4526 ily a shell program however, it is distinct from “SHELL”.
4527
4528 XTERM_VERSION
4529 is set to the string displayed by the -version option. That is
4530 normally an identifier for the X Window libraries used to build
4531 xterm, followed by xterm's patch number in parenthesis. The patch
4532 number is also part of the response to a Secondary Device
4533 Attributes (DA) control sequence (see Xterm Control Sequences).
4534
4535 Depending on your system configuration, xterm may also set the follow‐
4536 ing:
4537
4538 COLUMNS
4539 the width of the xterm in characters (cf: "stty columns").
4540
4541 HOME when xterm is configured to update utmp.
4542
4543 LINES
4544 the height of the xterm in characters (cf: "stty rows").
4545
4546 LOGNAME
4547 when xterm is configured to update utmp.
4548
4549 SHELL
4550 when xterm is configured to update utmp. It is also set if you
4551 provide the shell name as the optional parameter.
4552
4553 TERMCAP
4554 the contents of the termcap entry corresponding to $TERM, with
4555 lines and columns values substituted for the actual size window
4556 you have created.
4557
4558 TERMINFO
4559 may be defined to a nonstandard location in the configure script.
4560
4562 The actual pathnames given may differ on your system.
4563
4564 /etc/utmp
4565 the system logfile, which records user logins.
4566
4567 /etc/wtmp
4568 the system logfile, which records user logins and logouts.
4569
4570 /usr/share/X11/app-defaults/XTerm
4571 the xterm default application resources.
4572
4573 /usr/share/X11/app-defaults/XTerm-color
4574 the xterm color application resources. If your display supports
4575 color, use this
4576 *customization: -color
4577 in your .Xdefaults file to automatically use this resource file
4578 rather than /usr/share/X11/app-defaults/XTerm. If you do not do
4579 this, xterm uses its compiled-in default resource settings for
4580 colors.
4581
4583 Most of the fatal error messages from xterm use the following format:
4584 xterm: Error XXX, errno YYY: ZZZ
4585 The XXX codes (which are used by xterm as its exit-code) are listed
4586 below, with a brief explanation.
4587
4588 1 is used for miscellaneous errors, usually accompanied by a spe‐
4589 cific message,
4590
4591 11 ERROR_FIONBIO
4592 main: ioctl() failed on FIONBIO
4593
4594 12 ERROR_F_GETFL
4595 main: ioctl() failed on F_GETFL
4596
4597 13 ERROR_F_SETFL
4598 main: ioctl() failed on F_SETFL
4599
4600 14 ERROR_OPDEVTTY
4601 spawn: open() failed on /dev/tty
4602
4603 15 ERROR_TIOCGETP
4604 spawn: ioctl() failed on TIOCGETP
4605
4606 17 ERROR_PTSNAME
4607 spawn: ptsname() failed
4608
4609 18 ERROR_OPPTSNAME
4610 spawn: open() failed on ptsname
4611
4612 19 ERROR_PTEM
4613 spawn: ioctl() failed on I_PUSH/"ptem"
4614
4615 20 ERROR_CONSEM
4616 spawn: ioctl() failed on I_PUSH/"consem"
4617
4618 21 ERROR_LDTERM
4619 spawn: ioctl() failed on I_PUSH/"ldterm"
4620
4621 22 ERROR_TTCOMPAT
4622 spawn: ioctl() failed on I_PUSH/"ttcompat"
4623
4624 23 ERROR_TIOCSETP
4625 spawn: ioctl() failed on TIOCSETP
4626
4627 24 ERROR_TIOCSETC
4628 spawn: ioctl() failed on TIOCSETC
4629
4630 25 ERROR_TIOCSETD
4631 spawn: ioctl() failed on TIOCSETD
4632
4633 26 ERROR_TIOCSLTC
4634 spawn: ioctl() failed on TIOCSLTC
4635
4636 27 ERROR_TIOCLSET
4637 spawn: ioctl() failed on TIOCLSET
4638
4639 28 ERROR_INIGROUPS
4640 spawn: initgroups() failed
4641
4642 29 ERROR_FORK
4643 spawn: fork() failed
4644
4645 30 ERROR_EXEC
4646 spawn: exec() failed
4647
4648 32 ERROR_PTYS
4649 get_pty: not enough ptys
4650
4651 34 ERROR_PTY_EXEC
4652 waiting for initial map
4653
4654 35 ERROR_SETUID
4655 spawn: setuid() failed
4656
4657 36 ERROR_INIT
4658 spawn: can't initialize window
4659
4660 46 ERROR_TIOCKSET
4661 spawn: ioctl() failed on TIOCKSET
4662
4663 47 ERROR_TIOCKSETC
4664 spawn: ioctl() failed on TIOCKSETC
4665
4666 49 ERROR_LUMALLOC
4667 luit: command-line malloc failed
4668
4669 50 ERROR_SELECT
4670 in_put: select() failed
4671
4672 54 ERROR_VINIT
4673 VTInit: can't initialize window
4674
4675 57 ERROR_KMMALLOC1
4676 HandleKeymapChange: malloc failed
4677
4678 60 ERROR_TSELECT
4679 Tinput: select() failed
4680
4681 64 ERROR_TINIT
4682 TekInit: can't initialize window
4683
4684 71 ERROR_BMALLOC2
4685 SaltTextAway: malloc() failed
4686
4687 80 ERROR_LOGEXEC
4688 StartLog: exec() failed
4689
4690 83 ERROR_XERROR
4691 xerror: XError event
4692
4693 84 ERROR_XIOERROR
4694 xioerror: X I/O error
4695
4696 90 ERROR_SCALLOC
4697 Alloc: calloc() failed on base
4698
4699 91 ERROR_SCALLOC2
4700 Alloc: calloc() failed on rows
4701
4702 102 ERROR_SAVE_PTR
4703 ScrnPointers: malloc/realloc() failed
4704
4705 121 ERROR_MMALLOC
4706 my_memmove: malloc/realloc failed
4707
4709 Large pastes do not work on some systems. This is not a bug in xterm;
4710 it is a bug in the pseudo terminal driver of those systems. xterm
4711 feeds large pastes to the pty only as fast as the pty will accept data,
4712 but some pty drivers do not return enough information to know if the
4713 write has succeeded.
4714
4715 Many of the options are not resettable after xterm starts.
4716
4717 This program still needs to be rewritten. It should be split into very
4718 modular sections, with the various emulators being completely separate
4719 widgets that do not know about each other. Ideally, you'd like to be
4720 able to pick and choose emulator widgets and stick them into a single
4721 control widget.
4722
4723 There needs to be a dialog box to allow entry of the Tek COPY file
4724 name.
4725
4727 resize(1), luit(1), X(7), pty(4), tty(4)
4728 Xterm Control Sequences (this is the file ctlseqs.ms).
4729
4730 http://invisible-island.net/xterm/xterm.html
4731 http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
4732
4734 Far too many people, including:
4735
4736 Loretta Guarino Reid (DEC-UEG-WSL), Joel McCormack (DEC-UEG-WSL), Terry
4737 Weissman (DEC-UEG-WSL), Edward Moy (Berkeley), Ralph R. Swick (MIT-
4738 Athena), Mark Vandevoorde (MIT-Athena), Bob McNamara (DEC-MAD), Jim
4739 Gettys (MIT-Athena), Bob Scheifler (MIT X Consortium), Doug Mink (SAO),
4740 Steve Pitschke (Stellar), Ron Newman (MIT-Athena), Jim Fulton (MIT X
4741 Consortium), Dave Serisky (HP), Jonathan Kamens (MIT-Athena), Jason
4742 Bacon, Stephen P. Wall, David Wexelblat, and Thomas Dickey (invisible-
4743 island.net).
4744
4745
4746
4747 X Window System XTERM(1)