1XTERM(1)                    General Commands Manual                   XTERM(1)
2
3
4

NAME

6       xterm - terminal emulator for X
7

SYNOPSIS

9       xterm [-toolkitoption ...] [-option ...] [shell]
10

DESCRIPTION

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

EMULATIONS

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

OTHER FEATURES

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

OPTIONS

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.  This font must be the same height and width as the  nor‐
268               mal  font.   If  only one of the normal or bold fonts is speci‐
269               fied, it will be used as the normal font and the bold font will
270               be  produced  by  overstriking this font.  The default is to do
271               overstriking of the normal font.  See also  the  discussion  of
272               boldFont, boldMode and alwaysBoldMode resources.
273
274       -fa pattern
275               This  option  sets  the  pattern  for  fonts  selected from the
276               FreeType library if support for that library was compiled  into
277               xterm.   This corresponds to the faceName resource.  When a CJK
278               double-width font is specified, you also need to  turn  on  the
279               cjkWidth  resource.   See  also  the renderFont resource, which
280               combines with this to determine whether FreeType fonts are ini‐
281               tially active.
282
283       -fbb    This option indicates that xterm should compare normal and bold
284               fonts bounding boxes to ensure they are  compatible.   It  sets
285               the freeBoldBox resource to “false”.
286
287       +fbb    This  option indicates that xterm should not compare normal and
288               bold fonts bounding boxes to ensure they  are  compatible.   It
289               sets the freeBoldBox resource to “true”.
290
291       -fbx    This  option  indicates  that  xterm should not assume that the
292               normal and bold fonts have VT100 line-drawing  characters.   If
293               any  are  missing, xterm will draw the characters directly.  It
294               sets the forceBoxChars resource to “false”.
295
296       +fbx    This option indicates that xterm should assume that the  normal
297               and bold fonts have VT100 line-drawing characters.  It sets the
298               forceBoxChars resource to “true”.
299
300       -fd pattern
301               This option sets the pattern for  double-width  fonts  selected
302               from  the FreeType library if support for that library was com‐
303               piled into xterm.  This corresponds to  the  faceNameDoublesize
304               resource.
305
306       -fi font
307               This  option sets the font for active icons if that feature was
308               compiled into xterm.  See also the discussion of  the  iconFont
309               resource.
310
311       -fs size
312               This  option  sets  the  pointsize  for fonts selected from the
313               FreeType library if support for that library was compiled  into
314               xterm.  This corresponds to the faceSize resource.
315
316       -fw font
317               This  option  specifies the font to be used for displaying wide
318               text.  By default, it will attempt to use a font twice as  wide
319               as  the font that will be used to draw normal text.  If no dou‐
320               ble-width font is found, it will improvise, by  stretching  the
321               normal font.  This corresponds to the wideFont resource.
322
323       -fwb font
324               This  option  specifies the font to be used for displaying bold
325               wide text.  By default, it will attempt to use a font twice  as
326               wide  as  the  font that will be used to draw bold text.  If no
327               double-width font is found, it will  improvise,  by  stretching
328               the bold font.  This corresponds to the wideBoldFont resource.
329
330       -fx font
331               This  option  specifies  the font to be used for displaying the
332               preedit string in the "OverTheSpot" input method.  See also the
333               discussion of the ximFont resource.
334
335       -hc color
336               (see -selbg).
337
338       -hf     This  option indicates that HP Function Key escape codes should
339               be generated for function keys.   It  sets  the  hpFunctionKeys
340               resource to “true”.
341
342       +hf     This  option indicates that HP Function Key escape codes should
343               not be generated for function keys.  It sets the hpFunctionKeys
344               resource to “false”.
345
346       -hm     Tells  xterm  to  use  highlightTextColor and highlightColor to
347               override the reversed foreground/background colors in a  selec‐
348               tion.  It sets the highlightColorMode resource to “true”.
349
350       +hm     Tells xterm not to use highlightTextColor and highlightColor to
351               override the reversed foreground/background colors in a  selec‐
352               tion.  It sets the highlightColorMode resource to “false”.
353
354       -hold   Turn  on  the  hold  resource, i.e., xterm will not immediately
355               destroy its window when the shell command completes.   It  will
356               wait  until you use the window manager to destroy/kill the win‐
357               dow, or if you use the menu entries that send a  signal,  e.g.,
358               HUP or KILL.
359
360       +hold   Turn  off  the  hold  resource,  i.e.,  xterm  will immediately
361               destroy its window when the shell command completes.
362
363       -ie     Turn on the ptyInitialErase resource, i.e., use the pseudo-ter‐
364               minal's sense of the stty erase value.
365
366       +ie     Turn off the ptyInitialErase resource, i.e., set the stty erase
367               value using the kb string from the termcap entry  as  a  refer‐
368               ence, if available.
369
370       -im     Turn  on the useInsertMode resource, which forces use of insert
371               mode by adding appropriate entries to the  TERMCAP  environment
372               variable.
373
374       +im     Turn off the useInsertMode resource.
375
376       -into windowId
377               Given  an  X  window identifier (a decimal integer), xterm will
378               reparent its top-level shell widget to that  window.   This  is
379               used to embed xterm within other applications.
380
381       -j      This  option indicates that xterm should do jump scrolling.  It
382               corresponds to the  jumpScroll  resource.   Normally,  text  is
383               scrolled  one  line at a time; this option allows xterm to move
384               multiple lines at a time so  that  it  does  not  fall  as  far
385               behind.   Its  use is strongly recommended since it makes xterm
386               much faster when scanning through large amounts of  text.   The
387               VT100 escape sequences for enabling and disabling smooth scroll
388               as well as the “VT Options” menu can be used to turn this  fea‐
389               ture on or off.
390
391       +j      This option indicates that xterm should not do jump scrolling.
392
393       -k8     This   option   sets   the   allowC1Printable  resource.   When
394               allowC1Printable is set, xterm overrides the mapping of C1 con‐
395               trol characters (code 128-159) to treat them as printable.
396
397       +k8     This option resets the allowC1Printable resource.
398
399       -kt keyboardtype
400               This  option  sets  the keyboardType resource.  Possible values
401               include: “unknown”, “default”, “hp”, “sco”, “sun”,  “tcap”  and
402               “vt220”.
403
404               The  value  “unknown”,  causes the corresponding resource to be
405               ignored.
406
407               The  value  “default”,  suppresses  the  associated   resources
408               hpFunctionKeys, scoFunctionKeys, sunFunctionKeys, tcapFunction‐
409               Keys and sunKeyboard, using the Sun/PC keyboard layout.
410
411       -l      Turn logging on.  Normally logging is  not  supported,  due  to
412               security  concerns.   Some  versions  of xterm may have logging
413               enabled.  The logfile is written to the  directory  from  which
414               xterm is invoked.  The filename is generated, of the form
415
416                    XtermLog.XXXXXX
417
418               or
419
420                    Xterm.log.hostname.yyyy.mm.dd.hh.mm.ss.XXXXXX
421
422               depending on how xterm was built.
423
424       +l      Turn logging off.
425
426       -lc     Turn  on  support  of various encodings according to the users'
427               locale setting, i.e., LC_ALL,  LC_CTYPE,  or  LANG  environment
428               variables.   This  is  achieved by turning on UTF-8 mode and by
429               invoking luit  for  conversion  between  locale  encodings  and
430               UTF-8.   (luit  is  not invoked in UTF-8 locales.)  This corre‐
431               sponds to the locale resource.
432
433               The actual list of encodings which are supported is  determined
434               by  luit.   Consult  the  luit manual page for further details.
435               See also the discussion of the -u8 option which supports  UTF-8
436               locales.
437
438       +lc     Turn  off  support  of automatic selection of locale encodings.
439               Conventional 8bit mode or, in UTF-8 locales or with -u8 option,
440               UTF-8 mode will be used.
441
442       -lcc path
443               File  name  for the encoding converter from/to locale encodings
444               and UTF-8 which is used with -lc  option  or  locale  resource.
445               This corresponds to the localeFilter resource.
446
447       -leftbar
448               Force  scrollbar to the left side of VT100 screen.  This is the
449               default, unless you have set the rightScrollBar resource.
450
451       -lf filename
452               Specify the log-filename.  See the -l option.
453
454       -ls     This option indicates that the shell that  is  started  in  the
455               xterm  window  will be a login shell (i.e., the first character
456               of argv[0] will be a dash, indicating  to  the  shell  that  it
457               should read the user's .login or .profile).
458
459               The  -ls  flag and the loginShell resource are ignored if -e is
460               also given, because xterm does not know how to make  the  shell
461               start  the  given  command  after whatever it does when it is a
462               login shell - the user's shell of choice need not be  a  Bourne
463               shell  after all.  Also, xterm -e is supposed to provide a con‐
464               sistent functionality for other applications that need to start
465               text-mode  programs  in  a  window,  and if loginShell were not
466               ignored, the result of ~/.profile might interfere with that.
467
468               If you do want the effect of -ls and -e simultaneously, you may
469               get away with something like
470                      xterm -e /bin/bash -l -c "my command here"
471
472               Finally,  -ls  is  not completely ignored, because xterm -ls -e
473               does write a /var/log/wtmp entry  (if  configured  to  do  so),
474               whereas xterm -e does not.
475
476       -maximized
477               This  option indicates that xterm should ask the window manager
478               to maximize its layout on startup.   This  corresponds  to  the
479               maximized resource.
480
481               Maximizing  is not the reverse of iconifying; it is possible to
482               do both with certain window managers.
483
484       +maximized
485               This option indicates that xterm should ask the window  manager
486               to maximize its layout on startup.
487
488       +ls     This option indicates that the shell that is started should not
489               be a login shell (i.e., it will be a normal “subshell”).
490
491       -mb     This option indicates that xterm should ring a margin bell when
492               the  user  types near the right end of a line.  This option can
493               be turned on and off from the “VT Options” menu.
494
495       +mb     This option indicates that margin bell should not be rung.
496
497       -mc milliseconds
498               This option specifies  the  maximum  time  between  multi-click
499               selections.
500
501       -mesg   Turn  off the messages resource, i.e., disallow write access to
502               the terminal.
503
504       +mesg   Turn on the messages resource, i.e., allow write access to  the
505               terminal.
506
507       -mk_width
508               Set  the  mkWidth  resource  to “true”.  This makes xterm use a
509               built-in version of the wide-character width calculation.   The
510               default is “false”
511
512       +mk_width
513               Reset the mkWidth resource.
514
515       -ms color
516               This option specifies the color to be used for the pointer cur‐
517               sor.  The default is to use the foreground  color.   This  sets
518               the pointerColor resource.
519
520       -nb number
521               This  option  specifies the number of characters from the right
522               end of a line at which the margin bell, if enabled, will  ring.
523               The default is 10.
524
525       -nul    This option disables the display of underlining.
526
527       +nul    This option enables the display of underlining.
528
529       -pc     This  option enables the PC-style use of bold colors (see bold‐
530               Colors resource).
531
532       +pc     This option disables the PC-style use of bold colors.
533
534       -pob    This option indicates that the window should be raised whenever
535               a Control-G is received.
536
537       +pob    This  option  indicates  that  the  window should not be raised
538               whenever a Control-G is received.
539
540       -rightbar
541               Force scrollbar to the right side of VT100 screen.
542
543       -rvc    This option disables the display  of  characters  with  reverse
544               attribute as color.
545
546       +rvc    This  option  enables  the  display  of characters with reverse
547               attribute as color.
548
549       -rw     This  option  indicates  that  reverse-wraparound   should   be
550               allowed.   This  allows the cursor to back up from the leftmost
551               column of one line to the  rightmost  column  of  the  previous
552               line.  This is very useful for editing long shell command lines
553               and is encouraged.  This option can be turned on and  off  from
554               the “VT Options” menu.
555
556       +rw     This  option  indicates  that  reverse-wraparound should not be
557               allowed.
558
559       -s      This option indicates that  xterm  may  scroll  asynchronously,
560               meaning  that the screen does not have to be kept completely up
561               to date while scrolling.  This allows xterm to run faster  when
562               network  latencies  are  very high and is typically useful when
563               running across a very large internet or many gateways.
564
565       +s      This option indicates that xterm should scroll synchronously.
566
567       -samename
568               Does not send title and icon  name  change  requests  when  the
569               request  would  have  no effect: the name is not changed.  This
570               has the advantage of preventing flicker and the disadvantage of
571               requiring  an  extra  round  trip to the server to find out the
572               previous value.  In practice this should never be a problem.
573
574       +samename
575               Always send title and icon name change requests.
576
577       -sb     This option indicates  that  some  number  of  lines  that  are
578               scrolled  off  the top of the window should be saved and that a
579               scrollbar should be  displayed  so  that  those  lines  can  be
580               viewed.   This  option  may  be  turned on and off from the “VT
581               Options” menu.
582
583       +sb     This option indicates that a scrollbar should not be displayed.
584
585       -selbg color
586               This option specifies the color to use for  the  background  of
587               selected  text.   If not specified, reverse video is used.  See
588               the discussion of the highlightColor resource.
589
590       -selfg color
591               This option specifies the color to use for selected  text.   If
592               not  specified,  reverse  video is used.  See the discussion of
593               the highlightTextColor resource.
594
595       -sf     This option indicates that Sun Function Key escape codes should
596               be generated for function keys.
597
598       +sf     This  option indicates that the standard escape codes should be
599               generated for function keys.
600
601       -si     This option indicates that output to a window should not  auto‐
602               matically  reposition the screen to the bottom of the scrolling
603               region.  This option can be turned on  and  off  from  the  “VT
604               Options” menu.
605
606       +si     This  option  indicates that output to a window should cause it
607               to scroll to the bottom.
608
609       -sk     This option indicates that  pressing  a  key  while  using  the
610               scrollbar  to  review  previous  lines of text should cause the
611               window to be repositioned automatically in the normal  position
612               at the bottom of the scroll region.
613
614       +sk     This  option  indicates  that  pressing  a  key while using the
615               scrollbar should not cause the window to be repositioned.
616
617       -sl number
618               This option specifies the number of lines  to  save  that  have
619               been  scrolled  off the top of the screen.  This corresponds to
620               the saveLines resource.  The default is 64.
621
622       -sm     This option, corresponding to the  sessionMgt  resource,  indi‐
623               cates that xterm should set up session manager callbacks.
624
625       +sm     This option indicates that xterm should not set up session man‐
626               ager callbacks.
627
628       -sp     This option indicates that Sun/PC keyboard should  be  assumed,
629               providing  mapping  for  keypad “+' to “,', and CTRL-F1 to F13,
630               CTRL-F2 to F14, etc.
631
632       +sp     This option indicates that the standard escape codes should  be
633               generated for keypad and function keys.
634
635       -t      This  option  indicates  that  xterm  should start in Tektronix
636               mode, rather than in VT102 mode.   Switching  between  the  two
637               windows  is done using the “Options” menus.  Termcap(5) entries
638               that  work  with   xterm   “tek4014,”   “tek4015,”   “tek4012,”
639               “tek4013,” “tek4010,” and “dumb.”  xterm automatically searches
640               the termcap file in this order for these entries and then  sets
641               the “TERM” and the “TERMCAP” environment variables.
642
643       +t      This option indicates that xterm should start in VT102 mode.
644
645       -tb     This  option,  corresponding to the toolBar resource, indicates
646               that xterm should display a toolbar (or menubar) at the top  of
647               its window.  The buttons in the toolbar correspond to the popup
648               menus, e.g., control/left/mouse for "Main Options".
649
650       +tb     This option indicates that xterm should not set up a toolbar.
651
652       -ti term_id
653               Specify the name used by xterm to select the  correct  response
654               to terminal ID queries.  It also specifies the emulation level,
655               used to  determine  the  type  of  response  to  a  DA  control
656               sequence.   Valid values include vt52, vt100, vt101, vt102, and
657               vt220 (the "vt" is  optional).   The  default  is  vt100.   The
658               term_id  argument  specifies  the terminal ID to use.  (This is
659               the same as the decTerminalID resource).
660
661       -tm string
662               This option specifies a series  of  terminal  setting  keywords
663               followed  by the characters that should be bound to those func‐
664               tions, similar to the stty program.   The  keywords  and  their
665               values are described in detail in the ttyModes resource.
666
667       -tn name
668               This  option  specifies the name of the terminal type to be set
669               in the  TERM  environment  variable.   It  corresponds  to  the
670               termName resource.  This terminal type must exist in the termi‐
671               nal database (termcap or terminfo, depending on  how  xterm  is
672               built)  and  should  have li# and co# entries.  If the terminal
673               type is not  found,  xterm  uses  the  built-in  list  “xterm”,
674               “vt102”, etc.
675
676       -u8     This  option  sets  the utf8 resource.  When utf8 is set, xterm
677               interprets incoming data as UTF-8.   This  sets  the  wideChars
678               resource  as  a  side-effect,  but  the  UTF-8 mode set by this
679               option prevents it from being turned off.  If you must turn  it
680               on and off, use the wideChars resource.
681
682               This option and the utf8 resource are overridden by the -lc and
683               -en options and locale resource.  That is, if  xterm  has  been
684               compiled  to  support  luit,  and  the  locale  resource is not
685               “false” this option is ignored.  We  recommend  using  the  -lc
686               option  or  the  “locale: true”  resource in UTF-8 locales when
687               your operating system supports locale, or -en UTF-8  option  or
688               the  “locale: UTF-8”  resource  when your operating system does
689               not support locale.
690
691       +u8     This option resets the utf8 resource.
692
693       -uc     This option makes the cursor underlined instead of a box.
694
695       +uc     This option makes the cursor a box instead of underlined.
696
697       -ulc    This option disables the display of characters  with  underline
698               attribute as color rather than with underlining.
699
700       +ulc    This  option  enables  the display of characters with underline
701               attribute as color rather than with underlining.
702
703       -ulit   This option, corresponding to the italicULMode  resource,  dis‐
704               ables  the  display  of  characters with underline attribute as
705               italics rather than with underlining.
706
707       +ulit   This  option,  corresponding  to  the  italicULMode   resource,
708               enables  the  display of characters with underline attribute as
709               italics rather than with underlining.
710
711       -ut     This option indicates that xterm should not write a record into
712               the the system utmp log file.
713
714       +ut     This option indicates that xterm should write a record into the
715               system utmp log file.
716
717       -vb     This option indicates that a visual bell is preferred  over  an
718               audible  one.   Instead of ringing the terminal bell whenever a
719               Control-G is received, the window will be flashed.
720
721       +vb     This option indicates that a visual bell should not be used.
722
723       -wc     This option sets the wideChars  resource.   When  wideChars  is
724               set, xterm maintains internal structures for 16-bit characters.
725               If you do not set this resource to “true”,  xterm  will  ignore
726               the  escape  sequence  which  turns UTF-8 mode on and off.  The
727               default is “false”.
728
729       +wc     This option resets the wideChars resource.
730
731       -wf     This option indicates that xterm should wait for the window  to
732               be mapped the first time before starting the subprocess so that
733               the initial terminal size settings  and  environment  variables
734               are  correct.   It is the application's responsibility to catch
735               subsequent terminal size changes.
736
737       +wf     This option indicates that xterm should not wait before  start‐
738               ing the subprocess.
739
740       -ziconbeep percent
741               Same  as  zIconBeep  resource.   If percent is non-zero, xterms
742               that produce output while iconified will cause an  XBell  sound
743               at  the  given  volume  and  have "***" prepended to their icon
744               titles.  Most window managers will detect this  change  immedi‐
745               ately,  showing  you  which  window has the output.  (A similar
746               feature was in x10 xterm.)
747
748       -C      This option indicates that this window should  receive  console
749               output.   This is not supported on all systems.  To obtain con‐
750               sole output, you must be the owner of the console  device,  and
751               you  must  have  read  and write permission for it.  If you are
752               running X under xdm on the console screen you may need to  have
753               the  session  startup  and reset programs explicitly change the
754               ownership of the console device in order to get this option  to
755               work.
756
757       -Sccn   This  option  allows  xterm  to  be used as an input and output
758               channel for an existing program and is sometimes used  in  spe‐
759               cialized applications.  The option value specifies the last few
760               letters of the name of a pseudo-terminal to use in slave  mode,
761               plus  the  number  of  the  inherited  file descriptor.  If the
762               option contains a “/” character, that delimits  the  characters
763               used  for  the  pseudo-terminal  name from the file descriptor.
764               Otherwise, exactly two characters are used from the option  for
765               the pseudo-terminal name, the remainder is the file descriptor.
766               Examples:
767                      -S123/45
768                      -Sab34
769
770               Note that xterm does not close any file descriptor which it did
771               not  open for its own use.  It is possible (though probably not
772               portable) to have an application  which  passes  an  open  file
773               descriptor  down  to  xterm  past  the initialization or the -S
774               option to a process running in the xterm.
775
776       The following command line arguments  are  provided  for  compatibility
777       with  older versions.  They may not be supported in the next release as
778       the X Toolkit provides standard options that accomplish the same task.
779
780       %geom   This option specifies the preferred size and  position  of  the
781               Tektronix  window.  It is shorthand for specifying the “*tekGe‐
782               ometry” resource.
783
784        #geom  This option specifies the preferred position of the  icon  win‐
785               dow.   It  is  shorthand  for  specifying  the  “*iconGeometry
786               resource.
787
788       -T string
789               This option specifies the title for  xterm's  windows.   It  is
790               equivalent to -title.
791
792       -n string
793               This option specifies the icon name for xterm's windows.  It is
794               shorthand for specifying the “*iconName” resource.   Note  that
795               this  is  not the same as the toolkit option -name (see below).
796               The default icon name is the application name.
797
798       -r      This option indicates that reverse video should be simulated by
799               swapping  the  foreground and background colors.  It is equiva‐
800               lent to -rv.
801
802       -w number
803               This option specifies the width in pixels of  the  border  sur‐
804               rounding the window.  It is equivalent to -borderwidth or -bw.
805
806       The  following  standard  X Toolkit command line arguments are commonly
807       used with xterm:
808
809       -bd color
810               This option specifies the color to use for the  border  of  the
811               window.  xterm uses the X Toolkit default, which is “XtDefault‐
812               Foreground”.
813
814       -bg color
815               This option specifies the color to use for  the  background  of
816               the window.  The default is “XtDefaultBackground.”
817
818       -bw number
819               This  option  specifies  the width in pixels of the border sur‐
820               rounding the window.
821
822               This appears to be a legacy of older X releases.  It  sets  the
823               borderWidth  resource  of  the  shell  widget,  and may provide
824               advice to your window manager to set the thickness of the  win‐
825               dow  frame.   Most window managers do not use this information.
826               See the -b option, which controls the inner border of the xterm
827               window.
828
829       -display display
830               This option specifies the X server to contact; see X(7).
831
832       -fg color
833               This  option  specifies  the  color to use for displaying text.
834               The default is “XtDefaultForeground.”
835
836       -fn font
837               This option specifies the font to be used for displaying normal
838               text.  The default is fixed.
839
840       -font font
841               This is the same as -fn.
842
843       -geometry geometry
844               This  option  specifies  the preferred size and position of the
845               VT102 window; see X(7).
846
847       -iconic This option indicates that xterm should ask the window  manager
848               to start it as an icon rather than as the normal window.
849
850       -name name
851               This   option   specifies  the  application  name  under  which
852               resources are to be obtained,  rather  than  the  default  exe‐
853               cutable  file name.  Name should not contain “.” or “*” charac‐
854               ters.
855
856       -rv     This option indicates that reverse video should be simulated by
857               swapping the foreground and background colors.
858
859       +rv     Disable  the simulation of reverse video by swapping foreground
860               and background colors.
861
862       -title string
863               This option specifies the window title  string,  which  may  be
864               displayed  by  window  managers  if  the  user so chooses.  The
865               default title is  the  command  line  specified  after  the  -e
866               option, if any, otherwise the application name.
867
868       -xrm resourcestring
869               This  option  specifies  a resource string to be used.  This is
870               especially useful for setting resources that do not have  sepa‐
871               rate command line options.
872

RESOURCES

874       The  program  understands  all of the core X Toolkit resource names and
875       classes.  Application specific resources (e.g., "XTerm.NAME") follow:
876
877       backarrowKeyIsErase (class BackarrowKeyIsErase)
878               Tie  the  VTxxx  backarrowKey  and  ptyInitialErase   resources
879               together  by  setting the DECBKM state according to whether the
880               initial value of stty erase is a backspace (8) or delete  (127)
881               character.   The  default  is “false”, which disables this fea‐
882               ture.
883
884       hold (class Hold)
885               If true, xterm will not immediately destroy its window when the
886               shell command completes.  It will wait until you use the window
887               manager to destroy/kill the window, or  if  you  use  the  menu
888               entries  that send a signal, e.g., HUP or KILL.  You may scroll
889               back, select text, etc., to perform most graphical  operations.
890               Resizing  the  display  will  lose  data,  however,  since this
891               involves interaction with the shell which is no longer running.
892
893       hpFunctionKeys (class HpFunctionKeys)
894               Specifies whether or not HP Function Key escape codes should be
895               generated   for   function  keys  instead  of  standard  escape
896               sequences.  See also the keyboardType resource.
897
898       iconGeometry (class IconGeometry)
899               Specifies the preferred size and position  of  the  application
900               when  iconified.   It  is  not necessarily obeyed by all window
901               managers.
902
903       iconName (class IconName)
904               Specifies the icon name.  The default is the application name.
905
906       keyboardType (class KeyboardType)
907               Enables one (or none) of the various  keyboard-type  resources:
908               hpFunctionKeys, scoFunctionKeys, sunFunctionKeys, tcapFunction‐
909               Keys and sunKeyboard.  The resource's value should  be  one  of
910               the   corresponding  strings  “hp”,  “sco”,  “sun”,  “tcap”  or
911               “vt220”.  The individual resources are provided for legacy sup‐
912               port; this resource is simpler to use.
913
914       maxBufSize (class MaxBufSize)
915               Specify  the  maximum size of the input buffer.  The default is
916               32768.  You cannot set this to a value less than the minBufSize
917               resource.   It  will  be increased as needed to make that value
918               evenly divide this one.
919
920               On some systems you may want to increase one  or  both  of  the
921               maxBufSize  and  minBufSize  resource  values to achieve better
922               performance if  the  operating  system  prefers  larger  buffer
923               sizes.
924
925       maximized (class Maximized)
926               Specifies whether or not xterm should ask the window manager to
927               maximize its layout on startup.  The default is “false.”
928
929       messages (class Messages)
930               Specifies whether write access to the terminal is allowed  ini‐
931               tially.  See mesg(1).  The default is “true”.
932
933       menuLocale (class MenuLocale)
934                Specify  the  locale  used for character-set computations when
935                loading the popup menus.  Use this to  improve  initialization
936                performance of the Athena popup menus, which may load unneces‐
937                sary (and very large) fonts, e.g., in a  locale  having  UTF-8
938                encoding.  The default is an empty string, which uses the cur‐
939                rent locale setting.
940
941                Set it to “C”  to  achieve  the  best  performance  using  the
942                default  menu  resource  settings.   If you happen to be using
943                localized menu resources, set the resource accordingly.
944
945       minBufSize (class MinBufSize)
946               Specify the minimum size of the input buffer, i.e., the  amount
947               of data that xterm requests on each read.  The default is 4096.
948               You cannot set this to a value less than 64.
949
950       ptyHandshake (class PtyHandshake)
951               If “true”, xterm will perform handshaking during initialization
952               to  ensure  that the parent and child processes update the utmp
953               and stty state.   See  also  waitForMap  which  waits  for  the
954               pseudo-terminal's  notion  of  the screen size, and ptySttySize
955               which resets the screen size after other  terminal  initializa‐
956               tion is complete.  The default is “true”.
957
958       ptyInitialErase (class PtyInitialErase)
959               If  “true”,  xterm  will use the pseudo-terminal's sense of the
960               stty erase value.  If “false”, xterm will set  the  stty  erase
961               value  to match its own configuration, using the kb string from
962               the termcap entry as a  reference,  if  available.   In  either
963               case, the result is applied to the TERMCAP variable which xterm
964               sets.  See also the ttyModes resource, which may  modify  this.
965               The default is “false”.
966
967       ptySttySize (class PtySttySize)
968               If “true”, xterm will reset the screen size after terminal ini‐
969               tialization is complete.  This is needed for some systems whose
970               pseudo-terminals  cannot  propagate  terminal  characteristics.
971               Where it is not needed, it can interfere with other methods for
972               setting the intial screen size, e.g., via window manager inter‐
973               action.  See also waitForMap which waits for  a  handshake-mes‐
974               sage  giving  the  pseudo-terminal's notion of the screen size.
975               The default is “false” on Linux and OS X systems, “true” other‐
976               wise.
977
978       sameName (class SameName)
979               If  the  value  of this resource is “true”, xterm does not send
980               title and icon name change requests when the request would have
981               no  effect: the name is not changed.  This has the advantage of
982               preventing flicker and the disadvantage of requiring  an  extra
983               round  trip  to  the server to find out the previous value.  In
984               practice this should  never  be  a  problem.   The  default  is
985               “true”.
986
987       scoFunctionKeys (class ScoFunctionKeys)
988               Specifies  whether  or not SCP Function Key escape codes should
989               be generated for  function  keys  instead  of  standard  escape
990               sequences.  See also the keyboardType resource.
991
992       sessionMgt (class SessionMgt)
993               If  the value of this resource is “true”, xterm sets up session
994               manager callbacks for XtNdieCallback and XtNsaveCallback.   The
995               default is “true”.
996
997       sunFunctionKeys (class SunFunctionKeys)
998               Specifies  whether  or not Sun Function Key escape codes should
999               be generated for  function  keys  instead  of  standard  escape
1000               sequences.  See also the keyboardType resource.
1001
1002       sunKeyboard (class SunKeyboard)
1003               Specifies  whether  or  not  Sun/PC  keyboard  layout should be
1004               assumed rather than DEC VT220.  This causes the keypad  “+'  to
1005               be mapped to “,'.  and CTRL F1-F12 to F11-F20, depending on the
1006               setting of the ctrlFKeys resource.  so  xterm  emulates  a  DEC
1007               VT220  more  accurately.   Otherwise (the default, with sunKey‐
1008               board set to “false”), xterm uses  PC-style  bindings  for  the
1009               function keys and keypad.
1010
1011               PC-style  bindings use the Shift, Alt, Control and Meta keys as
1012               modifiers for function-keys and keypad (see the document  Xterm
1013               Control  Sequences  for  details).   The  PC-style bindings are
1014               analogous to PCTerm, but not the same  thing.   Normally  these
1015               bindings  do  not  conflict  with  the  use  of the Meta key as
1016               described for the eightBitInput resource.   If  they  do,  note
1017               that  the  PC-style bindings are evaluated first.  See also the
1018               keyboardType resource.
1019
1020       tcapFunctionKeys (class TcapFunctionKeys)
1021               Specifies whether or not function key escape  codes  read  from
1022               the  termcap/terminfo  entry  should  be generated for function
1023               keys instead of standard escape sequences.  See also  the  key‐
1024               boardType resource.
1025
1026       termName (class TermName)
1027               Specifies the terminal type name to be set in the TERM environ‐
1028               ment variable.
1029
1030       title (class Title)
1031               Specifies a string that may be used by the window manager  when
1032               displaying this application.
1033
1034       toolBar (class ToolBar)
1035               Specifies  whether or not the toolbar should be displayed.  The
1036               default is “true.”
1037
1038       ttyModes (class TtyModes)
1039               Specifies a string containing terminal setting keywords and the
1040               characters  to  which  they  may  be bound.  Allowable keywords
1041               include: brk, dsusp, eof,  eol,  eol2,  erase,  erase2,  flush,
1042               intr,  kill,  lnext,  quit,  rprnt,  start, status, stop, susp,
1043               swtch and weras.  Control characters may be specified as  ^char
1044               (e.g.,  ^c  or ^u) and ^? may be used to indicate delete (127).
1045               Use ^- to denote undef.  Use \034 to represent ^\, since a lit‐
1046               eral backslash in an X resource escapes the next character.
1047
1048               This  is  very  useful for overriding the default terminal set‐
1049               tings without having to do an  stty  every  time  an  xterm  is
1050               started.   Note, however, that the stty program on a given host
1051               may use different keywords; xterm's table is built-in.
1052
1053               If the ttyModes resource specifies  a  value  for  erase,  that
1054               overrides  the  ptyInitialErase  resource  setting, i.e., xterm
1055               initializes the terminal to match that value.
1056
1057       useInsertMode (class UseInsertMode)
1058               Force use of insert mode by adding appropriate entries  to  the
1059               TERMCAP  environment  variable.   This  is useful if the system
1060               termcap is broken.  The default is “false.”
1061
1062       utmpDisplayId (class UtmpDisplayId)
1063               Specifies whether or not xterm should try to record the display
1064               identifier  (display  number  and screen number) as well as the
1065               hostname in the system utmp log file.  The default is “true.”
1066
1067       utmpInhibit (class UtmpInhibit)
1068               Specifies whether or not xterm should try to record the  user's
1069               terminal  in the system utmp log file.  If true, xterm will not
1070               try.  The default is “false.”
1071
1072       waitForMap (class WaitForMap)
1073               Specifies whether or not xterm should wait for the initial win‐
1074               dow  map  before  starting the subprocess.  This is part of the
1075               ptyHandshake logic.  When xterm is directed  to  wait  in  this
1076               fashion,  it  passes  the terminal size from the display end of
1077               the pseudo-terminal  to  the  terminal  I/O  connection,  e.g.,
1078               according  to  the window manager.  Otherwise, it uses the size
1079               as given in resource values or command-line option -geom.   The
1080               default is “false.”
1081
1082       zIconBeep (class ZIconBeep)
1083               Same as -ziconbeep command line argument.  If the value of this
1084               resource is non-zero, xterms that produce output  while  iconi‐
1085               fied  will  cause  an  XBell sound at the given volume and have
1086               "***" prepended to their icon  titles.   Most  window  managers
1087               will  detect  this change immediately, showing you which window
1088               has the output.  (A similar feature was  in  x10  xterm.)   The
1089               default is “false.”
1090
1091   VT100 Widget Resources
1092       The  following  resources  are  specified  as  part of the vt100 widget
1093       (class   VT100).    They   are   specified   by   patterns   such    as
1094       "XTerm.vt100.NAME".
1095
1096       If  your  xterm is configured to support the "toolbar", then those pat‐
1097       terns need an extra level for the form-widget which holds  the  toolbar
1098       and  vt100  widget.   A  wildcard between the top-level "XTerm" and the
1099       "vt100" widget makes the  resource  settings  work  for  either,  e.g.,
1100       "XTerm*vt100.NAME".
1101
1102       activeIcon (class ActiveIcon)
1103               Specifies  whether  or  not  active icon windows are to be used
1104               when the xterm window is iconified, if this feature is compiled
1105               into  xterm.   The active icon is a miniature representation of
1106               the content of the  window  and  will  update  as  the  content
1107               changes.   Not all window managers necessarily support applica‐
1108               tion icon windows.  Some window  managers  will  allow  you  to
1109               enter  keystrokes  into the active icon window.  The default is
1110               “false.”
1111
1112       allowC1Printable (class AllowC1Printable)
1113               If true, overrides the mapping of C1 controls  (codes  128-159)
1114               to  make  them be treated as if they were printable characters.
1115               Although this corresponds to no particular standard, some users
1116               insist it is a VT100.  The default is “false.”
1117
1118       allowFontOps (class AllowFontOps)
1119               Specifies  whether  control  sequences  that set/query the font
1120               should be allowed.  The default is “true.”
1121
1122       allowSendEvents (class AllowSendEvents)
1123               Specifies whether or not synthetic key and button events  (gen‐
1124               erated using the X protocol SendEvent request) should be inter‐
1125               preted or discarded.  The default is “false” meaning  they  are
1126               discarded.  Note that allowing such events creates a very large
1127               security  hole,  and  forcefully   disables   the   allowXXXOps
1128               resources.  The default is “false.”
1129
1130       allowTcapOps (class AllowTcapOps)
1131               Specifies  whether  control sequences that query the terminal's
1132               notion of its function-key  strings,  as  termcap  or  terminfo
1133               capabilities should be allowed.  The default is “false.”
1134
1135               A  few programs, e.g,. vim, use this feature to get an accurate
1136               description of the terminal's capabilities, independent of  the
1137               termcap/terminfo setting:
1138
1139               -  xterm  can tell the querying program how many colors it sup‐
1140                  ports.  This is a constant, depending on how it is compiled,
1141                  typically 16.  It does not change if you alter resource set‐
1142                  tings, e.g., the boldColors resource.
1143
1144               -  xterm can tell the querying program what strings are sent by
1145                  modified (shift-, control-, alt-) function- and keypad-keys.
1146                  Reporting control-  and  alt-modifiers  is  a  feature  that
1147                  relies on the ncurses extended naming.
1148
1149       allowTitleOps (class AllowTitleOps)
1150               Specifies  whether  control  sequences  that  modify the window
1151               title or icon name should be allowed.  The default is “true.”
1152
1153       allowWindowOps (class AllowWindowOps)
1154               Specifies whether extended window control sequences (as used in
1155               dtterm)  should  be  allowed.   These  include  several control
1156               sequences which manipulate the window size or position, as well
1157               as  reporting these values and the title or icon name.  Each of
1158               these can be abused in a script; curiously enough most terminal
1159               emulators  that  implement  these restrict only a small part of
1160               the repertoire.  For fine-tuning, see disallowedWindowOps.  The
1161               default is “false.”
1162
1163       altIsNotMeta (class AltIsNotMeta)
1164               If  “true”, treat the Alt-key as if it were the Meta-key.  Your
1165               keyboard may happen to be configured so they are the same.  But
1166               if  they  are  not, this allows you to use the same prefix- and
1167               shifting operations with the Alt-key as with the Meta-key.  See
1168               altSendsEscape and metaSendsEscape.  The default is “false.”
1169
1170       altSendsEscape (class AltSendsEscape)
1171               This  is an additional keyboard operation that may be processed
1172               after the logic for metaSendsEscape.  It is only  available  if
1173               the altIsNotMeta resource is set.
1174
1175               If  “true”, Alt characters (a character combined with the modi‐
1176               fier associated with left/right Alt-keys) are converted into  a
1177               two-character  sequence  with  the character itself preceded by
1178               ESC.  This applies as well to function key  control  sequences,
1179               unless  xterm  sees  that Alt is used in your key translations.
1180               If “false”, Alt characters input  from  the  keyboard  cause  a
1181               shift to 8-bit characters (just like metaSendsEscape).  By com‐
1182               bining the Alt- and Meta-modifiers, you can create  correspond‐
1183               ing  combinations  of  ESC-prefix  and  8-bit  characters.  The
1184               default is “false.”
1185
1186       alwaysBoldMode (class AlwaysBoldMode)
1187               Specifies whether xterm should check if  the  normal  and  bold
1188               fonts  are distinct before deciding whether to use overstriking
1189               to simulate bold fonts.  If this resource is true,  xterm  does
1190               not make the check for distinct fonts when deciding how to han‐
1191               dle the boldMode resource.  The default is “false.”
1192
1193               boldMode   alwaysBoldMode   Comparison   Action
1194               ────────────────────────────────────────────────────
1195               false      false            ignored      use font
1196               false      true             ignored      use font
1197               true       false            same         overstrike
1198               true       false            different    use font
1199               true       true             ignored      overstrike
1200
1201       alwaysHighlight (class AlwaysHighlight)
1202               Specifies whether or not xterm should always  display  a  high‐
1203               lighted text cursor.  By default (if this resource is false), a
1204               hollow text cursor is displayed whenever the pointer moves  out
1205               of the window or the window loses the input focus.  The default
1206               is “false.”
1207
1208       alwaysUseMods (class AlwaysUseMods)
1209               Override the numLock resource, telling xterm to use the Alt and
1210               Meta   modifiers  to  construct  parameters  for  function  key
1211               sequences even if those modifiers appear  in  the  translations
1212               resource.  The default is “false.”
1213
1214       answerbackString (class AnswerbackString)
1215               Specifies  the  string  that  xterm sends in response to an ENQ
1216               (control/E) character from the host.  The default  is  a  blank
1217               string,  i.e., “”.  A hardware VT100 implements this feature as
1218               a setup option.
1219
1220       appcursorDefault (class AppcursorDefault)
1221               If “true,” the cursor keys are initially in  application  mode.
1222               This  is the same as the VT102 private DECCKM mode, The default
1223               is “false.”
1224
1225       appkeypadDefault (class AppkeypadDefault)
1226               If “true,” the keypad keys are initially in  application  mode.
1227               The default is “false.”
1228
1229       autoWrap (class AutoWrap)
1230               Specifies  whether  or  not  auto-wraparound should be enabled.
1231               This is the same as the VT102 DECAWM.  The default is “true.”
1232
1233       awaitInput (class AwaitInput)
1234               Specifies whether or not the xterm uses a 50 millisecond  time‐
1235               out  to  await  input (i.e., to support the Xaw3d arrow scroll‐
1236               bar).  The default is “false.”
1237
1238       backarrowKey (class BackarrowKey)
1239               Specifies whether the backarrow key transmits a  backspace  (8)
1240               or delete (127) character.  This corresponds to the DECBKM con‐
1241               trol sequence.  The default (backspace)  is  “true.”   Pressing
1242               the control key toggles this behavior.
1243
1244       background (class Background)
1245               Specifies  the  color  to use for the background of the window.
1246               The default is “XtDefaultBackground.”
1247
1248       bellIsUrgent (class BellIsUrgent)
1249               Specifies whether to set the Urgency hint for the  window  man‐
1250               ager when making a bell sound.  The default is “false.”
1251
1252       bellOnReset (class BellOnReset)
1253               Specifies whether to sound a bell when doing a hard reset.  The
1254               default is “true.”
1255
1256       bellSuppressTime (class BellSuppressTime)
1257               Number of milliseconds after a  bell  command  is  sent  during
1258               which additional bells will be suppressed.  Default is 200.  If
1259               set non-zero, additional bells will also  be  suppressed  until
1260               the  server  reports that processing of the first bell has been
1261               completed; this feature is most useful with the visible bell.
1262
1263       boldColors (class ColorMode)
1264               Specifies whether to combine bold attribute  with  colors  like
1265               the  IBM  PC,  i.e., map colors 0 through 7 to colors 8 through
1266               15.  These normally are the brighter versions of  the  first  8
1267               colors, hence bold.  The default is “true.”
1268
1269       boldFont (class BoldFont)
1270               Specifies  the  name  of  the bold font to use instead of over‐
1271               striking.  There is no default for this resource.
1272
1273       boldMode (class BoldMode)
1274               This specifies whether or not  text  with  the  bold  attribute
1275               should  be  overstruck  to  simulate bold fonts if the resolved
1276               bold font is the same as the normal font.  It may be  desirable
1277               to  disable  bold  fonts  when color is being used for the bold
1278               attribute.
1279
1280               Note that xterm has one bold font which you may set explicitly.
1281               Xterm  attempts to derive a bold font for the other font selec‐
1282               tions (font1 through font6).  If it cannot find a bold font, it
1283               will  use  the normal font.  In each case (whether the explicit
1284               resource or the derived font), if the normal and bold fonts are
1285               distinct, this resource has no effect.  The default is “true.”
1286
1287               See  the  alwaysBoldMode resource which can modify the behavior
1288               of this resource.
1289
1290               Although xterm attempts to derive a bold font  for  other  font
1291               selections,  the  font  server may not cooperate.  Since X11R6,
1292               bitmap fonts have been scaled.  The font server claims to  pro‐
1293               vide  the  bold font that xterm requests, but the result is not
1294               always readable.  XFree86 provides a feature which can be  used
1295               to  suppress the scaling.  In the X server's configuration file
1296               (e.g., /etc/X11/xorg.conf), you can add ":unscaled" to the  end
1297               of the directory specification for the "misc" fonts, which com‐
1298               prise the fixed-pitch fonts that are used by xterm.  For  exam‐
1299               ple
1300                       FontPath         "/usr/share/X11/fonts"
1301
1302               would become
1303                       FontPath         "/usr/share/X11/fonts/misc/:unscaled"
1304
1305               Depending  on  your configuration, the font server may have its
1306               own configuration file.  The same ":unscaled" can be  added  to
1307               its  configuration  file at the end of the directory specifica‐
1308               tion for "misc".
1309
1310               The bitmap scaling feature is also used by xterm  to  implement
1311               VT102 double-width and double-height characters.
1312
1313       brokenLinuxOSC (class BrokenLinuxOSC)
1314               If true, xterm applies a workaround to ignore malformed control
1315               sequences that a Linux script might send.  Compare the  palette
1316               control  sequences  documented  in  console_codes with ECMA-48.
1317               The default is “true.”
1318
1319       brokenSelections (class BrokenSelections)
1320               If true, xterm in 8-bit mode will interpret  STRING  selections
1321               as  carrying  text  in the current locale's encoding.  Normally
1322               STRING selections carry ISO-8859-1 encoded text.  Setting  this
1323               resource to “true” violates the ICCCM; it may, however, be use‐
1324               ful for interacting with some broken X clients.  The default is
1325               “false.”
1326
1327       brokenStringTerm (class BrokenStringTerm)
1328               provides  a  work-around  for  some ISDN routers which start an
1329               application control string without completing it.  Set this  to
1330               “true” if xterm appears to freeze when connecting.  The default
1331               is “false.”
1332
1333       c132 (class C132)
1334               Specifies whether or not the  VT102  DECCOLM  escape  sequence,
1335               used  to  switch between 80 and 132 columns, should be honored.
1336               The default is “false.”
1337
1338       cacheDoublesize (class CacheDoublesize)
1339               Tells whether to cache double-sized fonts by xterm.   Set  this
1340               to zero to disable double-sized fonts altogether.
1341
1342       charClass (class CharClass)
1343               Specifies  comma-separated lists of character class bindings of
1344               the form [low-]high:value.  These are used in determining which
1345               sets  of  characters  should be treated the same when doing cut
1346               and paste.  See the CHARACTER CLASSES section.
1347
1348       cjkWidth (class CjkWidth)
1349               Specifies whether xterm  should  follow  the  traditional  East
1350               Asian  width  convention.  When turned on, characters with East
1351               Asian Ambiguous (A) category in UTR 11 have a column  width  of
1352               2.   You may have to set this option to “true” if you have some
1353               old East Asian terminal based programs that assume  that  line-
1354               drawing  characters have a column width of 2.  If this resource
1355               is false, the mkWidth resource controls the choice between  the
1356               system's  wcwidth  and xterm's built-in tables.  The default is
1357               “false.”
1358
1359       color0 (class Color0)
1360
1361       color1 (class Color1)
1362
1363       color2 (class Color2)
1364
1365       color3 (class Color3)
1366
1367       color4 (class Color4)
1368
1369       color5 (class Color5)
1370
1371       color6 (class Color6)
1372
1373       color7 (class Color7)
1374               These specify the  colors  for  the  ISO-6429  extension.   The
1375               defaults  are,  respectively,  black,  red3, green3, yellow3, a
1376               customizable dark  blue,  magenta3,  cyan3,  and  gray90.   The
1377               default  shades of color are chosen to allow the colors 8-15 to
1378               be used as brighter versions.
1379
1380       color8 (class Color8)
1381
1382       color9 (class Color9)
1383
1384       color10 (class Color10)
1385
1386       color11 (class Color11)
1387
1388       color12 (class Color12)
1389
1390       color13 (class Color13)
1391
1392       color14 (class Color14)
1393
1394       color15 (class Color15)
1395               These specify the colors for the ISO-6429 extension if the bold
1396               attribute  is  also  enabled.   The default resource values are
1397               respectively, gray30, red, green, yellow, a customizable  light
1398               blue, magenta, cyan, and white.
1399
1400       color16 (class Color16)
1401
1402       through
1403
1404       color255 (class Color255)
1405               These  specify  the  colors  for  the 256-color extension.  The
1406               default resource values are for colors 16 through 231 to make a
1407               6x6x6  color  cube,  and  colors  232  through  255  to  make a
1408               grayscale ramp.
1409
1410               Resources past color15 are available as a compile-time  option.
1411               Due to a hardcoded limit in the X libraries on the total number
1412               of resources (to 400), the resources for 256-colors are omitted
1413               when  wide-character  support  and  luit  are enabled.  Besides
1414               inconsistent behavior  if  only  part  of  the  resources  were
1415               allowed,  determining  the exact cutoff is difficult, and the X
1416               libraries tend to crash if the number of resources exceeds  the
1417               limit.   The  color  palette  is  still initialized to the same
1418               default values, and can be modified via control sequences.
1419
1420               On the other hand, the resource limit does permit including the
1421               entire range for 88-colors.
1422
1423       colorAttrMode (class ColorAttrMode)
1424               Specifies whether colorBD, colorBL, colorRV, and colorUL should
1425               override ANSI colors.  If not, these are displayed only when no
1426               ANSI  colors have been set for the corresponding position.  The
1427               default is “false.”
1428
1429       colorBD (class ColorBD)
1430               This specifies the color to use to display bold  characters  if
1431               the  “colorBDMode”  resource is enabled.  The default is “XtDe‐
1432               faultForeground.”
1433
1434       colorBDMode (class ColorAttrMode)
1435               Specifies whether characters with the bold attribute should  be
1436               displayed  in  color  or as bold characters.  Note that setting
1437               colorMode off disables all colors, including bold.  The default
1438               is “false.”
1439
1440       colorBL (class ColorBL)
1441               This  specifies the color to use to display blink characters if
1442               the “colorBLMode” resource is enabled.  The default  is  “XtDe‐
1443               faultForeground.”
1444
1445       colorBLMode (class ColorAttrMode)
1446               Specifies whether characters with the blink attribute should be
1447               displayed in color.  Note that setting colorMode  off  disables
1448               all colors, including this.  The default is “false.”
1449
1450       colorMode (class ColorMode)
1451               Specifies  whether  or not recognition of ANSI (ISO-6429) color
1452               change escape sequences should  be  enabled.   The  default  is
1453               “true.”
1454
1455       colorRV (class ColorRV)
1456               This  specifies  the color to use to display reverse characters
1457               if the “colorRVMode”  resource  is  enabled.   The  default  is
1458               “XtDefaultForeground.”
1459
1460       colorRVMode (class ColorAttrMode)
1461               Specifies  whether characters with the reverse attribute should
1462               be displayed in color.  Note that setting  colorMode  off  dis‐
1463               ables all colors, including this.  The default is “false.”
1464
1465       colorUL (class ColorUL)
1466               This  specifies  the color to use to display underlined charac‐
1467               ters if the “colorULMode” resource is enabled.  The default  is
1468               “XtDefaultForeground.”
1469
1470       colorULMode (class ColorAttrMode)
1471               Specifies  whether  characters  with  the  underline  attribute
1472               should be displayed in color or as underlined characters.  Note
1473               that  setting  colorMode  off  disables  all  colors, including
1474               underlining.  The default is “false.”
1475
1476       combiningChars (class CombiningChars)
1477               Specifies the number of wide-characters which can be stored  in
1478               a  cell  to overstrike (combine) with the base character of the
1479               cell.  This can be set to values in the  range  0  to  4.   The
1480               default is “2”.
1481
1482       ctrlFKeys (class CtrlFKeys)
1483               In  VT220  keyboard  mode (see sunKeyboard resource), specifies
1484               the amount by which to shift F1-F12 given  a  control  modifier
1485               (CTRL).  This allows you to generate key symbols for F10-F20 on
1486               a Sun/PC keyboard.  The default is “10”, which means that  CTRL
1487               F1 generates the key symbol for F11.
1488
1489       curses (class Curses)
1490               Specifies  whether or not the last column bug in more(1) should
1491               be worked around.  See the -cu option for details.  The default
1492               is “false.”
1493
1494       cursorBlink (class CursorBlink)
1495               Specifies  whether  to  make  the cursor blink.  The default is
1496               “false.”
1497
1498       cursorColor (class CursorColor)
1499               Specifies the color to use for the text cursor.  The default is
1500               “XtDefaultForeground.”  By default, xterm attempts to keep this
1501               color from being the same as the  background  color,  since  it
1502               draws the cursor by filling the background of a text cell.  The
1503               same restriction applies to control sequences which may  change
1504               this color.
1505
1506               Setting  this resource overrides most of xterm's adjustments to
1507               cursor color.  It will still use reverse-video to disallow some
1508               cases, such as a black cursor on a black background.
1509
1510       cursorOffTime (class CursorOffTime)
1511               Specifies  the  duration  of the "off" part of the cursor blink
1512               cycle-time in milliseconds.  The same timer is  used  for  text
1513               blinking.  The default is 300.
1514
1515       cursorOnTime (class CursorOnTime)
1516               Specifies  the  duration  of  the "on" part of the cursor blink
1517               cycle-time, in milliseconds.  The same timer is used  for  text
1518               blinking.  The default is 600.
1519
1520       cutNewline (class CutNewline)
1521               If  “false”,  triple clicking to select a line does not include
1522               the Newline at the end of the line.  If “true”, the Newline  is
1523               selected.  The default is “true.”
1524
1525       cursorUnderLine (class CursorUnderLine)
1526               Specifies  whether to make the cursor underlined or a box.  The
1527               default is “false.”
1528
1529       cutToBeginningOfLine (class CutToBeginningOfLine)
1530               If “false”, triple clicking to select a line selects only  from
1531               the  current  word  forward.   If  “true”,  the  entire line is
1532               selected.  The default is “true.”
1533
1534       decTerminalID (class DecTerminalID)
1535               Specifies the emulation  level  (100=VT100,  220=VT220,  etc.),
1536               used  to  determine  the  type  of  response  to  a  DA control
1537               sequence.  Leading  non-digit  characters  are  ignored,  e.g.,
1538               "vt100" and "100" are the same.  The default is 100.
1539
1540       defaultString (class DefaultString)
1541               Specify  the  character (or string) which xterm will substitute
1542               when pasted text includes a character which  cannot  be  repre‐
1543               sented  in  the  current encoding.  For instance, pasting UTF-8
1544               text into a display of ISO-8859-1 characters will only be  able
1545               to  display  codes  0-255, while UTF-8 text can include Unicode
1546               values above 255.  The default is “#” (a single pound sign).
1547
1548               If the undisplayable text would be double-width, xterm will add
1549               a  space after the “#” character, to give roughly the same lay‐
1550               out on the screen as the original text.
1551
1552       deleteIsDEL (class DeleteIsDEL)
1553               Specifies whether the Delete key on the editing  keypad  should
1554               send  DEL (127) or the VT220-style Remove escape sequence.  The
1555               default is “false,” for the latter.
1556
1557       disallowedWindowOps (class DisallowedWindowOps)
1558               Specify which features will be disabled  if  allowWindowOps  is
1559               false.   This  is  a comma-separated list of names, or (for the
1560               controls  adapted  from  dtterm  the  operation  number).   The
1561               default value is
1562               20,21,SetXprop,SetSelection
1563
1564               The  names are listed below.  xterm ignores capitalization, but
1565               they are shown in mixed-case for clarity.  Where a  number  can
1566               be used as an alternative, it is given in parentheses after the
1567               name.
1568
1569               GetIconTitle (20)
1570                    Report xterm window's icon label as a string.
1571
1572               GetScreenSizeChars (19)
1573                    Report the size of the screen in characters as numbers.
1574
1575               GetSelection
1576                    Report selection data as a base64 string.
1577
1578               GetWinPosition (13)
1579                    Report xterm window position as numbers.
1580
1581               GetWinSizeChars (18)
1582                    Report the size of the text area in characters as numbers.
1583
1584               GetWinSizePixels (14)
1585                    Report xterm window in pixels as numbers.
1586
1587               GetWinState (11)
1588                    Report xterm window state as a number.
1589
1590               GetWinTitle (21)
1591                    Report xterm window's title as a string.
1592
1593               LowerWin (6)
1594                    Lower the xterm window  to  the  bottom  of  the  stacking
1595                    order.
1596
1597               MaximizeWin (9)
1598                    Maximize window (i.e., resize to screen size).
1599
1600               MinimizeWin (2)
1601                    Iconify window.
1602
1603               PopTitle (23)
1604                    Pop title from internal stack.
1605
1606               PushTitle (22)
1607                    Push title to internal stack.
1608
1609               RaiseWin (5)
1610                    Raise the xterm window to the front of the stacking order.
1611
1612               RefreshWin (7)
1613                    Refresh the xterm window.
1614
1615               RestoreWin (1)
1616                    De-iconify window.
1617
1618               SetSelection
1619                    Set selection data.
1620
1621               SetWinLines
1622                    Resize to a given number of lines, at least 24.
1623
1624               SetWinPosition (3)
1625                    Move window to given coordinates.
1626
1627               SetWinSizeChars (8)
1628                    Resize the text area to given size in characters.
1629
1630               SetWinSizePixels (4)
1631                    Resize the xterm window to given size in pixels.
1632
1633               SetXprop
1634                    Set X property on top-level window.
1635
1636       dynamicColors (class DynamicColors)
1637               Specifies  whether  or  not  escape  sequences to change colors
1638               assigned to different attributes are recognized.
1639
1640       eightBitControl (class EightBitControl)
1641               Specifies whether or not control sequences sent by the terminal
1642               should  be  eight-bit  characters  or  escape  sequences.   The
1643               default is “false.”
1644
1645       eightBitInput (class EightBitInput)
1646               If “true”, Meta characters (a  single-byte  character  combined
1647               with  the  Meta  modifier key) input from the keyboard are pre‐
1648               sented as a single character with the  eighth  bit  turned  on.
1649               The  terminal is put into 8-bit mode.  If “false”, Meta charac‐
1650               ters are converted into a two-character sequence with the char‐
1651               acter  itself  preceded by ESC.  On startup, xterm tries to put
1652               the terminal into 7-bit mode.  The metaSendsEscape and altSend‐
1653               sEscape resources may override this.  The default is “true.”
1654
1655               Generally keyboards do not have a key labeled "Meta", but "Alt"
1656               keys are common, and they are conventionally used  for  "Meta".
1657               If  they were synonymous, it would have been reasonable to name
1658               this resource "altSendsEscape", reversing its sense.  For  more
1659               background on this, see the meta function in curses.
1660
1661               Note  that  the Alt key is not necessarily the same as the Meta
1662               modifier.  xmodmap lists your key modifiers.  X  defines  modi‐
1663               fiers  for  shift,  (caps) lock and control, as well as 5 addi‐
1664               tional modifiers which are generally used to configure key mod‐
1665               ifiers.   xterm inspects the same information to find the modi‐
1666               fier associated with either Meta key (left or right), and  uses
1667               that  key  as the Meta modifier.  It also looks for the NumLock
1668               key, to recognize the modifier which is associated with that.
1669
1670               If your xmodmap configuration uses the same keycodes  for  Alt-
1671               and  Meta-keys,  xterm  will  only see the Alt-key definitions,
1672               since those are tested before  Meta-keys.   NumLock  is  tested
1673               first.   It is important to keep these keys distinct; otherwise
1674               some of xterm's functionality is not available.
1675
1676       eightBitOutput (class EightBitOutput)
1677               Specifies whether or not eight-bit  characters  sent  from  the
1678               host  should  be  accepted as is or stripped when printed.  The
1679               default is “true,” which means that they are accepted as is.
1680
1681       eightBitSelectTypes (class EightBitSelectTypes)
1682               Override   xterm's   default   selection   target   list   (see
1683               SELECT/PASTE)  for selections in normal (ISO-8859-1) mode.  The
1684               default is an empty string, which does not override anything.
1685
1686       faceName (class FaceName)
1687               Specify the  pattern  for  fonts  selected  from  the  FreeType
1688               library  if  support  for that library was compiled into xterm.
1689               There is no default.  If not specified, or if there is no match
1690               for both normal and bold fonts, xterm uses the font and related
1691               resources.
1692
1693       faceNameDoublesize (class FaceNameDoublesize)
1694               Specify an double-width font for  cases  where  an  application
1695               requires this, e.g., in CJK applications.  There is no default.
1696               If  the  application  uses  double-wide  characters  and   this
1697               resource  is not given, xterm  will use a scaled version of the
1698               font given by faceName.
1699
1700       faceSize (class FaceSize)
1701               Specify the pointsize for  fonts  selected  from  the  FreeType
1702               library  if  support  for that library was compiled into xterm.
1703               The default is “14.”  On the VT Fonts menu, this corresponds to
1704               the Default entry.
1705
1706               You  can specify the pointsize for TrueType fonts selected with
1707               the other size-related menu entries such as Medium, Huge, etc.,
1708               by  using  one of the following resource values.  If you do not
1709               specify a value, they default to “0.0”, which causes  xterm  to
1710               use  the ratio of font sizes from the corresponding bitmap font
1711               resources to obtain a TrueType pointsize.
1712
1713               If all of the faceSize resources are set, then xterm  will  use
1714               this  information to determine the next smaller/larger TrueType
1715               font for the larger-vt-font()  and  smaller-vt-font()  actions.
1716               If any are not set, xterm will use only the areas of the bitmap
1717               fonts.
1718
1719       faceSize1 (class FaceSize1)
1720               Specifies the pointsize of the first alternative font.
1721
1722       faceSize2 (class FaceSize2)
1723               Specifies the pointsize of the second alternative font.
1724
1725       faceSize3 (class FaceSize3)
1726               Specifies the pointsize of the third alternative font.
1727
1728       faceSize4 (class FaceSize4)
1729               Specifies the pointsize of the fourth alternative font.
1730
1731       faceSize5 (class FaceSize5)
1732               Specifies the pointsize of the fifth alternative font.
1733
1734       faceSize6 (class FaceSize6)
1735               Specifies the pointsize of the sixth alternative font.
1736
1737       font (class Font)
1738               Specifies the name of the normal font.  The default is “fixed.”
1739
1740               See the discussion of the locale resource, which describes  how
1741               this font may be overridden.
1742
1743               NOTE: some resource files use patterns such as
1744               *font: fixed
1745
1746               which are overly broad, affecting both
1747               xterm.vt100.font
1748
1749               and
1750               xterm.vt100.utf8fonts.font
1751
1752               which is probably not what you intended.
1753
1754       fastScroll (class FastScroll)
1755               Modifies  the effect of jump scroll (jumpScroll) by suppressing
1756               screen refreshes for the special case when output to the screen
1757               has  completely shifted the contents off-screen.  For instance,
1758               cat'ing a large file to the screen does this.
1759
1760       font1 (class Font1)
1761               Specifies the name of the first alternative font.
1762
1763       font2 (class Font2)
1764               Specifies the name of the second alternative font.
1765
1766       font3 (class Font3)
1767               Specifies the name of the third alternative font.
1768
1769       font4 (class Font4)
1770               Specifies the name of the fourth alternative font.
1771
1772       font5 (class Font5)
1773               Specifies the name of the fifth alternative font.
1774
1775       font6 (class Font6)
1776               Specifies the name of the sixth alternative font.
1777
1778       fontDoublesize (class FontDoublesize)
1779               Specifies whether xterm should attempt to use font  scaling  to
1780               draw  double-sized  characters.  Some older font servers cannot
1781               do this properly, will return  misleading  font  metrics.   The
1782               default  is  “true”.   If disabled, xterm will simulate double-
1783               sized characters  by  drawing  normal  characters  with  spaces
1784               between them.
1785
1786       fontWarnings (class FontWarnings)
1787               Specify  whether  xterm  should  report an error if it fails to
1788               load a font:
1789
1790               0    Never report an error (though the X libraries may).
1791
1792               1    Report an error if the font name was given as  a  resource
1793                    setting.
1794
1795               2    Always report an error on failure to load a font.
1796
1797       forceBoxChars (class ForceBoxChars)
1798               Specifies whether xterm should assume the normal and bold fonts
1799               have VT100 line-drawing characters:
1800
1801               -    The fixed-pitch ISO-8859-*-encoded  fonts  used  by  xterm
1802                    normally have the VT100 line-drawing glyphs in cells 1-31.
1803                    Other fixed-pitch fonts may be more attractive,  but  lack
1804                    these glyphs.
1805
1806               -    When  using an ISO-10646-1 font and the wideChars resource
1807                    is true, xterm uses the Unicode  glyphs  which  match  the
1808                    VT100 line-drawing glyphs.
1809
1810               If  “false”,  xterm  checks  for missing glyphs in the font and
1811               makes line-drawing characters directly as needed.   If  “true”,
1812               xterm  assumes the font does not contain the line-drawing char‐
1813               acters, and draws them directly.  The default is “false.”
1814
1815       forcePackedFont (class ForcePackedFont)
1816               Specifies whether xterm should use the maximum or minimum glyph
1817               width  when  displaying  using  a bitmap font.  Use the maximum
1818               width to help with proportional fonts.  The default is  “true,”
1819               denoting the minimum width.
1820
1821       foreground (class Foreground)
1822               Specifies  the  color to use for displaying text in the window.
1823               Setting the class name instead of the instance name is an  easy
1824               way  to  have everything that would normally appear in the text
1825               color change color.  The default is “XtDefaultForeground.”
1826
1827       formatOtherKeys (class FormatOtherKeys)
1828               Overrides the format of the escape sequence used to report mod‐
1829               ified keys with the modifyOtherKeys resource.
1830
1831               0  send   modified  keys  as  parameters  for  function-key  27
1832                  (default).
1833
1834               1  send modified keys as parameters for CSI u.
1835
1836       freeBoldBox (class FreeBoldBox)
1837               Specifies whether xterm should assume the  bounding  boxes  for
1838               normal  and  bold fonts are compatible.  If “false”, xterm com‐
1839               pares them and will reject choices of bold fonts  that  do  not
1840               match  the  size  of  the normal font.  The default is “false”,
1841               which means that the comparison is performed.
1842
1843       geometry (class Geometry)
1844               Specifies the preferred size and position of the VT102  window.
1845               There is no default for this resource.
1846
1847       highlightColor (class HighlightColor)
1848               Specifies  the  color  to  use  for  the background of selected
1849               (highlighted) text.   If  not  specified  (i.e.,  matching  the
1850               default  foreground),  reverse  video  is used.  The default is
1851               “XtDefaultForeground.”
1852
1853       highlightColorMode (class HighlightColorMode)
1854               Specifies whether xterm should use highlightTextColor and high‐
1855               lightColor  to override the reversed foreground/background col‐
1856               ors in a selection.  The default is  unspecified:  at  startup,
1857               xterm checks if those resources are set to something other than
1858               the default foreground and  background  colors.   Setting  this
1859               resource disables the check.
1860
1861               The  following  table shows the interaction of the highlighting
1862               resources, abbreviated as shown to fit in this page:
1863
1864               HCM
1865                  highlightColorMode
1866
1867               HR highlightReverse
1868
1869               HBG
1870                  highlightColor
1871
1872               HFG
1873                  highlightTextColor
1874
1875               HCM       HR      HBG       HFG       Highlight
1876               ──────────────────────────────────────────────────────
1877               false     false   default   default   bg/fg
1878               false     false   default   set       bg/fg
1879               false     false   set       default   fg/HBG
1880               false     false   set       set       fg/HBG
1881               ──────────────────────────────────────────────────────
1882               false     true    default   default   bg/fg
1883               false     true    default   set       bg/fg
1884               false     true    set       default   fg/HBG
1885               false     true    set       set       fg/HBG
1886               ──────────────────────────────────────────────────────
1887               true      false   default   default   bg/fg
1888               true      false   default   set       HFG/fg
1889               true      false   set       default   bg/HBG
1890               true      false   set       set       HFG/HBG
1891               ──────────────────────────────────────────────────────
1892               true      true    default   default   fg/fg (useless)
1893               true      true    default   set       HFG/fg
1894               true      true    set       default   fg/HBG
1895               true      true    set       set       HFG/HBG
1896               ──────────────────────────────────────────────────────
1897               default   false   default   default   bg/fg
1898               default   false   default   set       bg/fg
1899               default   false   set       default   fg/HBG
1900               default   false   set       set       HFG/HBG
1901               ──────────────────────────────────────────────────────
1902               default   true    default   default   bg/fg
1903               default   true    default   set       bg/fg
1904               default   true    set       default   fg/HBG
1905               default   true    set       set       HFG/HBG
1906               ──────────────────────────────────────────────────────
1907
1908       highlightReverse (class HighlightReverse)
1909               Specifies whether xterm should reverse the selection foreground
1910               and  background  colors  when selecting text with reverse-video
1911               attribute.  This applies only to the highlightColor  and  high‐
1912               lightTextColor  resources,  e.g.,  to match the color scheme of
1913               xwsh.  If “true”, xterm reverses the colors, If “false”,  xterm
1914               does not reverse colors, The default is “true.”
1915
1916       highlightSelection (class HighlightSelection)
1917               If  “false”,  selecting with the mouse highlights all positions
1918               on the screen between the beginning of the  selection  and  the
1919               current  position.   If “true”, xterm highlights only the posi‐
1920               tions that contain text that can be selected.  The  default  is
1921               “false.”
1922
1923               Depending  on  the  way  your applications write to the screen,
1924               there may be trailing blanks on a line.  Xterm stores  data  as
1925               it  is  shown  on  the screen.  Erasing the display changes the
1926               internal state of each cell so it is not considered a blank for
1927               the  purpose of selection.  Blanks written since the last erase
1928               are selectable.  If you do not wish to have trailing blanks  in
1929               a selection, use the trimSelection resource.
1930
1931       highlightTextColor (class HighlightTextColor)
1932               Specifies  the  color  to  use  for  the foreground of selected
1933               (highlighted) text.   If  not  specified  (i.e.,  matching  the
1934               default  background),  reverse  video  is used.  The default is
1935               “XtDefaultBackground.”
1936
1937       hpLowerleftBugCompat (class HpLowerleftBugCompat)
1938               Specifies whether to work around  a  bug  in  HP's  xdb,  which
1939               ignores  termcap  and  always  sends ESC F to move to the lower
1940               left corner.  “true” causes xterm  to  interpret  ESC  F  as  a
1941               request  to  move  to the lower left corner of the screen.  The
1942               default is “false.”
1943
1944       i18nSelections (class I18nSelections)
1945               If false, xterm will not request the targets  COMPOUND_TEXT  or
1946               TEXT.   The  default is “true.” It may be set to false in order
1947               to work around ICCCM violations by other X clients.
1948
1949       iconBorderColor (class BorderColor)
1950               Specifies the border color for the active icon window  if  this
1951               feature  is  compiled into xterm.  Not all window managers will
1952               make the icon border visible.
1953
1954       iconBorderWidth (class BorderWidth)
1955               Specifies the border width for the active icon window  if  this
1956               feature  is  compiled  into  xterm.  The default is 2.  Not all
1957               window managers will make the border visible.
1958
1959       iconFont (class IconFont)
1960               Specifies the font for the miniature  active  icon  window,  if
1961               this feature is compiled into xterm.  The default is "nil2".
1962
1963       initialFont (class InitialFont)
1964               Specifies  which  of  the VT100 fonts to use initially.  Values
1965               are the same as for the set-vt-font  action.   The  default  is
1966               “d”, i.e., "default".
1967
1968       inputMethod (class XtCInputMethod)
1969               Tells  xterm  which  type  of input method to use.  There is no
1970               default method.
1971
1972       internalBorder (class BorderWidth)
1973               Specifies the number of pixels between the characters  and  the
1974               window border.  The default is 2.
1975
1976       italicULMode (class ColorAttrMode)
1977               Specifies  whether  characters  with  the  underline  attribute
1978               should be displayed in an italic font or as underlined  charac‐
1979               ters.  It is implemented only for TrueType fonts.
1980
1981       jumpScroll (class JumpScroll)
1982               Specifies whether or not jump scroll should be used.  This cor‐
1983               responds to the VT102 DECSCLM private  mode.   The  default  is
1984               “true.”  See fastScroll for a variation.
1985
1986       keepSelection (class KeepSelection)
1987               Specifies  whether xterm will keep the selection even after the
1988               selected area was touched by some output to the terminal.   The
1989               default is “true”.
1990
1991       keyboardDialect (class KeyboardDialect)
1992               Specifies  the initial keyboard dialect, as well as the default
1993               value when the terminal is reset.  The value given is the  same
1994               as  the  final  character in the control sequences which change
1995               character sets.  The default is “B”, which  corresponds  to  US
1996               ASCII.
1997
1998       nameKeymap (class NameKeymap)
1999               See the discussion of the keymap() action.
2000
2001       limitResize (class LimitResize)
2002               Limits  resizing  of the screen via control sequence to a given
2003               multiple of the display dimensions.  The default is “1”.
2004
2005       locale (class Locale)
2006               Specifies how to use luit, an encoding converter between  UTF-8
2007               and  locale  encodings.  The resource value (ignoring case) may
2008               be:
2009
2010               true
2011                   xterm  will  use  the  encoding  specified  by  the  users'
2012                   LC_CTYPE locale (i.e., LC_ALL, LC_CTYPE, or LANG variables)
2013                   as far as possible.  This is realized  by  always  enabling
2014                   UTF-8 mode and invoking luit in non-UTF-8 locales.
2015
2016               medium
2017                   xterm  will  follow  users' LC_CTYPE locale only for UTF-8,
2018                   east Asian, and Thai locales, where the encodings were  not
2019                   supported  by  conventional  8bit mode with changing fonts.
2020                   For other locales, xterm will use conventional 8bit mode.
2021
2022               checkfont
2023                   If mini-luit is compiled-in, xterm will check if a  Unicode
2024                   font has been specified.  If so, it checks if the character
2025                   encoding for  the  current  locale  is  POSIX,  Latin-1  or
2026                   Latin-9, uses the appropriate mapping to support those with
2027                   the Unicode font.  For other encodings, xterm assumes  that
2028                   UTF-8 encoding is required.
2029
2030               false
2031                   xterm will use conventional 8bit mode or UTF-8 mode accord‐
2032                   ing to utf8 resource or -u8 option.
2033
2034               Any other value, e.g., “UTF-8” or “ISO8859-2”, is assumed to be
2035               an encoding name; luit will be invoked to support the encoding.
2036               The actual list of supported encodings depends  on  luit.   The
2037               default is “medium”.
2038
2039               Regardless of your locale and encoding, you need an ISO-10646-1
2040               font to display the result.  Your configuration may not include
2041               this  font,  or  locale-support by xterm may not be needed.  At
2042               startup, xterm uses a  mechanism  equivalent  to  the  load-vt-
2043               fonts(utf8Fonts, Utf8Fonts)  action  to  load  font name subre‐
2044               sources of the VT100 widget.  That is, resource  patterns  such
2045               as   "*vt100.utf8Fonts.font"  will  be  loaded,  and  (if  this
2046               resource is enabled), override the normal fonts.  If no  subre‐
2047               sources  are  found,  the  normal  fonts such as "*vt100.font",
2048               etc., are used.  The resource files distributed with xterm  use
2049               ISO-10646-1 fonts, but do not rely on them unless you are using
2050               the locale mechanism.
2051
2052       localeFilter (class LocaleFilter)
2053               Specifies the file name  for  the  encoding  converter  from/to
2054               locale encodings and UTF-8 which is used with the -lc option or
2055               locale resource.  The help message shown by “xterm -help” lists
2056               the default value, which depends on your system configuration.
2057
2058               If the encoding converter requires command-line parameters, you
2059               should put those within a shell  script  to  execute  the  con‐
2060               verter, and set this resource to point to the shell script.
2061
2062       loginShell (class LoginShell)
2063               Specifies  whether  or  not  the  shell to be run in the window
2064               should be started as a login shell.  The default is “false.”
2065
2066       marginBell (class MarginBell)
2067               Specifies whether or not the bell should be rung when the  user
2068               types near the right margin.  The default is “false.”
2069
2070       metaSendsEscape (class MetaSendsEscape)
2071               If  “true”, Meta characters (a character combined with the Meta
2072               modifier key) are converted into a two-character sequence  with
2073               the  character itself preceded by ESC.  This applies as well to
2074               function key control sequences, unless xterm sees that Meta  is
2075               used  in  your  key  translations.  If “false”, Meta characters
2076               input from the keyboard are handled according to the  eightBit‐
2077               Input resource.  The default is “false.”
2078
2079       mkSamplePass (class MkSamplePass)
2080               If  mkSampleSize  is  nonzero,  and  mkWidth (and cjkWidth) are
2081               false, on startup xterm compares its  built-in  tables  to  the
2082               system's wide character width data to decide if it will use the
2083               system's data.  It tests the first mkSampleSize character  val‐
2084               ues,  and  allows up to mkSamplePass mismatches before the test
2085               fails.  The default (for the allowed number of  mismatches)  is
2086               256.
2087
2088       mkSampleSize (class MkSampleSize)
2089               With  mkSamplePass, this specifies a startup test used for ini‐
2090               tializing wide character width calculations.  The default (num‐
2091               ber of characters to check) is 1024.
2092
2093       mkWidth (class MkWidth)
2094               Specifies  whether  xterm  should use a built-in version of the
2095               wide  character  width  calculation.   See  also  the  cjkWidth
2096               resource which can override this.  The default is “false.”
2097
2098               Here  is a summary of the resources which control the choice of
2099               wide character width calculation:
2100
2101               cjkWidth   mkWidth   Action
2102               ───────────────────────────────────────────────────────────────
2103               false      false     use system tables subject to mkSamplePass
2104               false      true      use built-in tables
2105               true       false     use built-in CJK tables
2106               true       true      use built-in CJK tables
2107
2108       modifyCursorKeys (class ModifyCursorKeys)
2109               Tells how to handle the special case  where  Control-,  Shift-,
2110               Alt-  or  Meta-modifiers  are  used  to  add a parameter to the
2111               escape sequence returned by a cursor-key.  The default is “2”:
2112
2113               Set it to -1 to disable it.
2114               Set it to 0 to use the old/obsolete behavior.
2115               Set it to 1 to prefix modified sequences with CSI.
2116               Set it to 2 to force the modifier to be the second parameter if
2117               it would otherwise be the first.
2118               Set  it to 3 to mark the sequence with a “>” to hint that it is
2119               private.
2120
2121       modifyFunctionKeys (class ModifyFunctionKeys)
2122               Tells how to handle the special case  where  Control-,  Shift-,
2123               Alt-  or  Meta-modifiers  are  used  to  add a parameter to the
2124               escape sequence returned by  a  (numbered)  function-key.   The
2125               default  is “2”.  The resource values are similar to modifyCur‐
2126               sorKeys:
2127
2128               Set it to -1 to permit the user to use shift- and control-modi‐
2129               fiers to construct function-key strings using the normal encod‐
2130               ing scheme.
2131               Set it to 0 to use the old/obsolete behavior.
2132               Set it to 1 to prefix modified sequences with CSI.
2133               Set it to 2 to force the modifier to be the second parameter if
2134               it would otherwise be the first.
2135               Set  it to 3 to mark the sequence with a “>” to hint that it is
2136               private.
2137
2138               If modifyFunctionKeys is zero, xterm uses Control-  and  Shift-
2139               modifiers to allow the user to construct numbered function-keys
2140               beyond the set provided by the keyboard:
2141
2142               Control
2143                    adds the value given by the ctrlFKeys resource.
2144
2145               Shift
2146                    adds twice the value given by the ctrlFKeys resource.
2147
2148               Control/Shift
2149                    adds  three  times  the  value  given  by  the   ctrlFKeys
2150                    resource.
2151
2152               As  a  special  case,  legacy (when oldFunctionKeys is true) or
2153               vt220 (when sunKeyboard is true) keyboards interpret  only  the
2154               Control-modifier   when  constructing  numbered  function-keys.
2155               This is done to provide compatible keyboards for DEC VT220  and
2156               related terminals that implement user-defined keys (UDK).
2157
2158       modifyOtherKeys (class ModifyOtherKeys)
2159               Like  modifyCursorKeys,  tells  xterm  to  construct  an escape
2160               sequence for other keys (such as "2")  when  modified  by  Con‐
2161               trol-,  Alt- or Meta-modifiers.  This feature does not apply to
2162               function keys and well-defined keys such as ESC or the  control
2163               keys.  The default is “0”:
2164
2165               0    disables this feature.
2166
2167               1    enables  this feature for keys except for those with well-
2168                    known behavior, e.g., Tab, Backarrow and some special con‐
2169                    trol character cases, e.g., Control-Space to make a NUL.
2170
2171               2    enables  this  feature  for  keys including the exceptions
2172                    listed.
2173
2174       multiClickTime (class MultiClickTime)
2175               Specifies the maximum time in milliseconds between  multi-click
2176               select events.  The default is 250 milliseconds.
2177
2178       multiScroll (class MultiScroll)
2179               Specifies  whether  or  not  scrolling  should  be  done  asyn‐
2180               chronously.  The default is “false.”
2181
2182       nMarginBell (class Column)
2183               Specifies the number of characters from  the  right  margin  at
2184               which  the  margin  bell  should  be  rung, when enabled by the
2185               marginBell resource.  The default is 10.
2186
2187       numLock (class NumLock)
2188               If “true”, xterm checks if NumLock is used as a  modifier  (see
2189               xmodmap(1)).   If  so,  this  modifier  is used to simplify the
2190               logic when implementing special  NumLock  for  the  sunKeyboard
2191               resource.   Also  (when sunKeyboard is false), similar logic is
2192               used to find the modifier associated with the  left  and  right
2193               Alt keys.  The default is “true.”
2194
2195       oldXtermFKeys (class OldXtermFKeys)
2196               If “true”, xterm will use old-style control sequences for func‐
2197               tion keys F1 to F4, for compatibility with X Consortium  xterm.
2198               Otherwise,  it  uses the VT100-style codes for PF1 to PF4.  The
2199               default is “false.”
2200
2201       on2Clicks (class On2Clicks)
2202
2203       on3Clicks (class On3Clicks)
2204
2205       on4Clicks (class On4Clicks)
2206
2207       on5Clicks (class On5Clicks)
2208               Specify  selection  behavior  in  response  to  multiple  mouse
2209               clicks.    A  single  mouse  click  is  always  interpreted  as
2210               described in the SELECTION section (see POINTER USAGE).  Multi‐
2211               ple  mouse clicks (using the button which activates the select-
2212               start action) are interpreted according to the resource  values
2213               of on2Clicks, etc.  The resource value can be one of these:
2214
2215               word
2216                  Select  a  “word”  as  determined by the charClass resource.
2217                  See the CHARACTER CLASSES section.
2218
2219               line
2220                  Select a line (counting wrapping).
2221
2222               group
2223                  Select a group of adjacent lines (counting  wrapping).   The
2224                  selection stops on a blank line, and does not extend outside
2225                  the current page.
2226
2227               page
2228                  Select all visible lines, i.e., the page.
2229
2230               all
2231                  Select all lines, i.e., including the saved lines.
2232
2233               regex
2234                  Select a “word” as  determined  by  the  regular  expression
2235                  which follows in the resource value.
2236
2237               none
2238                  No selection action is associated with this resource.  xterm
2239                  interprets it as the end of the list.  For example, you  may
2240                  use  it  to  disable triple (and higher) clicking by setting
2241                  on3Clicks to “none”.
2242
2243               The default values for on2Clicks and on3Clicks are  “word”  and
2244               “line”,  respectively.  There is no default value for on4Clicks
2245               or on5Clicks, making those inactive.  On startup, xterm  deter‐
2246               mines  the  maximum  number of clicks by the onXClicks resource
2247               values which are set.
2248
2249       openIm (class XtCOpenIm)
2250               Tells xterm whether to open the input method at  startup.   The
2251               default is “true”.
2252
2253       pointerColor (class PointerColor)
2254               Specifies  the foreground color of the pointer.  The default is
2255               “XtDefaultForeground.”
2256
2257       pointerColorBackground (class PointerColorBackground)
2258               Specifies the background color of the pointer.  The default  is
2259               “XtDefaultBackground.”
2260
2261       pointerMode (class PointerMode)
2262               Specifies when the pointer may be hidden as the user types.  It
2263               will be redisplayed if the user moves the mouse, or clicks  one
2264               of its buttons.
2265
2266               0  never
2267
2268               1  the  application  running  in  xterm has not activated mouse
2269                  mode.  This is the default.
2270
2271               2  always.
2272
2273       pointerShape (class Cursor)
2274               Specifies the name of the shape of the pointer.  The default is
2275               “xterm.”
2276
2277       popOnBell (class PopOnBell)
2278               Specifies  whether the window would be raised when Control-G is
2279               received.  The default is “false.”
2280
2281       preeditType (class XtCPreeditType)
2282               Tells xterm which types of preedit  (preconversion)  string  to
2283               display.  The default is “OverTheSpot,Root”.
2284
2285       printAttributes (class PrintAttributes)
2286               Specifies  whether  to  print graphic attributes along with the
2287               text.  A real DEC VTxxx  terminal  will  print  the  underline,
2288               highlighting  codes  but  your printer may not handle these.  A
2289               “0” disables the attributes.  A “1” prints the  normal  set  of
2290               attributes  (bold, underline, inverse and blink) as VT100-style
2291               control sequences.  A “2” prints ANSI color attributes as well.
2292               The default is “1.”
2293
2294       printerAutoClose (class PrinterAutoClose)
2295               If  “true”,  xterm  will  close  the  printer (a pipe) when the
2296               application switches the printer offline with a Media Copy com‐
2297               mand.  The default is “false.”
2298
2299       printerCommand (class PrinterCommand)
2300               Specifies  a shell command to which xterm will open a pipe when
2301               the first MC (Media Copy) command is initiated.  The default is
2302               a  blank  string.   If  the  resource value is given as a blank
2303               string, the printer is disabled.
2304
2305       printerControlMode (class PrinterControlMode)
2306               Specifies the printer control mode.  A  “1”  selects  autoprint
2307               mode,  which  causes xterm to print a line from the screen when
2308               you move the cursor off that line with a line feed,  form  feed
2309               or  vertical  tab  character, or an autowrap occurs.  Autoprint
2310               mode is overridden by printer controller mode  (a  “2”),  which
2311               causes  all  of  the output to be directed to the printer.  The
2312               default is “0.”
2313
2314       printerExtent (class PrinterExtent)
2315               Controls whether a print page function will  print  the  entire
2316               page  (true), or only the the portion within the scrolling mar‐
2317               gins (false).  The default is “false.”
2318
2319       printerFormFeed (class PrinterFormFeed)
2320               Controls whether a form feed is sent to the printer at the  end
2321               of a print page function.  The default is “false.”
2322
2323       printerNewLine (class PrinterNewLine)
2324               Controls whether a newline is sent to the printer at the end of
2325               a print page function.  The default is “true.”
2326
2327       quietGrab (class QuietGrab)
2328               Controls whether the cursor is repainted  when  NotifyGrab  and
2329               NotifyUngrab  event  types are received during change of focus.
2330               The default is “false.”
2331
2332       renderFont (class RenderFont)
2333               If xterm is built with the Xft library, this  controls  whether
2334               the faceName resource is used.  The default is “true.”
2335
2336       resizeGravity (class ResizeGravity)
2337               Affects the behavior when the window is resized to be taller or
2338               shorter.  NorthWest specifies that the top line of text on  the
2339               screen  stay  fixed.   If the window is made shorter, lines are
2340               dropped from the bottom; if the window is  made  taller,  blank
2341               lines  are  added  at  the bottom.  This is compatible with the
2342               behavior in R4.  SouthWest (the  default)  specifies  that  the
2343               bottom line of text on the screen stay fixed.  If the window is
2344               made taller, additional saved lines will be scrolled down  onto
2345               the  screen;  if  the  window  is  made  shorter, lines will be
2346               scrolled off the top of the screen, and  the  top  saved  lines
2347               will be dropped.
2348
2349       retryInputMethod (class XtCRetryInputMethod)
2350               Tells  xterm  how many times to retry, in case the input-method
2351               server is not responding.   This  is  a  different  issue  than
2352               unsupported  preedit  type,  etc.  You may encounter retries if
2353               your X configuration (and its libraries)  are  missing  pieces.
2354               Setting  this  resource to zero ``0'' will cancel the retrying.
2355               The default is ``3''.
2356
2357       reverseVideo (class ReverseVideo)
2358               Specifies whether or not reverse  video  should  be  simulated.
2359               The default is “false.”
2360
2361       reverseWrap (class ReverseWrap)
2362               Specifies  whether or not reverse-wraparound should be enabled.
2363               This corresponds to xterm's private mode 45.   The  default  is
2364               “false.”
2365
2366       rightScrollBar (class RightScrollBar)
2367               Specifies  whether  or not the scrollbar should be displayed on
2368               the right rather than the left.  The default is “false.”
2369
2370       saveLines (class SaveLines)
2371               Specifies the number of lines to save beyond  the  top  of  the
2372               screen when a scrollbar is turned on.  The default is 64.
2373
2374       scrollBar (class ScrollBar)
2375               Specifies  whether  or  not  the scrollbar should be displayed.
2376               The default is “false.”
2377
2378       scrollBarBorder (class ScrollBarBorder)
2379               Specifies the width of the scrollbar border.  Note that this is
2380               drawn to overlap the border of the xterm window.  Modifying the
2381               scrollbar's border affects only the line between the VT100 wid‐
2382               get and the scrollbar.  The default value is 1.
2383
2384       scrollKey (class ScrollCond)
2385               Specifies  whether  or  not pressing a key should automatically
2386               cause the scrollbar to  go  to  the  bottom  of  the  scrolling
2387               region.   This  corresponds  to xterm's private mode 1011.  The
2388               default is “false.”
2389
2390       scrollLines (class ScrollLines)
2391               Specifies the number of lines that the scroll-back and  scroll-
2392               forw actions should use as a default.  The default value is 1.
2393
2394       scrollTtyOutput (class ScrollCond)
2395               Specifies whether or not output to the terminal should automat‐
2396               ically cause the scrollbar to go to the bottom of the scrolling
2397               region.  The default is “true.”
2398
2399       selectToClipboard (class SelectToClipboard)
2400               Tells  xterm whether to use the PRIMARY or CLIPBOARD for SELECT
2401               tokens in the selection mechanism.  The set-select  action  can
2402               change this at runtime, allowing the user to work with programs
2403               that handle only one  of  these  mechanisms.   The  default  is
2404               “false”, which tells it to use PRIMARY.
2405
2406       shiftFonts (class ShiftFonts)
2407               Specifies  whether  to  enable the actions larger-vt-font() and
2408               smaller-vt-font(), which are  normally  bound  to  the  shifted
2409               KP_Add and KP_Subtract.  The default is “true.”
2410
2411       showBlinkAsBold (class ShowBlinkAsBold)
2412               Tells  xterm  whether  to display text with blink-attribute the
2413               same as bold.  If xterm has  not  been  configured  to  support
2414               blinking  text,  the  default  is “true.”, which corresponds to
2415               older versions of xterm, otherwise the default is “false.”
2416
2417       showMissingGlyphs (class ShowMissingGlyphs)
2418               Tells xterm whether to display a box outlining places  where  a
2419               character  has been used that the font does not represent.  The
2420               default is “false.”
2421
2422       signalInhibit (class SignalInhibit)
2423               Specifies whether or not the entries in the “Main Options” menu
2424               for sending signals to xterm should be disallowed.  The default
2425               is “false.”
2426
2427       tekGeometry (class Geometry)
2428               Specifies the preferred size and position of the Tektronix win‐
2429               dow.  There is no default for this resource.
2430
2431       tekInhibit (class TekInhibit)
2432               Specifies whether or not the escape sequence to enter Tektronix
2433               mode should be ignored.  The default is “false.”
2434
2435       tekSmall (class TekSmall)
2436               Specifies whether or not the Tektronix mode window should start
2437               in its smallest size if no explicit geometry is given.  This is
2438               useful when running xterm on displays with small screens.   The
2439               default is “false.”
2440
2441       tekStartup (class TekStartup)
2442               Specifies  whether  or  not  xterm should start up in Tektronix
2443               mode.  The default is “false.”
2444
2445       tiXtraScroll (class TiXtraScroll)
2446               Specifies whether xterm should scroll to a new page  when  pro‐
2447               cessing  the ti termcap entry, i.e., the private modes 47, 1047
2448               or 1049.  This is only in  effect  if  titeInhibit  is  “true”,
2449               because  the  intent  of this option is to provide a picture of
2450               the full-screen application's display on the scrollback without
2451               wiping  out the text that would be shown before the application
2452               was initialized.  The default for this resource is “false.”
2453
2454       titeInhibit (class TiteInhibit)
2455               Specifies whether or not xterm should remove ti and te  termcap
2456               entries (used to switch between alternate screens on startup of
2457               many screen-oriented programs) from  the  TERMCAP  string.   If
2458               set,  xterm  also  ignores the escape sequence to switch to the
2459               alternate screen.  Xterm supports terminfo in a different  way,
2460               supporting  composite  control sequences (also known as private
2461               modes) 1047, 1048 and 1049 which have the same  effect  as  the
2462               original 47 control sequence.  The default for this resource is
2463               “false.”
2464
2465       translations (class Translations)
2466               Specifies the key and button bindings  for  menus,  selections,
2467               “programmed  strings,”  etc.   The translations resource, which
2468               provides much of xterm's configurability, is a feature of the X
2469               Toolkit Intrinsics library (Xt).  See the ACTIONS section.
2470
2471       trimSelection (class TrimSelection)
2472               If  you  set  highlightSelection, you can see the text which is
2473               selected, including any trailing spaces.  Clearing  the  screen
2474               (or  a  line)  resets it to a state containing no spaces.  Some
2475               lines may contain trailing spaces when  an  application  writes
2476               them  to  the screen.  However, you may not wish to paste lines
2477               with trailing spaces.  If this resource  is  true,  xterm  will
2478               trim  trailing spaces from text which is selected.  It does not
2479               affect spaces which result in a wrapped line, nor will it  trim
2480               the  trailing  newline  from  your  selection.   The default is
2481               “false.”
2482
2483       underLine (class UnderLine)
2484               This specifies whether or not text with the underline attribute
2485               should be underlined.  It may be desirable to disable underlin‐
2486               ing when color is being used for the underline attribute.   The
2487               default is “true.”
2488
2489       useClipping (class UseClipping)
2490               Tell  xterm whether to use clipping to keep from producing dots
2491               outside the text drawing area.  Originally used to work  around
2492               for overstriking effects, this is also needed to work with some
2493               incorrectly-sized fonts.  The default is “true.”
2494
2495       utf8 (class Utf8)
2496               This specifies whether xterm will run in UTF-8  mode.   If  you
2497               set  this resource, xterm also sets the wideChars resource as a
2498               side-effect.  The resource is an  integer,  expected  to  range
2499               from 0 to 3:
2500
2501               0  UTF-8  mode  is  initially off.  The command-line option +u8
2502                  sets the resource to this value.  Escape sequences for turn‐
2503                  ing UTF-8 mode on/off are allowed.
2504
2505               1  UTF-8  mode  is  initially on.  Escape sequences for turning
2506                  UTF-8 mode on/off are allowed.
2507
2508               2  The command-line option -u8 sets the resource to this value.
2509                  Escape sequences for turning UTF-8 mode on/off are ignored.
2510
2511               3  This  is  the  default value of the resource.  It is changed
2512                  during  initialization  depending  on  whether  the   locale
2513                  resource  was  set,  to 0 or 2.  See the locale resource for
2514                  additional discussion of non-UTF-8 locales.
2515
2516               If you want to set the value of utf8,  it  should  be  in  this
2517               range.  Other nonzero values are treated the same as “1”, i.e.,
2518               UTF-8 mode is initially on, and escape  sequences  for  turning
2519               UTF-8 mode on/off are allowed.
2520
2521       utf8Fonts (class Utf8Fonts)
2522               See the discussion of the locale resource.
2523
2524       utf8Latin1 (class Utf8Latin1)
2525               If true, allow an ISO-8859-1 normal font to be combined with an
2526               ISO-10646 font if the latter is given via the -fw option or its
2527               corresponding resource value.  The default is “false.”
2528
2529       utf8SelectTypes (class Utf8SelectTypes)
2530               Override   xterm's   default   selection   target   list   (see
2531               SELECT/PASTE) for selections in  wide-character  (UTF-8)  mode.
2532               The  default  is  an empty string, which does not override any‐
2533               thing.
2534
2535       utf8Title (class Utf8Title)
2536               Applications  can  set  xterm's  title  by  writing  a  control
2537               sequence.   Normally  this  control  sequence follows the VT220
2538               convention, which encodes the string in ISO-8859-1  and  allows
2539               for an 8-bit string terminator.  If xterm is started in a UTF-8
2540               locale, it translates the ISO-8859-1 string to  UTF-8  to  work
2541               with the X libraries which assume the string is UTF-8.
2542
2543               However, some users may wish to write a title string encoded in
2544               UTF-8.  Set this resource to  “true”  to  allow  UTF-8  encoded
2545               title strings.  That cancels the translation to UTF-8, allowing
2546               UTF-8 strings to be displayed as is.
2547
2548               This feature is available as a menu entry, since it is  related
2549               to  the  particular  applications you are running within xterm.
2550               You can also use a control  sequence  (see  the  discussion  of
2551               "Title  Modes"  in  the  control sequences document), to set an
2552               equivalent flag.
2553
2554               The default is “false.”
2555
2556       veryBoldColors (class VeryBoldColors)
2557               Specifies whether to combine video attributes with colors spec‐
2558               ified  by  colorBD, colorBL, colorRV and colorUL.  The resource
2559               value is the sum of values for each attribute:
2560                 1 for reverse,
2561                 2 for underline,
2562                 4 for bold and
2563                 8 for blink.
2564
2565               The default is “0.”
2566
2567       visualBell (class VisualBell)
2568               Specifies whether or not a visible bell (i.e., flashing) should
2569               be  used instead of an audible bell when Control-G is received.
2570               The default is “false.”
2571
2572       visualBellDelay (class VisualBellDelay)
2573               Number of milliseconds to delay when displaying a visual  bell.
2574               Default  is  100.  If set to zero, no visual bell is displayed.
2575               This is useful for very slow displays, e.g., an LCD display  on
2576               a laptop.
2577
2578       vt100Graphics (class VT100Graphics)
2579               This specifies whether xterm will interpret VT100 graphic char‐
2580               acter escape sequences while in UTF-8  mode.   The  default  is
2581               “true”, to provide support for various legacy applications.
2582
2583       wideBoldFont (class WideBoldFont)
2584               This  option  specifies the font to be used for displaying bold
2585               wide text.  By default, it will attempt to use a font twice  as
2586               wide  as  the  font that will be used to draw bold text.  If no
2587               double-width font is found, it will  improvise,  by  stretching
2588               the bold font.
2589
2590       wideChars (class WideChars)
2591               Specifies  if  xterm  should  respond to control sequences that
2592               process 16-bit characters.  The default is “false.”
2593
2594       wideFont (class WideFont)
2595               This option specifies the font to be used for  displaying  wide
2596               text.   By default, it will attempt to use a font twice as wide
2597               as the font that will be used to draw normal text.  If no  dou‐
2598               ble-width  font  is found, it will improvise, by stretching the
2599               normal font.
2600
2601       ximFont (class XimFont)
2602               This option specifies the font to be used  for  displaying  the
2603               preedit string in the "OverTheSpot" input method.
2604
2605               In  "OverTheSpot"  preedit  type,  the  preedit (preconversion)
2606               string is displayed at the position of the cursor.  It  is  the
2607               XIM server's responsibility to display the preedit string.  The
2608               XIM client must inform the XIM server of the  cursor  position.
2609               For  best  results, the preedit string must be displayed with a
2610               proper font.  Therefore, xterm informs the XIM  server  of  the
2611               proper  font.   The  font  is be supplied by a "fontset", whose
2612               default value is "*".  This matches every font, the  X  library
2613               automatically  chooses fonts with proper charsets.  The ximFont
2614               resource is provided to override this default font setting.
2615
2616   Tek4014 Widget Resources
2617       The following resources are specified as part  of  the  tek4014  widget
2618       (class   Tek4014).    These   are   specified   by   patterns  such  as
2619       "XTerm.tek4014.NAME":
2620
2621       font2 (class Font)
2622               Specifies font number 2 to use in the Tektronix window.
2623
2624       font3 (class Font)
2625               Specifies font number 3 to use in the Tektronix window.
2626
2627       fontLarge (class Font)
2628               Specifies the large font to use in the Tektronix window.
2629
2630       fontSmall (class Font)
2631               Specifies the small font to use in the Tektronix window.
2632
2633       ginTerminator (class GinTerminator)
2634               Specifies what character(s) should follow a GIN report or  sta‐
2635               tus  report.  The possibilities are “none,” which sends no ter‐
2636               minating characters, “CRonly,” which sends  CR,  and  “CR&EOT,”
2637               which sends both CR and EOT.  The default is “none.”
2638
2639       height (class Height)
2640               Specifies the height of the Tektronix window in pixels.
2641
2642       initialFont (class InitialFont)
2643               Specifies  which  of the four Tektronix fonts to use initially.
2644               Values are the  same  as  for  the  set-tek-text  action.   The
2645               default is “large.”
2646
2647       width (class Width)
2648               Specifies the width of the Tektronix window in pixels.
2649
2650   Menu Resources
2651       The resources that may be specified for the various menus are described
2652       in the documentation for the Athena SimpleMenu widget.   The  name  and
2653       classes  of  the  entries  in  each  of  the  menus  are  listed below.
2654       Resources named "lineN" where N is a number are separators  with  class
2655       SmeLine.
2656
2657       The mainMenu has the following entries:
2658
2659       toolbar (class SmeBSB)
2660               This entry invokes the set-toolbar(toggle) action.
2661
2662       securekbd (class SmeBSB)
2663               This entry invokes the secure() action.
2664
2665       allowsends (class SmeBSB)
2666               This entry invokes the allow-send-events(toggle) action.
2667
2668       redraw (class SmeBSB)
2669               This entry invokes the redraw() action.
2670
2671       logging (class SmeBSB)
2672               This entry invokes the logging(toggle) action.
2673
2674       print (class SmeBSB)
2675               This entry invokes the print() action.
2676
2677       print-redir (class SmeBSB)
2678               This entry invokes the print-redir() action.
2679
2680       8-bit-control (class SmeBSB)
2681               This entry invokes the set-8-bit-control(toggle) action.
2682
2683       backarrow key (class SmeBSB)
2684               This entry invokes the set-backarrow(toggle) action.
2685
2686       num-lock (class SmeBSB)
2687               This entry invokes the set-num-lock(toggle) action.
2688
2689       alt-esc (class SmeBSB)
2690               This entry invokes the alt-sends-escape(toggle) action.
2691
2692       meta-esc (class SmeBSB)
2693               This entry invokes the meta-sends-escape(toggle) action.
2694
2695       delete-is-del (class SmeBSB)
2696               This entry invokes the delete-is-del(toggle) action.
2697
2698       oldFunctionKeys (class SmeBSB)
2699               This entry invokes the old-function-keys(toggle) action.
2700
2701       hpFunctionKeys (class SmeBSB)
2702               This entry invokes the hp-function-keys(toggle) action.
2703
2704       scoFunctionKeys (class SmeBSB)
2705               This entry invokes the sco-function-keys(toggle) action.
2706
2707       sunFunctionKeys (class SmeBSB)
2708               This entry invokes the sun-function-keys(toggle) action.
2709
2710       sunKeyboard (class SmeBSB)
2711               This entry invokes the sunKeyboard(toggle) action.
2712
2713       suspend (class SmeBSB)
2714               This entry invokes the send-signal(tstp) action on systems that
2715               support job control.
2716
2717       continue (class SmeBSB)
2718               This entry invokes the send-signal(cont) action on systems that
2719               support job control.
2720
2721       interrupt (class SmeBSB)
2722               This entry invokes the send-signal(int) action.
2723
2724       hangup (class SmeBSB)
2725               This entry invokes the send-signal(hup) action.
2726
2727       terminate (class SmeBSB)
2728               This entry invokes the send-signal(term) action.
2729
2730       kill (class SmeBSB)
2731               This entry invokes the send-signal(kill) action.
2732
2733       quit (class SmeBSB)
2734               This entry invokes the quit() action.
2735
2736       The vtMenu has the following entries:
2737
2738       scrollbar (class SmeBSB)
2739               This entry invokes the set-scrollbar(toggle) action.
2740
2741       jumpscroll (class SmeBSB)
2742               This entry invokes the set-jumpscroll(toggle) action.
2743
2744       reversevideo (class SmeBSB)
2745               This entry invokes the set-reverse-video(toggle) action.
2746
2747       autowrap (class SmeBSB)
2748               This entry invokes the set-autowrap(toggle) action.
2749
2750       reversewrap (class SmeBSB)
2751               This entry invokes the set-reversewrap(toggle) action.
2752
2753       autolinefeed (class SmeBSB)
2754               This entry invokes the set-autolinefeed(toggle) action.
2755
2756       appcursor (class SmeBSB)
2757               This entry invokes the set-appcursor(toggle) action.
2758
2759       appkeypad (class SmeBSB)
2760               This entry invokes the set-appkeypad(toggle) action.
2761
2762       scrollkey (class SmeBSB)
2763               This entry invokes the set-scroll-on-key(toggle) action.
2764
2765       scrollttyoutput (class SmeBSB)
2766               This entry invokes the set-scroll-on-tty-output(toggle) action.
2767
2768       allow132 (class SmeBSB)
2769               This entry invokes the set-allow132(toggle) action.
2770
2771       cursesemul (class SmeBSB)
2772               This entry invokes the set-cursesemul(toggle) action.
2773
2774       visualbell (class SmeBSB)
2775               This entry invokes the set-visualbell(toggle) action.
2776
2777       bellIsUrgent (class SmeBSB)
2778               This entry invokes the set-bellIsUrgent(toggle) action.
2779
2780       poponbell (class SmeBSB)
2781               This entry invokes the set-poponbell(toggle) action.
2782
2783       cursorblink (class SmeBSB)
2784               This entry invokes the set-cursorblink(toggle) action.
2785
2786       titeInhibit (class SmeBSB)
2787               This entry invokes the set-titeInhibit(toggle) action.
2788
2789       activeicon (class SmeBSB)
2790               This  entry toggles active icons on and off if this feature was
2791               compiled into xterm.  It is enabled only if xterm  was  started
2792               with  the command line option +ai or the activeIcon resource is
2793               set to “true.”
2794
2795       softreset (class SmeBSB)
2796               This entry invokes the soft-reset() action.
2797
2798       hardreset (class SmeBSB)
2799               This entry invokes the hard-reset() action.
2800
2801       clearsavedlines (class SmeBSB)
2802               This entry invokes the clear-saved-lines() action.
2803
2804       tekshow (class SmeBSB)
2805               This entry invokes the set-visibility(tek,toggle) action.
2806
2807       tekmode (class SmeBSB)
2808               This entry invokes the set-terminal-type(tek) action.
2809
2810       vthide (class SmeBSB)
2811               This entry invokes the set-visibility(vt,off) action.
2812
2813       altscreen (class SmeBSB)
2814               This entry invokes the set-altscreen(toggle) action.
2815
2816       The fontMenu has the following entries:
2817
2818       fontdefault (class SmeBSB)
2819               This entry invokes the set-vt-font(d) action.
2820
2821       font1 (class SmeBSB)
2822               This entry invokes the set-vt-font(1) action.
2823
2824       font2 (class SmeBSB)
2825               This entry invokes the set-vt-font(2) action.
2826
2827       font3 (class SmeBSB)
2828               This entry invokes the set-vt-font(3) action.
2829
2830       font4 (class SmeBSB)
2831               This entry invokes the set-vt-font(4) action.
2832
2833       font5 (class SmeBSB)
2834               This entry invokes the set-vt-font(5) action.
2835
2836       font6 (class SmeBSB)
2837               This entry invokes the set-vt-font(6) action.
2838
2839       fontescape (class SmeBSB)
2840               This entry invokes the set-vt-font(e) action.
2841
2842       fontsel (class SmeBSB)
2843               This entry invokes the set-vt-font(s) action.
2844
2845       font-linedrawing (class SmeBSB)
2846               This entry invokes the set-font-linedrawing(s) action.
2847
2848       font-packed (class SmeBSB)
2849               This entry invokes the set-font-packed(s) action.
2850
2851       font-doublesize (class SmeBSB)
2852               This entry invokes the set-font-doublesize(s) action.
2853
2854       render-font (class SmeBSB)
2855               This entry invokes the set-render-font(s) action.
2856
2857       utf8-mode (class SmeBSB)
2858               This entry invokes the set-utf8-mode(s) action.
2859
2860       utf8-title (class SmeBSB)
2861               This entry invokes the set-utf8-title(s) action.
2862
2863       The tekMenu has the following entries:
2864
2865       tektextlarge (class SmeBSB)
2866               This entry invokes the set-tek-text(large) action.
2867
2868       tektext2 (class SmeBSB)
2869               This entry invokes the set-tek-text(2) action.
2870
2871       tektext3 (class SmeBSB)
2872               This entry invokes the set-tek-text(3) action.
2873
2874       tektextsmall (class SmeBSB)
2875               This entry invokes the set-tek-text(small) action.
2876
2877       tekpage (class SmeBSB)
2878               This entry invokes the tek-page() action.
2879
2880       tekreset (class SmeBSB)
2881               This entry invokes the tek-reset() action.
2882
2883       tekcopy (class SmeBSB)
2884               This entry invokes the tek-copy() action.
2885
2886       vtshow (class SmeBSB)
2887               This entry invokes the set-visibility(vt,toggle) action.
2888
2889       vtmode (class SmeBSB)
2890               This entry invokes the set-terminal-type(vt) action.
2891
2892       tekhide (class SmeBSB)
2893               This entry invokes the set-visibility(tek,toggle) action.
2894
2895   Scrollbar Resources
2896       The following resources  are  useful  when  specified  for  the  Athena
2897       Scrollbar widget:
2898
2899       thickness (class Thickness)
2900               Specifies the width in pixels of the scrollbar.
2901
2902       background (class Background)
2903               Specifies the color to use for the background of the scrollbar.
2904
2905       foreground (class Foreground)
2906               Specifies the color to use for the foreground of the scrollbar.
2907               The “thumb” of the scrollbar is a simple  checkerboard  pattern
2908               alternating pixels for foreground and background color.
2909

POINTER USAGE

2911       Once  the  VT102 window is created, xterm allows you to select text and
2912       copy it within the same or other windows.
2913
2914   SELECTION
2915       The selection functions are invoked when the pointer buttons  are  used
2916       with  no  modifiers,  and when they are used with the “shift” key.  The
2917       assignment of the functions described below to keys and buttons may  be
2918       changed through the resource database; see ACTIONS below.
2919
2920       Pointer  button  one  (usually  left) is used to save text into the cut
2921       buffer.  Move the cursor to beginning of the text, and  then  hold  the
2922       button  down  while  moving  the  cursor  to  the end of the region and
2923       releasing the button.  The selected text is highlighted and is saved in
2924       the global cut buffer and made the PRIMARY selection when the button is
2925       released.  Normally (but see the discussion of on2Clicks, etc):
2926
2927              -  Double-clicking selects by words.
2928
2929              -  Triple-clicking selects by lines.
2930
2931              -  Quadruple-clicking goes back to characters, etc.
2932
2933       Multiple-click is determined by the time from button up to button down,
2934       so  you  can  change  the  selection unit in the middle of a selection.
2935       Logical words and lines selected by double- or triple-clicking may wrap
2936       across  more than one screen line if lines were wrapped by xterm itself
2937       rather than by the application running in the window.  If the  key/but‐
2938       ton  bindings  specify  that  an  X selection is to be made, xterm will
2939       leave the selected text highlighted for as long as it is the  selection
2940       owner.
2941
2942       Pointer  button two (usually middle) “types” (pastes) the text from the
2943       PRIMARY selection, if any, otherwise from the cut buffer, inserting  it
2944       as keyboard input.
2945
2946       Pointer  button  three  (usually  right) extends the current selection.
2947       (Without loss of generality, you can swap “right” and “left” everywhere
2948       in  the  rest of this paragraph.)  If pressed while closer to the right
2949       edge of the selection than the left,  it  extends/contracts  the  right
2950       edge  of  the  selection.   If you contract the selection past the left
2951       edge of the selection, xterm assumes you really meant  the  left  edge,
2952       restores  the  original selection, then extends/contracts the left edge
2953       of the selection.  Extension starts in the selection unit mode that the
2954       last selection or extension was performed in; you can multiple-click to
2955       cycle through them.
2956
2957       By cutting and pasting pieces of text without trailing new  lines,  you
2958       can  take text from several places in different windows and form a com‐
2959       mand to the shell, for example, or  take  output  from  a  program  and
2960       insert  it  into  your favorite editor.  Since cut buffers are globally
2961       shared among different applications, you may regard each  as  a  “file”
2962       whose contents you know.  The terminal emulator and other text programs
2963       should be treating it as if it were a text  file,  i.e.,  the  text  is
2964       delimited by new lines.
2965
2966   SCROLLING
2967       The  scroll  region  displays the position and amount of text currently
2968       showing in the window (highlighted) relative  to  the  amount  of  text
2969       actually saved.  As more text is saved (up to the maximum), the size of
2970       the highlighted area decreases.
2971
2972       Clicking button one with the pointer in the  scroll  region  moves  the
2973       adjacent line to the top of the display window.
2974
2975       Clicking  button three moves the top line of the display window down to
2976       the pointer position.
2977
2978       Clicking button two moves the display to a position in the  saved  text
2979       that corresponds to the pointer's position in the scrollbar.
2980
2981   TEKTRONIX POINTER
2982       Unlike  the VT102 window, the Tektronix window does not allow the copy‐
2983       ing of text.  It does allow Tektronix GIN mode, and in  this  mode  the
2984       cursor  will  change  from  an arrow to a cross.  Pressing any key will
2985       send that key and the current coordinate of the cross cursor.  Pressing
2986       button  one,  two,  or three will return the letters “l”, “m”, and “r”,
2987       respectively.  If the “shift” key is pressed when a pointer  button  is
2988       pressed, the corresponding upper case letter is sent.  To distinguish a
2989       pointer button from a key, the high bit of the character  is  set  (but
2990       this  is  bit is normally stripped unless the terminal mode is RAW; see
2991       tty(4) for details).
2992

SELECT/PASTE

2994       X clients provide select and paste support by  responding  to  requests
2995       conveyed by the server.
2996
2997   PRIMARY
2998       When  configured  to use the primary selection, (the default) xterm can
2999       provide the selection data in  ways  which  help  to  retain  character
3000       encoding information as it is pasted.
3001
3002       A  user "selects" text on xterm, which highlights the selected text.  A
3003       subsequent "paste" to another client forwards a request to  the  client
3004       owning  the  selection.   If xterm owns the primary selection, it makes
3005       the data available in the form of one or more "selection targets".   If
3006       it  does  not own the primary selection, e.g., if it has released it or
3007       another client has asserted ownership, it relies on cut-buffers to pass
3008       the  data.   But  cut-buffers handle only ISO-8859-1 data (officially -
3009       some clients ignore the rules).
3010
3011   CLIPBOARD
3012       When configured to use the clipboard (see resource  selectToClipboard),
3013       the  problem  with  persistence  of  ownership is bypassed.  Otherwise,
3014       there is no difference regarding the  data  which  can  be  passed  via
3015       selection.
3016
3017   SELECTION TARGETS
3018       The different types of data which are passed depend on what the receiv‐
3019       ing client asks for.  These are termed selection targets.
3020
3021       When asking for the selection data, xterm tries the following types  in
3022       this order:
3023
3024              UTF8_STRING
3025                   This  is  an XFree86 extension, which denotes that the data
3026                   is encoded in UTF-8.  When xterm is built with wide-charac‐
3027                   ter support, it both accepts and provides this type.
3028
3029              TEXT the  text is in the encoding which corresponds to your cur‐
3030                   rent locale.
3031
3032              COMPOUND_TEXT
3033                   this is a format for multiple character set data,  such  as
3034                   multi-lingual  text.   It can store UTF-8 data as a special
3035                   case.
3036
3037              STRING
3038                   This is Latin 1 (ISO-8859-1) data.
3039
3040       The middle two (TEXT and COMPOUND_TEXT) are added if xterm  is  config‐
3041       ured with the i18nSelections resource set to “true”.
3042
3043       UTF8_STRING  is  preferred  (therefore  first  in the list) since xterm
3044       stores text as Unicode data when running in wide-character mode, and no
3045       translation  is  needed.  On the other hand, TEXT and COMPOUND_TEXT may
3046       require translation.  If  the  translation  is  incomplete,  they  will
3047       insert X's “defaultString” whose value cannot be set, and may simply be
3048       empty.  Xterm's defaultString resource specifies the string to use  for
3049       incomplete translations of the UTF8_STRING.
3050
3051       You can alter the types which xterm tries using the eightBitSelectTypes
3052       or utf8SelectTypes resources.  For instance, you might have  some  spe‐
3053       cific  locale  setting which does not use UTF-8 encoding.  The resource
3054       value is a comma-separated list of the selection targets, which consist
3055       of  the  names  shown.  You can use the special name I18N to denote the
3056       optional inclusion of TEXT and COMPOUND_TEXT.  The  names  are  matched
3057       ignoring  case,  and  can  be  abbreviated.   The  default  list can be
3058       expressed in several ways, e.g.,
3059
3060              UTF8_STRING,I18N,STRING
3061              utf8,i18n,string
3062              u,i,s
3063
3065       Xterm has four menus, named mainMenu, vtMenu,  fontMenu,  and  tekMenu.
3066       Each  menu  pops  up  under  the correct combinations of key and button
3067       presses.  Each menu is divided into sections, separated by a horizontal
3068       line.   Some  menu  entries correspond to modes that can be altered.  A
3069       check mark appears next to a mode that is currently active.   Selecting
3070       one of these modes toggles its state.  Other menu entries are commands;
3071       selecting one of these performs the indicated function.
3072
3073       All of the menu entries correspond to X actions.  In  the  list  below,
3074       the menu label is shown followed by the action's name in parenthesis.
3075
3076   Main Options
3077       The  xterm  mainMenu  pops up when the “control” key and pointer button
3078       one are pressed in a window.  This menu contains items  that  apply  to
3079       both the VT102 and Tektronix windows.  There are several sections:
3080
3081       Commands for managing X events:
3082
3083              Toolbar
3084                     Clicking on the "Toolbar" menu entry hides the toolbar if
3085                     it is visible, and shows it if it is not.
3086
3087              Secure Keyboard (securekbd)
3088                     The Secure Keyboard mode is helpful when typing in  pass‐
3089                     words or other sensitive data in an unsecure environment;
3090                     see SECURITY below (but read the limitations carefully).
3091
3092              Allow SendEvents (allowsends)
3093                     Specifies whether or not synthetic key and button  events
3094                     generated  using  the X protocol SendEvent request should
3095                     be interpreted or discarded.   This  corresponds  to  the
3096                     allowSendEvents resource.
3097
3098              Redraw Window (redraw)
3099                     Forces  the X display to repaint; useful in some environ‐
3100                     ments.
3101
3102       Commands for capturing output:
3103
3104              Log to File (logging)
3105                     Captures text sent to the screen in a logfile, as in  the
3106                     -l logging option.
3107
3108              Print Window (print)
3109                     Sends the text of the current window to the program given
3110                     in the printerCommand resource.
3111
3112              Redirect to Printer (print-redir)
3113                     This sets the printerControlMode to 0 or 2.  You can  use
3114                     this to turn the printer on as if an application had sent
3115                     the appropriate control sequence.  It is also useful  for
3116                     switching  the  printer off if an application turns it on
3117                     without resetting the print control mode.
3118
3119       Modes for setting keyboard style:
3120
3121              8-Bit Controls (8-bit-control)
3122                     Enabled for VT220 emulation, this controls whether  xterm
3123                     will send 8-bit control sequences rather than using 7-bit
3124                     (ASCII) controls, e.g.,  sending  a  byte  in  the  range
3125                     128-159  rather  than  the escape character followed by a
3126                     second byte.  Xterm  always  interprets  both  8-bit  and
3127                     7-bit  control  sequences (see the document Xterm Control
3128                     Sequences).   This  corresponds  to  the  eightBitControl
3129                     resource.
3130
3131              Backarrow Key (BS/DEL) (backarrow key)
3132                     Modifies  the  behavior  of  the backarrow key, making it
3133                     transmit either a backspace (8) or delete  (127)  charac‐
3134                     ter.  This corresponds to the backarrowKey resource.
3135
3136              Alt/NumLock Modifiers (num-lock)
3137                     Controls the treatment of Alt- and NumLock-key modifiers.
3138                     This corresponds to the numLock resource.
3139
3140              Meta Sends Escape (meta-esc)
3141                     Controls whether Meta keys are converted into a two-char‐
3142                     acter sequence with the character itself preceded by ESC.
3143                     This corresponds to the metaSendsEscape resource.
3144
3145              Delete is DEL (delete-is-del)
3146                     Controls whether the Delete key  on  the  editing  keypad
3147                     should  send  DEL  (127) or the VT220-style Remove escape
3148                     sequence.  This corresponds to the deleteIsDEL resource.
3149
3150              Old Function-Keys (oldFunctionKeys)
3151
3152              HP Function-Keys (hpFunctionKeys)
3153
3154              SCO Function-Keys (scoFunctionKeys)
3155
3156              Sun Function-Keys (sunFunctionKeys)
3157
3158              VT220 Keyboard (sunKeyboard)
3159                     These act as a radio-button, selecting one style for  the
3160                     keyboard   layout.   It  corresponds  to  more  than  one
3161                     resource setting: sunKeyboard, sunFunctionKeys,  scoFunc‐
3162                     tionKeys and hpFunctionKeys ."
3163
3164       Commands for process signalling:
3165
3166              Send STOP Signal (suspend)
3167
3168              Send CONT Signal (continue)
3169
3170              Send INT Signal (interrupt)
3171
3172              Send HUP Signal (hangup)
3173
3174              Send TERM Signal (terminate)
3175
3176              Send KILL Signal (kill)
3177                     These  send the SIGTSTP, SIGCONT, SIGINT, SIGHUP, SIGTERM
3178                     and SIGKILL signals respectively, to the process group of
3179                     the process running under xterm (usually the shell).  The
3180                     SIGCONT function is especially useful  if  the  user  has
3181                     accidentally typed CTRL-Z, suspending the process.
3182
3183              Quit (quit)
3184                     Stop  processing  X  events  except  to support the -hold
3185                     option, and then send a SIGHUP signal to the the  process
3186                     group  of  the  process  running under xterm (usually the
3187                     shell).
3188
3189   VT Options
3190       The vtMenu sets various modes in the VT102 emulation, and is popped  up
3191       when  the “control” key and pointer button two are pressed in the VT102
3192       window.
3193
3194       VT102/VT220 Modes:
3195
3196              Enable Scrollbar (scrollbar)
3197                     Enable (or disable) the scrollbar.  This  corresponds  to
3198                     the -sb option and the scrollBar resource.
3199
3200              Enable Jump Scroll (jumpscroll)
3201                     Enable  (or disable) jump scrolling.  This corresponds to
3202                     the -j option and the jumpScroll resource.
3203
3204              Enable Reverse Video (reversevideo)
3205                     Enable (or disable) reverse-video.  This  corresponds  to
3206                     the -rv option and the reverseVideo resource.
3207
3208              Enable Auto Wraparound (autowrap)
3209                     Enable (or disable) auto-wraparound.  This corresponds to
3210                     the -aw option and the autoWrap resource.
3211
3212              Enable Reverse Wraparound (reversewrap)
3213                     Enable (or disable) reverse wraparound.  This corresponds
3214                     to the -rw option and the reverseWrap resource.
3215
3216              Enable Auto Linefeed (autolinefeed)
3217                     Enable (or disable) auto-linefeed.  This is the VT102 NEL
3218                     function, which causes the emulator to  emit  a  linefeed
3219                     after  each  carriage  return.  There is no corresponding
3220                     command-line option or resource setting.
3221
3222              Enable Application Cursor Keys (appcursor)
3223                     Enable (or disable) application cursor keys.  This corre‐
3224                     sponds  to  the  appcursorDefault  resource.  There is no
3225                     corresponding command-line option.
3226
3227              Enable Application Keypad (appkeypad)
3228                     Enable (or disable) application keypad keys.  This corre‐
3229                     sponds  to  the  appkeypadDefault  resource.  There is no
3230                     corresponding command-line option.
3231
3232              Scroll to Bottom on Key Press (scrollkey)
3233                     Enable (or  disable)  scrolling  to  the  bottom  of  the
3234                     scrolling  region on a keypress.  This corresponds to the
3235                     -sk option and the scrollKey resource.
3236
3237              Scroll to Bottom on Tty Output (scrollttyoutput)
3238                     Enable (or  disable)  scrolling  to  the  bottom  of  the
3239                     scrolling  region on output to the terminal.  This corre‐
3240                     sponds  to  the  -si  option  and   the   scrollTtyOutput
3241                     resource.
3242
3243              Allow 80/132 Column Switching (allow132)
3244                     Enable (or disable) switching between 80 and 132 columns.
3245                     This  corresponds  to  the  -132  option  and  the   c132
3246                     resource.
3247
3248              Keep Selection (keepSelection)
3249                     Tell  xterm whether to disown the selection when it stops
3250                     highlighting it, e.g., when an application  modifies  the
3251                     display  so  that it no longer matches the text which has
3252                     been highlighted.  As long as xterm continues to own  the
3253                     selection, it can provide the corresponding text to other
3254                     clients via cut/paste.  This corresponds to  the  keepSe‐
3255                     lection resource.  There is no corresponding command-line
3256                     option.
3257
3258              Select to Clipboard (selectToClipboard)
3259                     Tell xterm whether to use the PRIMARY  or  CLIPBOARD  for
3260                     SELECT  tokens  in  the  translations resource which maps
3261                     keyboard and mouse actions to select/paste actions.  This
3262                     corresponds  to the selectToClipboard resource.  There is
3263                     no corresponding command-line option.
3264
3265              Enable Visual Bell (visualbell)
3266                     Enable (or disable) visible bell (i.e., flashing) instead
3267                     of  an  audible bell.  This corresponds to the -vb option
3268                     and the visualBell resource.
3269
3270              Enable Bell Urgency (bellIsUrgent)
3271                     Enable (or disable) Urgency window manager hint when Con‐
3272                     trol-G is received.  This corresponds to the bellIsUrgent
3273                     resource.
3274
3275              Enable Pop on Bell (poponbell)
3276                     Enable (or disable) raising of the window when  Control-G
3277                     is received.  This corresponds to the -pop option and the
3278                     popOnBell resource.
3279
3280              Enable Blinking Cursor (cursorblink)
3281                     Enable (or disable) the  blinking-cursor  feature.   This
3282                     corresponds   to  the  -bc  option  and  the  cursorBlink
3283                     resource.  There is also an escape sequence (see the doc‐
3284                     ument  Xterm  Control Sequences).  The menu entry and the
3285                     escape sequence states are XOR'd: if  both  are  enabled,
3286                     the  cursor  will  not blink, if only one is enabled, the
3287                     cursor will blink.
3288
3289              Enable Alternate Screen Switching (titeInhibit)
3290                     Enable (or disable)  switching  between  the  normal  and
3291                     alternate  screens.   This corresponds to the titeInhibit
3292                     resource.  There is no corresponding command-line option.
3293
3294              Enable Active Icon (activeicon)
3295                     Enable (or disable) the active-icon feature.  This corre‐
3296                     sponds to the -ai option and the activeIcon resource.
3297
3298       VT102/VT220 Commands:
3299
3300              Do Soft Reset (softreset)
3301                     Reset  scroll  regions.  This can be convenient when some
3302                     program has  left  the  scroll  regions  set  incorrectly
3303                     (often a problem when using VMS or TOPS-20).  This corre‐
3304                     sponds to the VT220 DECSTR control sequence.
3305
3306              Do Full Reset (hardreset)
3307                     The full reset entry will clear the screen, reset tabs to
3308                     every  eight  columns, and reset the terminal modes (such
3309                     as wrap and smooth scroll) to their initial  states  just
3310                     after  xterm  has  finished  processing  the command line
3311                     options.  This  corresponds  to  the  VT102  RIS  control
3312                     sequence,  with  a few obvious differences.  For example,
3313                     your session is not disconnected as a  real  VT102  would
3314                     do.
3315
3316              Reset and Clear Saved Lines (clearsavedlines)
3317                     Perform a full reset, and also clear the saved lines.
3318
3319       Commands for setting the current screen:
3320
3321              Show Tek Window (tekshow)
3322                     When enabled, pops the Tektronix 4014 window up (makes it
3323                     visible).  When disabled, hides the Tektronix  4014  win‐
3324                     dow.
3325
3326              Switch to Tek Mode (tekmode)
3327                     When  enabled, pops the Tektronix 4014 window up if it is
3328                     not already visible, and switches  the  input  stream  to
3329                     that  window.   When  disabled,  hides the Tektronix 4014
3330                     window and switches input back to the VTxxx window.
3331
3332              Hide VT Window (vthide)
3333                     When enabled, hides the VTxxx window, shows the Tektronix
3334                     4014  window  if  it was not already visible and switches
3335                     the input stream to that window.   When  disabled,  shows
3336                     the  VTxxx  window, and switches the input stream to that
3337                     window.
3338
3339              Show Alternate Screen (altscreen)
3340                     When enabled, shows the alternate screen.  When disabled,
3341                     shows the normal screen.  Note that the normal screen may
3342                     have saved lines; the alternate screen does not.
3343
3344   VT Fonts
3345       The fontMenu pops up when when the “control”  key  and  pointer  button
3346       three are pressed in a window.  It sets the font used in the VT102 win‐
3347       dow, or modifies the way the font is specified or displayed.  There are
3348       several sections.
3349
3350       The  first section allows you to select the font from a set of alterna‐
3351       tives:
3352
3353              Default (fontdefault)
3354                     Set the font to the default,  i.e.,  that  given  by  the
3355                     *VT100.font resource.
3356
3357              Unreadable (font1)
3358                     Set the font to that given by the *VT100.font1 resource.
3359
3360              Tiny (font2)
3361                     Set the font to that given by the *VT100.font2 resource.
3362
3363              Small (font3)
3364                     Set the font to that given by the *VT100.font3 resource.
3365
3366              Medium (font4)
3367                     Set the font to that given by the *VT100.font4 resource.
3368
3369              Large (font5)
3370                     Set the font to that given by the *VT100.font5 resource.
3371
3372              Huge (font6)
3373                     Set the font to that given by the *VT100.font6 resource.
3374
3375              Escape Sequence
3376                     This allows you to set the font last specified by the Set
3377                     Font escape sequence  (see  the  document  Xterm  Control
3378                     Sequences).
3379
3380              Selection (fontsel)
3381                     This  allows  you  to  set the font specified the current
3382                     selection as a font name (if  the  PRIMARY  selection  is
3383                     owned).
3384
3385       The second section allows you to modify the way it is displayed:
3386
3387              Line-Drawing Characters (font-linedrawing)
3388                     When  set, tells xterm to draw its own line-drawing char‐
3389                     acters.  Otherwise  it  relies  on  the  font  containing
3390                     these.  Compare to the forceBoxChars resource.
3391
3392              Packed Font (font-packed)
3393                     When set, tells xterm to use the minimum glyph-width from
3394                     a font when displaying characters.  Use the maximum width
3395                     (unchecked)  to help display proportional fonts.  Compare
3396                     to the forcePackedFont resource.
3397
3398              Doublesized Characters (font-doublesize)
3399                     When set, xterm may ask the font server to produce scaled
3400                     versions  of the normal font, for VT102 double-size char‐
3401                     acters.
3402
3403       The third section allows you to modify the way it is specified:
3404
3405              TrueType Fonts (render-font)
3406                     If the renderFont and corresponding resources  were  set,
3407                     this is a further control whether xterm will actually use
3408                     the Xft library calls to obtain a font.
3409
3410              UTF-8 (utf8-mode)
3411                     This  controls  whether  xterm  uses  UTF-8  encoding  of
3412                     input/output.   It  is  useful  for temporarily switching
3413                     xterm to display text from an application which does  not
3414                     follow the locale settings.
3415
3416       The  fourth  section allows you to enable or disable special operations
3417       which can be controlled by writing escape sequences  to  the  terminal.
3418       These are disabled if the SendEvents feature is enabled:
3419
3420              Allow Font Ops (allow-font-ops)
3421                     This corresponds to the allowFontOps resource.  Enable or
3422                     disable control sequences that set/query the font.
3423
3424              Allow Tcap Ops (allow-tcap-ops)
3425                     Enable or disable control sequences that query the termi‐
3426                     nal's  notion  of its function-key strings, as termcap or
3427                     terminfo capabilities.  This corresponds to  the  allowT‐
3428                     capOps resource.
3429
3430              Allow Title Ops (allow-title-ops)
3431                     Enable  or disable control sequences that modify the win‐
3432                     dow title or icon name.  This corresponds to the allowTi‐
3433                     tleOps resource.
3434
3435              Allow Window Ops (allow-window-ops)
3436                     Enable  or  disable extended window control sequences (as
3437                     used in dtterm).  This corresponds to the  allowWindowOps
3438                     resource.
3439
3440   TEK Options
3441       The  tekMenu  sets  various  modes  in  the Tektronix emulation, and is
3442       popped up when the “control” key and pointer button two are pressed  in
3443       the  Tektronix  window.   The current font size is checked in the modes
3444       section of the menu.
3445
3446              Large Characters (tektextlarge)
3447
3448              #2 Size Characters (tektext2)
3449
3450              #3 Size Characters (tektext3)
3451
3452              Small Characters (tektextsmall)
3453
3454       Commands:
3455
3456              PAGE (tekpage)
3457                     Clear the Tektronix window.
3458
3459              RESET (tekreset)
3460
3461              COPY (tekcopy)
3462
3463       Windows:
3464
3465              Show VT Window (vtshow)
3466
3467              Switch to VT Mode (vtmode)
3468
3469              Hide Tek Window (tekhide)
3470

SECURITY

3472       X environments differ in their security consciousness.   Most  servers,
3473       run  under  xdm,  are  capable  of using a “magic cookie” authorization
3474       scheme that can provide a reasonable level of security for many people.
3475       If  your  server is only using a host-based mechanism to control access
3476       to the server (see xhost(1)), then if you enable access for a host  and
3477       other  users are also permitted to run clients on that same host, it is
3478       possible that someone can run an application which uses the basic  ser‐
3479       vices  of  the X protocol to snoop on your activities, potentially cap‐
3480       turing a transcript of  everything  you  type  at  the  keyboard.   Any
3481       process  which  has  access to your X display can manipulate it in ways
3482       that you might not anticipate, even redirecting your keyboard to itself
3483       and  sending  events  to your application's windows.  This is true even
3484       with the “magic cookie” authorization scheme.   While  the  allowSendE‐
3485       vents  provides  some  protection  against rogue applications tampering
3486       with your programs, guarding against a snooper is harder.
3487
3488       The possibility of an application spying on your keystrokes is of  par‐
3489       ticular  concern when you want to type in a password or other sensitive
3490       data.  The best solution to this problem is to use a better  authoriza‐
3491       tion  mechanism  than  is provided by X.  Given all of these caveats, a
3492       simple mechanism exists for protecting keyboard input in xterm.
3493
3494       The xterm menu (see MENUS  above)  contains  a  Secure  Keyboard  entry
3495       which,  when  enabled,  attempts  to  ensure that all keyboard input is
3496       directed only to xterm (using the GrabKeyboard protocol request).  When
3497       an  application  prompts  you for a password (or other sensitive data),
3498       you can enable Secure Keyboard using the menu, type in  the  data,  and
3499       then  disable  Secure Keyboard using the menu again.  This ensures that
3500       you know which window is accepting your keystrokes.  It  cannot  ensure
3501       that  there  are  no processes which have access to your X display that
3502       might be observing the keystrokes as well.
3503
3504       Only one X client at a time can grab the keyboard, so when you  attempt
3505       to  enable  Secure  Keyboard  it may fail.  In this case, the bell will
3506       sound.  If the Secure Keyboard succeeds, the foreground and  background
3507       colors will be exchanged (as if you selected the Reverse Video entry in
3508       the Modes menu); they will be exchanged  again  when  you  exit  secure
3509       mode.   If the colors do not switch, then you should be very suspicious
3510       that you are being spoofed.  If the application you  are  running  dis‐
3511       plays  a  prompt  before asking for the password, it is safest to enter
3512       secure mode before the prompt gets displayed, and to make sure that the
3513       prompt  gets  displayed  correctly (in the new colors), to minimize the
3514       probability of spoofing.  You can also bring up the menu again and make
3515       sure that a check mark appears next to the entry.
3516
3517       Secure  Keyboard mode will be disabled automatically if your xterm win‐
3518       dow becomes iconified (or otherwise unmapped), or if  you  start  up  a
3519       reparenting window manager (that places a title bar or other decoration
3520       around the window) while in Secure Keyboard mode.  (This is  a  feature
3521       of  the  X protocol not easily overcome.)  When this happens, the fore‐
3522       ground and background colors will be switched back and  the  bell  will
3523       sound in warning.
3524

CHARACTER CLASSES

3526       Clicking  the  left  pointer  button twice in rapid succession (double-
3527       clicking) causes all characters of the same class (e.g., letters, white
3528       space, punctuation) to be selected as a “word”.  Since different people
3529       have different preferences for what should be  selected  (for  example,
3530       should filenames be selected as a whole or only the separate subnames),
3531       the default mapping can be overridden through the use of the  charClass
3532       (class CharClass) resource.
3533
3534       This resource is a series of comma-separated of range:value pairs.  The
3535       range is either a single number or low-high in the range of 0 to 65535,
3536       corresponding  to  the  code for the character or characters to be set.
3537       The value is arbitrary, although the default table uses  the  character
3538       number  of the first character occurring in the set.  When not in UTF-8
3539       mode, only the first 256 bytes of this table will be used.
3540
3541       The default table starts as follows -
3542
3543           static int charClass[256] = {
3544           /∗ NUL  SOH  STX  ETX  EOT  ENQ  ACK  BEL */
3545               32,   1,   1,   1,   1,   1,   1,   1,
3546           /∗  BS   HT   NL   VT   NP   CR   SO   SI */
3547                1,  32,   1,   1,   1,   1,   1,   1,
3548           /∗ DLE  DC1  DC2  DC3  DC4  NAK  SYN  ETB */
3549                1,   1,   1,   1,   1,   1,   1,   1,
3550           /∗ CAN   EM  SUB  ESC   FS   GS   RS   US */
3551                1,   1,   1,   1,   1,   1,   1,   1,
3552           /∗  SP    !    "    #    $    %    &    ' */
3553               32,  33,  34,  35,  36,  37,  38,  39,
3554           /∗   (    )    *    +    ,    -    .    / */
3555               40,  41,  42,  43,  44,  45,  46,  47,
3556           /∗   0    1    2    3    4    5    6    7 */
3557               48,  48,  48,  48,  48,  48,  48,  48,
3558           /∗   8    9    :    ;    <    =    >    ? */
3559               48,  48,  58,  59,  60,  61,  62,  63,
3560           /∗   @    A    B    C    D    E    F    G */
3561               64,  48,  48,  48,  48,  48,  48,  48,
3562           /∗   H    I    J    K    L    M    N    O */
3563               48,  48,  48,  48,  48,  48,  48,  48,
3564           /∗   P    Q    R    S    T    U    V    W */
3565               48,  48,  48,  48,  48,  48,  48,  48,
3566           /∗   X    Y    Z    [    \    ]    ^    _ */
3567               48,  48,  48,  91,  92,  93,  94,  48,
3568           /∗   `    a    b    c    d    e    f    g */
3569               96,  48,  48,  48,  48,  48,  48,  48,
3570           /∗   h    i    j    k    l    m    n    o */
3571               48,  48,  48,  48,  48,  48,  48,  48,
3572           /∗   p    q    r    s    t    u    v    w */
3573               48,  48,  48,  48,  48,  48,  48,  48,
3574           /∗   x    y    z    {    |    }    ~  DEL */
3575               48,  48,  48, 123, 124, 125, 126,   1,
3576           /∗ x80  x81  x82  x83  IND  NEL  SSA  ESA */
3577                1,   1,   1,   1,   1,   1,   1,   1,
3578           /∗ HTS  HTJ  VTS  PLD  PLU   RI  SS2  SS3 */
3579                1,   1,   1,   1,   1,   1,   1,   1,
3580           /∗ DCS  PU1  PU2  STS  CCH   MW  SPA  EPA */
3581                1,   1,   1,   1,   1,   1,   1,   1,
3582           /∗ x98  x99  x9A  CSI   ST  OSC   PM  APC */
3583                1,   1,   1,   1,   1,   1,   1,   1,
3584           /∗   -    i   c/    L   ox   Y-    |   So */
3585              160, 161, 162, 163, 164, 165, 166, 167,
3586           /∗  ..   c0   ip   <<    _        R0    - */
3587              168, 169, 170, 171, 172, 173, 174, 175,
3588           /∗   o   +-    2    3    '    u   q|    . */
3589              176, 177, 178, 179, 180, 181, 182, 183,
3590           /∗   ,    1    2   >>  1/4  1/2  3/4    ? */
3591              184, 185, 186, 187, 188, 189, 190, 191,
3592           /∗  A`   A'   A^   A~   A:   Ao   AE   C, */
3593               48,  48,  48,  48,  48,  48,  48,  48,
3594           /∗  E`   E'   E^   E:   I`   I'   I^   I: */
3595               48,  48,  48,  48,  48,  48,  48,  48,
3596           /∗  D-   N~   O`   O'   O^   O~   O:    X */
3597               48,  48,  48,  48,  48,  48,  48, 215,
3598           /∗  O/   U`   U'   U^   U:   Y'    P    B */
3599               48,  48,  48,  48,  48,  48,  48,  48,
3600           /∗  a`   a'   a^   a~   a:   ao   ae   c, */
3601               48,  48,  48,  48,  48,  48,  48,  48,
3602           /∗  e`   e'   e^   e:    i`  i'   i^   i: */
3603               48,  48,  48,  48,  48,  48,  48,  48,
3604           /∗   d   n~   o`   o'   o^   o~   o:   -: */
3605               48,  48,  48,  48,  48,  48,  48, 247,
3606           /∗  o/   u`   u'   u^   u:   y'    P   y: */
3607               48,  48,  48,  48,  48,  48,  48,  48};
3608
3609       For example, the string “33:48,37:48,45-47:48,38:48” indicates that the
3610       exclamation  mark,  percent  sign,  dash,  period, slash, and ampersand
3611       characters should be treated the same way as  characters  and  numbers.
3612       This is useful for cutting and pasting electronic mailing addresses and
3613       filenames.
3614

ACTIONS

3616       It is possible to rebind keys  (or  sequences  of  keys)  to  arbitrary
3617       strings for input, by changing the translations resources for the vt100
3618       or tek4014 widgets.  Changing  the  translations  resource  for  events
3619       other than key and button events is not expected, and will cause unpre‐
3620       dictable behavior.  The following actions are provided for  use  within
3621       the vt100 or tek4014 translations resources:
3622
3623       allow-font-ops(on/off/toggle)
3624               This  action  set  or  toggles the allowFontOps resource and is
3625               also invoked by the allow-font-ops entry in fontMenu.
3626
3627       allow-send-events(on/off/toggle)
3628               This action set or toggles the allowSendEvents resource and  is
3629               also invoked by the allowsends entry in mainMenu.
3630
3631       allow-tcap-ops(on/off/toggle)
3632               This  action  set  or  toggles the allowTcapOps resource and is
3633               also invoked by the allow-tcap-ops entry in fontMenu.
3634
3635       allow-title-ops(on/off/toggle)
3636               This action set or toggles the allowTitleOps  resource  and  is
3637               also invoked by the allow-title-ops entry in fontMenu.
3638
3639       allow-window-ops(on/off/toggle)
3640               This  action  set or toggles the allowWindowOps resource and is
3641               also invoked by the allow-window-ops entry in fontMenu.
3642
3643       alt-sends-escape()
3644               This action toggles the state of the eightBitInput resource.
3645
3646       bell([percent])
3647               This action rings the keyboard bell at the specified percentage
3648               above or below the base volume.
3649
3650       clear-saved-lines()
3651               This  action  does hard-reset() (see below) and also clears the
3652               history of lines saved off the top of the screen.  It  is  also
3653               invoked  from  the clearsavedlines entry in vtMenu.  The effect
3654               is identical to a hardware reset (RIS) control sequence.
3655
3656       create-menu(m/v/f/t)
3657               This action creates one of the menus used by xterm, if  it  has
3658               not been previously created.  The parameter values are the menu
3659               names: mainMenu, vtMenu, fontMenu, tekMenu, respectively.
3660
3661       dabbrev-expand()
3662               Expands the word before cursor by searching  in  the  preceding
3663               text  on  the  screen  and  in  the scrollback buffer for words
3664               starting with that  abbreviation.   Repeating  dabbrev-expand()
3665               several times in sequence searches for an alternative expansion
3666               by looking farther back.  Lack of more matches is signaled by a
3667               beep().  Attempts to expand an empty word (i.e., when cursor is
3668               preceded by a space) yield  successively  all  previous  words.
3669               Consecutive identical expansions are ignored.  The word here is
3670               defined as a sequence of non-whitespace characters.  This  fea‐
3671               ture  partially emulates the behavior of “dynamic abbreviation”
3672               expansion in Emacs (bound there to M-/).  Here  is  a  resource
3673               setting for xterm which will do the same thing:
3674
3675                   *VT100*translations:    #override \n\
3676                           Meta <KeyPress> /:dabbrev-expand()
3677
3678
3679       deiconify()
3680               Changes the window state back to normal, if it was iconified.
3681
3682       delete-is-del()
3683               This action toggles the state of the deleteIsDEL resource.
3684
3685       dired-button()
3686               Handles  a button event (other than press and release) by echo‐
3687               ing the event's position (i.e., character line and  column)  in
3688               the following format:
3689
3690                       ^X ESC G <line+“ ”> <col+“ ”>
3691
3692       iconify()
3693               Iconifies the window.
3694
3695       hard-reset()
3696               This action resets the scrolling region, tabs, window size, and
3697               cursor keys and clears the screen.  It is also invoked from the
3698               hardreset entry in vtMenu.
3699
3700       ignore()
3701               This  action  ignores  the event but checks for special pointer
3702               position escape sequences.
3703
3704       insert()
3705               This action inserts the character or string associated with the
3706               key that was pressed.
3707
3708       insert-eight-bit()
3709               This  action inserts an eight-bit (Meta) version of the charac‐
3710               ter or string associated with the key that was  pressed.   This
3711               only  applies  to single-byte values.  The exact action depends
3712               on the value  of  the  metaSendsEscape  and  the  eightBitInput
3713               resources.  The metaSendsEscape resource is tested first.
3714
3715               The  term  "eight-bit" is misleading: xterm checks if the key's
3716               value is less than 128.  If so, xterm adds 128  to  the  value,
3717               setting  its  eighth  bit.   Otherwise  xterm sends an ESC byte
3718               before the key.  In other applications' documentation, that  is
3719               referred to as a "meta key".
3720
3721       insert-selection(sourcename [, ...])
3722               This  action  inserts the string found in the selection or cut‐
3723               buffer indicated by sourcename.  Sources  are  checked  in  the
3724               order  given  (case  is  significant) until one is found.  Com‐
3725               monly-used selections include: PRIMARY,  SECONDARY,  and  CLIP‐
3726               BOARD.   Cut  buffers  are  typically named CUT_BUFFER0 through
3727               CUT_BUFFER7.
3728
3729       insert-seven-bit()
3730               This action is a synonym for insert() The term  "seven-bit"  is
3731               misleading:  it only implies that xterm does not try to add 128
3732               to the key's value as in insert-eight-bit().
3733
3734       interpret(control-sequence)
3735               Interpret the given control  sequence  locally,  i.e.,  without
3736               passing  it  to  the host.  This works by inserting the control
3737               sequence at the front of the input buffer.  Use "\"  to  escape
3738               octal  digits  in  the  string.  Xt does not allow you to put a
3739               null character (i.e., "\000") in the string.
3740
3741       keymap(name)
3742               This action dynamically defines a new translation  table  whose
3743               resource  name is name with the suffix Keymap (case is signifi‐
3744               cant).  The name None restores the original translation table.
3745
3746       larger-vt-font()
3747               Set the font to the next larger one, based on the  font  dimen‐
3748               sions.  See also set-vt-font().
3749
3750       load-vt-fonts(name[,class])
3751               Load fontnames from the given subresource name and class.  That
3752               is, load the "*VT100.name.font", resource as "*VT100.font" etc.
3753               If no name is given, the original set of fontnames is restored.
3754
3755               Unlike  set-vt-font(),  this  does  not  affect the escape- and
3756               select-fonts, since those are not based on resource values.  It
3757               does  affect  the  fonts  loosely organized under the “Default”
3758               menu entry: font, boldFont, wideFont and wideBoldFont.
3759
3760       maximize()
3761               Resizes the window to fill the screen.
3762
3763       meta-sends-escape()
3764               This action toggles the state of the metaSendsEscape resource.
3765
3766       popup-menu(menuname)
3767               This action displays the specified  popup  menu.   Valid  names
3768               (case is significant) include:  mainMenu, vtMenu, fontMenu, and
3769               tekMenu.
3770
3771       print(printer-flags)
3772               This action prints the window and is also invoked by the  print
3773               entry in mainMenu.
3774
3775               The action accepts optional parameters, which temporarily over‐
3776               ride resource  settings.   The  parameter  values  are  matched
3777               ignoring case:
3778
3779               noFormFeed
3780                    no  form  feed  will  be  sent at the end of the last line
3781                    printed (i.e., printerFormFeed is ``false'').
3782
3783               FormFeed
3784                    a form feed will be sent at  the  end  of  the  last  line
3785                    printed (i.e., printerFormFeed is ``true'').
3786
3787               noNewLine
3788                    no  newline  will  be  sent  at  the  end of the last line
3789                    printed, and wrapped lines  will  be  combined  into  long
3790                    lines (i.e., printerNewLine is ``false'').
3791
3792               NewLine
3793                    a  newline  will  be  sent  at  the  end  of the last line
3794                    printed, and each line will be limited (by adding  a  new‐
3795                    line)   to  the  screen  width  (i.e.,  printerNewLine  is
3796                    ``true'').
3797
3798               noAttrs
3799                    the page is printed  without  attributes  (i.e.,  printAt‐
3800                    tributes is ``0'').
3801
3802               monoAttrs
3803                    the  page  is  printed  with monochrome (vt220) attributes
3804                    (i.e., printAttributes is ``1'').
3805
3806               colorAttrs
3807                    the page is printed  with  ANSI  color  attributes  (i.e.,
3808                    printAttributes is ``2'').
3809
3810       print-everything(printer-flags)
3811               This  action  sends the entire text history, in addition to the
3812               text currently visible, to the program given in the printerCom‐
3813               mand  resource.   It allows the same optional parameters as the
3814               print action.  With a suitable printer command, the action  can
3815               be used to load the text history in an editor.
3816
3817       print-redir()
3818               This  action  toggles  the  printerControlMode between 0 and 2.
3819               The corresponding popup menu entry is useful for switching  the
3820               printer off if you happen to change your mind after deciding to
3821               print random binary files on the terminal.
3822
3823       quit()  This action sends a SIGHUP to the subprogram and exits.  It  is
3824               also invoked by the quit entry in mainMenu.
3825
3826       redraw()
3827               This  action  redraws  the  window  and  is also invoked by the
3828               redraw entry in mainMenu.
3829
3830       restore()
3831               Restores the window to the size before it was last maximized.
3832
3833       scroll-back(count [,units [,mouse] ])
3834               This action scrolls the text window backward so that text  that
3835               had  previously scrolled off the top of the screen is now visi‐
3836               ble.
3837
3838               The count argument indicates the number of units (which may  be
3839               page, halfpage, pixel, or line) by which to scroll.
3840
3841               An  adjustment can be specified for these values by appending a
3842               "+" or "-" sign followed by a number, e.g., page-2 to specify 2
3843               lines less than a page.
3844
3845               If  the  third  parameter mouse is given, the action is ignored
3846               when mouse reporting is enabled.
3847
3848       scroll-forw(count [,units [,mouse] ])
3849               This action is similar to scroll-back except that it scrolls in
3850               the other direction.
3851
3852       secure()
3853               This  action  toggles the Secure Keyboard mode described in the
3854               section named SECURITY, and is invoked from the securekbd entry
3855               in mainMenu.
3856
3857       select-cursor-end(destname [, ...])
3858               This  action  is similar to select-end except that it should be
3859               used with select-cursor-start.
3860
3861       select-cursor-extend()
3862               This action is similar to select-extend except that  it  should
3863               be used with select-cursor-start.
3864
3865       select-cursor-start()
3866               This  action  is  similar to select-start except that it begins
3867               the selection at the current text cursor position.
3868
3869       select-end(destname [, ...])
3870               This action puts the currently selected text into  all  of  the
3871               selections or cutbuffers specified by destname.
3872
3873       select-extend()
3874               This  action  tracks the pointer and extends the selection.  It
3875               should only be bound to Motion events.
3876
3877       select-set()
3878               This action stores text that corresponds to the current  selec‐
3879               tion, without affecting the selection mode.
3880
3881       select-start()
3882               This  action begins text selection at the current pointer loca‐
3883               tion.  See the section on POINTER USAGE for information on mak‐
3884               ing selections.
3885
3886       send-signal(signame)
3887               This action sends the signal named by signame to the xterm sub‐
3888               process (the shell or program specified  with  the  -e  command
3889               line  option)  and  is  also  invoked by the suspend, continue,
3890               interrupt, hangup, terminate, and  kill  entries  in  mainMenu.
3891               Allowable  signal names are (case is not significant): tstp (if
3892               supported by the operating system),  suspend  (same  as  tstp),
3893               cont  (if  supported  by the operating system), int, hup, term,
3894               quit, alrm, alarm (same as alrm) and kill.
3895
3896       set-allow132(on/off/toggle)
3897               This action toggles the c132 resource and is also invoked  from
3898               the allow132 entry in vtMenu.
3899
3900       set-altscreen(on/off/toggle)
3901               This action toggles between the alternate and current screens.
3902
3903       set-appcursor(on/off/toggle)
3904               This  action  toggles  the handling Application Cursor Key mode
3905               and is also invoked by the appcursor entry in vtMenu.
3906
3907       set-appkeypad(on/off/toggle)
3908               This action toggles the handling of Application Keypad mode and
3909               is also invoked by the appkeypad entry in vtMenu.
3910
3911       set-autolinefeed(on/off/toggle)
3912               This  action  toggles  automatic  insertion of linefeeds and is
3913               also invoked by the autolinefeed entry in vtMenu.
3914
3915       set-autowrap(on/off/toggle)
3916               This action toggles automatic wrapping of  long  lines  and  is
3917               also invoked by the autowrap entry in vtMenu.
3918
3919       set-backarrow(on/off/toggle)
3920               This  action  toggles  the  backarrowKey  resource  and is also
3921               invoked from the backarrow key entry in vtMenu.
3922
3923       set-bellIsUrgent(on/off/toggle)
3924               This action toggles  the  bellIsUrgent  resource  and  is  also
3925               invoked by the bellIsUrgent entry in vtMenu.
3926
3927       set-cursorblink(on/off/toggle)
3928               This  action  toggles  the  cursorBlink  resource  and  is also
3929               invoked from the cursorblink entry in vtMenu.
3930
3931       set-cursesemul(on/off/toggle)
3932               This action toggles the curses resource  and  is  also  invoked
3933               from the cursesemul entry in vtMenu.
3934
3935       set-font-doublesize(on/off/toggle)
3936               This  action  toggles  the  fontDoublesize resource and is also
3937               invoked by the font-doublesize entry in fontMenu.
3938
3939       set-hp-function-keys(on/off/toggle)
3940               This action toggles the hpFunctionKeys  resource  and  is  also
3941               invoked by the hpFunctionKeys entry in mainMenu.
3942
3943       set-jumpscroll(on/off/toggle)
3944               This action toggles the jumpscroll resource and is also invoked
3945               by the jumpscroll entry in vtMenu.
3946
3947       set-font-linedrawing(on/off/toggle)
3948               This action toggles the xterm's  state  regarding  whether  the
3949               current  font has line-drawing characters and whether it should
3950               draw them directly.  It is also invoked by the font-linedrawing
3951               entry in fontMenu.
3952
3953       set-font-packed(on/off/toggle)
3954               This  action  toggles the forcePackedFont's resource which con‐
3955               trols to use the font's minimum or maximum glyph width.  It  is
3956               also invoked by the font-packed entry in fontMenu.
3957
3958       set-keep-selection(on/off/toggle)
3959               This  action  toggles  the  keepSelection  resource and is also
3960               invoked by the keepSelection entry in vtMenu.
3961
3962       set-logging()
3963               This action toggles the state of the logging option.
3964
3965       set-old-function-keys(on/off/toggle)
3966               This action toggles the state of legacy function  keys  and  is
3967               also invoked by the oldFunctionKeys entry in mainMenu.
3968
3969       set-marginbell(on/off/toggle)
3970               This action toggles the marginBell resource.
3971
3972       set-num-lock()
3973               This action toggles the state of the numLock resource.
3974
3975       set-pop-on-bell(on/off/toggle)
3976               This  action toggles the popOnBell resource and is also invoked
3977               by the poponbell entry in vtMenu.
3978
3979       set-render-font(on/off/toggle)
3980               This action toggles the renderFont resource and is also invoked
3981               by the render-font entry in fontMenu.
3982
3983       set-reverse-video(on/off/toggle)
3984               This  action  toggles  the  reverseVideo  resource  and is also
3985               invoked by the reversevideo entry in vtMenu.
3986
3987       set-reversewrap(on/off/toggle)
3988               This action  toggles  the  reverseWrap  resource  and  is  also
3989               invoked by the reversewrap entry in vtMenu.
3990
3991       set-scroll-on-key(on/off/toggle)
3992               This  action toggles the scrollKey resource and is also invoked
3993               from the scrollkey entry in vtMenu.
3994
3995       set-scroll-on-tty-output(on/off/toggle)
3996               This action toggles the scrollTtyOutput resource  and  is  also
3997               invoked from the scrollttyoutput entry in vtMenu.
3998
3999       set-scrollbar(on/off/toggle)
4000               This  action toggles the scrollbar resource and is also invoked
4001               by the scrollbar entry in vtMenu.
4002
4003       set-select(on/off/toggle)
4004               This action toggles the selectToClipboard resource and is  also
4005               invoked by the selectToClipboard entry in vtMenu.
4006
4007       set-sco-function-keys(on/off/toggle)
4008               This  action  toggles  the scoFunctionKeys resource and is also
4009               invoked by the scoFunctionKeys entry in mainMenu.
4010
4011       set-sun-function-keys(on/off/toggle)
4012               This action toggles the sunFunctionKeys resource  and  is  also
4013               invoked by the sunFunctionKeys entry in mainMenu.
4014
4015       set-sun-keyboard(on/off/toggle)
4016               This  action  toggles  the  sunKeyboard  resource  and  is also
4017               invoked by the sunKeyboard entry in mainMenu.
4018
4019       set-tek-text(large/2/3/small)
4020               This action sets font used in the Tektronix window to the value
4021               of  the  resources  tektextlarge,  tektext2, tektext3, and tek‐
4022               textsmall according to the argument.  It is also invoked by the
4023               entries of the same names as the resources in tekMenu.
4024
4025       set-terminal-type(type)
4026               This  action  directs  output  to either the vt or tek windows,
4027               according to the type string.  It is also invoked by  the  tek‐
4028               mode entry in vtMenu and the vtmode entry in tekMenu.
4029
4030       set-titeInhibit(on/off/toggle)
4031               This  action  toggles  the titeInhibit resource, which controls
4032               switching between the alternate and current screens.
4033
4034       set-toolbar(on/off/toggle)
4035               This action toggles the toolbar feature and is also invoked  by
4036               the toolbar entry in mainMenu.
4037
4038       set-utf8-mode(on/off/toggle)
4039               This  action  toggles  the utf8 resource and is also invoked by
4040               the utf8-mode entry in fontMenu.
4041
4042       set-utf8-title(on/off/toggle)
4043               This action toggles the utf8Title resource and is also  invoked
4044               by the utf8-title entry in fontMenu.
4045
4046       set-visibility(vt/tek,on/off/toggle)
4047               This  action  controls whether or not the vt or tek windows are
4048               visible.  It is  also  invoked  from  the  tekshow  and  vthide
4049               entries  in  vtMenu  and the vtshow and tekhide entries in tek‐
4050               Menu.
4051
4052       set-visual-bell(on/off/toggle)
4053               This action toggles the visualBell resource and is also invoked
4054               by the visualbell entry in vtMenu.
4055
4056       set-vt-font(d/1/2/3/4/5/6/e/s [,normalfont [, boldfont]])
4057               This  action sets the font or fonts currently being used in the
4058               VT102 window.  The first argument is a  single  character  that
4059               specifies the font to be used:
4060
4061               d  or D indicate the default font (the font initially used when
4062                      xterm was started),
4063
4064               1 through 6 indicate the fonts specified by the  font1  through
4065                      font6 resources,
4066
4067               e  or  E  indicate the normal and bold fonts that have been set
4068                      through escape codes (or specified  as  the  second  and
4069                      third action arguments, respectively), and
4070
4071               s or S indicate the font selection (as made by programs such as
4072                      xfontsel(1)) indicated by the second action argument.
4073
4074               If xterm is configured to support  wide  characters,  an  addi‐
4075               tional  two  optional parameters are recognized for the e argu‐
4076               ment: wide font and wide bold font.
4077
4078       smaller-vt-font()
4079               Set the font to the next smaller one, based on the font  dimen‐
4080               sions.  See also set-vt-font().
4081
4082       soft-reset()
4083               This  action  resets  the  scrolling region and is also invoked
4084               from the softreset entry in vtMenu.  The effect is identical to
4085               a soft reset (DECSTR) control sequence.
4086
4087       spawn-new-terminal(params)
4088               Spawn  a new xterm process.  This is available on systems which
4089               have a modern version of the process filesystem, e.g., "/proc",
4090               which xterm can read.
4091
4092               Use  the  "cwd"  process entry, e.g., /proc/12345/cwd to obtain
4093               the working directory of the process which is  running  in  the
4094               current xterm.
4095
4096               On   systems   which   have  the  "exe"  process  entry,  e.g.,
4097               /proc/12345/exe, use this  to  obtain  the  actual  executable.
4098               Otherwise, use the $PATH variable to find xterm.
4099
4100               If  parameters  are  given  in the action, pass them to the new
4101               xterm process.
4102
4103       start-extend()
4104               This action is similar to select-start except that  the  selec‐
4105               tion is extended to the current pointer location.
4106
4107       start-cursor-extend()
4108               This  action is similar to select-extend except that the selec‐
4109               tion is extended to the current text cursor position.
4110
4111       string(string)
4112               This action inserts the specified text string as if it had been
4113               typed.   Quotation  is  necessary if the string contains white‐
4114               space or non-alphanumeric characters.  If the  string  argument
4115               begins  with  the  characters  “0x”, it is interpreted as a hex
4116               character constant.
4117
4118       tek-copy()
4119               This action copies the escape codes used to generate  the  cur‐
4120               rent  window contents to a file in the current directory begin‐
4121               ning with the name COPY.  It is also invoked from  the  tekcopy
4122               entry in tekMenu.
4123
4124       tek-page()
4125               This  action clears the Tektronix window and is also invoked by
4126               the tekpage entry in tekMenu.
4127
4128       tek-reset()
4129               This action resets the Tektronix window and is also invoked  by
4130               the tekreset entry in tekMenu.
4131
4132       vi-button()
4133               Handles  a button event (other than press and release) by echo‐
4134               ing a control sequence computed from the event's line number in
4135               the screen relative to the current line:
4136
4137                       ESC ^P
4138               or
4139                       ESC ^N
4140
4141               according  to whether the event is before, or after the current
4142               line, respectively.  The ^N (or ^P) is repeated once  for  each
4143               line that the event differs from the current line.  The control
4144               sequence is omitted altogether if the button event  is  on  the
4145               current line.
4146
4147       visual-bell()
4148               This action flashes the window quickly.
4149
4150       The Tektronix window also has the following action:
4151
4152       gin-press(l/L/m/M/r/R)
4153               This action sends the indicated graphics input code.
4154
4155       The default bindings in the VT102 window use the SELECT token, which is
4156       set by the selectToClipboard resource:
4157
4158                     Shift <KeyPress> Prior:scroll-back(1,halfpage) \n\
4159                      Shift <KeyPress> Next:scroll-forw(1,halfpage) \n\
4160                    Shift <KeyPress> Select:select-cursor-start() \
4161                                            select-cursor-end(SELECT, CUT_BUFFER0) \n\
4162                    Shift <KeyPress> Insert:insert-selection(SELECT, CUT_BUFFER0) \n\
4163                       <KeyPress> XF86Paste:insert-selection(SELECT, CUT_BUFFER0) \n\
4164                        <KeyPress> SunPaste:insert-selection(SELECT, CUT_BUFFER0) \n\
4165               Shift~Ctrl <KeyPress> KP_Add:larger-vt-font() \n\
4166               Shift Ctrl <KeyPress> KP_Add:smaller-vt-font() \n\
4167               Shift <KeyPress> KP_Subtract:smaller-vt-font() \n\
4168                           ~Meta <KeyPress>:insert-seven-bit() \n\
4169                            Meta <KeyPress>:insert-eight-bit() \n\
4170                           !Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
4171                      !Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
4172            !Lock Ctrl @Num_Lock <Btn1Down>:popup-menu(mainMenu) \n\
4173                ! @Num_Lock Ctrl <Btn1Down>:popup-menu(mainMenu) \n\
4174                           ~Meta <Btn1Down>:select-start() \n\
4175                         ~Meta <Btn1Motion>:select-extend() \n\
4176                           !Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
4177                      !Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
4178            !Lock Ctrl @Num_Lock <Btn2Down>:popup-menu(vtMenu) \n\
4179                ! @Num_Lock Ctrl <Btn2Down>:popup-menu(vtMenu) \n\
4180                     ~Ctrl ~Meta <Btn2Down>:ignore() \n\
4181                            Meta <Btn2Down>:clear-saved-lines() \n\
4182                       ~Ctrl ~Meta <Btn2Up>:insert-selection(SELECT, CUT_BUFFER0) \n\
4183                           !Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
4184                      !Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
4185            !Lock Ctrl @Num_Lock <Btn3Down>:popup-menu(fontMenu) \n\
4186                ! @Num_Lock Ctrl <Btn3Down>:popup-menu(fontMenu) \n\
4187                     ~Ctrl ~Meta <Btn3Down>:start-extend() \n\
4188                         ~Meta <Btn3Motion>:select-extend() \n\
4189                            Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4190                       Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4191             Lock @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4192                  @Num_Lock Ctrl <Btn4Down>:scroll-back(1,halfpage,m) \n\
4193                                 <Btn4Down>:scroll-back(5,line,m)     \n\
4194                            Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4195                       Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4196             Lock @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4197                  @Num_Lock Ctrl <Btn5Down>:scroll-forw(1,halfpage,m) \n\
4198                                 <Btn5Down>:scroll-forw(5,line,m)     \n\
4199                                    <BtnUp>:select-end(SELECT, CUT_BUFFER0) \n\
4200                                  <BtnDown>:ignore()
4201
4202
4203       The default bindings for the scrollbar widget  are  separate  from  the
4204       VT100 widget:
4205
4206                                 <Btn5Down>: StartScroll(Forward) \n\
4207                                 <Btn1Down>: StartScroll(Forward) \n\
4208                                 <Btn2Down>: StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
4209                                 <Btn3Down>: StartScroll(Backward) \n\
4210                                 <Btn4Down>: StartScroll(Backward) \n\
4211                                 <Btn2Motion>: MoveThumb() NotifyThumb() \n\
4212                                 <BtnUp>:    NotifyScroll(Proportional) EndScroll()
4213
4214
4215       The default bindings in the Tektronix window are:
4216
4217                            ~Meta<KeyPress>: insert-seven-bit() \n\
4218                             Meta<KeyPress>: insert-eight-bit() \n\
4219                           !Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
4220                      !Lock Ctrl <Btn1Down>: popup-menu(mainMenu) \n\
4221            !Lock Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
4222                 !Ctrl @Num_Lock <Btn1Down>: popup-menu(mainMenu) \n\
4223                           !Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
4224                      !Lock Ctrl <Btn2Down>: popup-menu(tekMenu) \n\
4225            !Lock Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
4226                 !Ctrl @Num_Lock <Btn2Down>: popup-menu(tekMenu) \n\
4227                      Shift ~Meta<Btn1Down>: gin-press(L) \n\
4228                            ~Meta<Btn1Down>: gin-press(l) \n\
4229                      Shift ~Meta<Btn2Down>: gin-press(M) \n\
4230                            ~Meta<Btn2Down>: gin-press(m) \n\
4231                      Shift ~Meta<Btn3Down>: gin-press(R) \n\
4232                            ~Meta<Btn3Down>: gin-press(r)
4233
4234
4235       Here is an example which uses shifted select/paste to copy to the clip‐
4236       board, and unshifted select/paste for the primary selection.   In  each
4237       case,  a  (different)  cut  buffer  is  also  a target or source of the
4238       select/paste operation.  It is important to remember however, that  cut
4239       buffers  store  data in ISO-8859-1 encoding, while selections can store
4240       data in a variety of formats  and  encodings.   While  xterm  owns  the
4241       selection,  it  highlights it.  When it loses the selection, it removes
4242       the corresponding highlight.  But you can still paste from  the  corre‐
4243       sponding cut buffer.
4244
4245           *VT100*translations:    #override \n\
4246               ~Shift~Ctrl<Btn2Up>: insert-selection(PRIMARY, CUT_BUFFER0) \n\
4247               Shift~Ctrl<Btn2Up>:  insert-selection(CLIPBOARD, CUT_BUFFER1) \n\
4248               ~Shift<BtnUp>:       select-end(PRIMARY, CUT_BUFFER0) \n\
4249               Shift<BtnUp>:        select-end(CLIPBOARD, CUT_BUFFER1)
4250
4251
4252       Below  is  a  sample  how of the keymap() action is used to add special
4253       keys for entering commonly-typed works:
4254
4255           *VT100.Translations: #override <Key>F13: keymap(dbx)
4256           *VT100.dbxKeymap.translations: \
4257                <Key>F14: keymap(None) \n\
4258                <Key>F17: string("next") string(0x0d) \n\
4259                <Key>F18: string("step") string(0x0d) \n\
4260                <Key>F19: string("continue") string(0x0d) \n\
4261                <Key>F20: string("print ") insert-selection(PRIMARY, CUT_BUFFER0)
4262
4263
4264       Some people prefer using the  left  pointer  button  for  dragging  the
4265       scrollbar  thumb.   That  can  be  setup  by  altering the translations
4266       resource, e.g.,
4267
4268           *VT100.scrollbar.translations:#override \n\
4269                <Btn5Down>:StartScroll(Forward) \n\
4270                <Btn1Down>:StartScroll(Continuous) MoveThumb() NotifyThumb() \n\
4271                <Btn4Down>:StartScroll(Backward) \n\
4272                <Btn1Motion>:MoveThumb() NotifyThumb() \n\
4273                <BtnUp>:  NotifyScroll(Proportional) EndScroll()
4274
4275

CONTROL SEQUENCES AND KEYBOARD

4277       The Xterm Control Sequences document lists the control sequences  which
4278       an  application  can  send xterm to make it perform various operations.
4279       Most of these operations are standardized, from either the DEC or  Tek‐
4280       tronix terminals, or from more widely used standards such as ISO-6429.
4281

ENVIRONMENT

4283       Xterm sets several environment variables:
4284
4285       DISPLAY
4286            is  the  display name, pointing to the X server (see DISPLAY NAMES
4287            in X(7)).
4288
4289       TERM is set according to the termcap (or terminfo) entry  which  it  is
4290            using as a reference.
4291
4292       WINDOWID
4293            is set to the X window id number of the xterm window.
4294
4295       XTERM_LOCALE
4296            shows  the  locale which was used by xterm on startup.  Some shell
4297            initialization scripts may set a different locale.
4298
4299       XTERM_SHELL
4300            is set to the pathname of the program which is  invoked.   Usually
4301            that is a shell program, e.g., /bin/sh.  Since it is not necessar‐
4302            ily a shell program however, it is distinct from “SHELL”.
4303
4304       XTERM_VERSION
4305            is set to the string displayed by the -version  option.   That  is
4306            normally  an  identifier  for the X Window libraries used to build
4307            xterm, followed by xterm's patch number in parenthesis.  The patch
4308            number  is  also  part  of  the  response  to  a  Secondary Device
4309            Attributes (DA) control sequence (see Xterm Control Sequences).
4310
4311       Depending on your system configuration, xterm may also set the  follow‐
4312       ing:
4313
4314       COLUMNS
4315            the width of the xterm in characters (cf: "stty columns").
4316
4317       HOME when xterm is configured to update utmp.
4318
4319       LINES
4320            the height of the xterm in characters (cf: "stty rows").
4321
4322       LOGNAME
4323            when xterm is configured to update utmp.
4324
4325       SHELL
4326            when  xterm  is  configured to update utmp.  It is also set if you
4327            provide the shell name as the optional parameter.
4328
4329       TERMCAP
4330            the contents of the termcap entry  corresponding  to  $TERM,  with
4331            lines  and  columns  values substituted for the actual size window
4332            you have created.
4333
4334       TERMINFO
4335            may be defined to a nonstandard location in the configure script.
4336

FILES

4338       The actual pathnames given may differ on your system.
4339
4340       /var/run/utmp
4341            the system logfile, which records user logins.
4342
4343       /var/log/wtmp
4344            the system logfile, which records user logins and logouts.
4345
4346       /usr/share/X11/app-defaults/XTerm
4347            the xterm default application resources.
4348
4349       /usr/share/X11/app-defaults/XTerm-color
4350            the xterm color application resources.  If your  display  supports
4351            color, use this
4352                      *customization: -color
4353            in  your  .Xdefaults  file to automatically use this resource file
4354            rather than /usr/share/X11/app-defaults/XTerm.  If you do  not  do
4355            this,  xterm  uses  its  compiled-in default resource settings for
4356            colors.
4357

ERROR MESSAGES

4359       Most of the fatal error messages from xterm use the following format:
4360              xterm: Error XXX, errno YYY: ZZZ
4361       The XXX codes (which are used by xterm as  its  exit-code)  are  listed
4362       below, with a brief explanation.
4363
4364       1    is  used  for  miscellaneous errors, usually accompanied by a spe‐
4365            cific message,
4366
4367       11   ERROR_FIONBIO
4368            main: ioctl() failed on FIONBIO
4369
4370       12   ERROR_F_GETFL
4371            main: ioctl() failed on F_GETFL
4372
4373       13   ERROR_F_SETFL
4374            main: ioctl() failed on F_SETFL
4375
4376       14   ERROR_OPDEVTTY
4377            spawn: open() failed on /dev/tty
4378
4379       15   ERROR_TIOCGETP
4380            spawn: ioctl() failed on TIOCGETP
4381
4382       17   ERROR_PTSNAME
4383            spawn: ptsname() failed
4384
4385       18   ERROR_OPPTSNAME
4386            spawn: open() failed on ptsname
4387
4388       19   ERROR_PTEM
4389            spawn: ioctl() failed on I_PUSH/"ptem"
4390
4391       20   ERROR_CONSEM
4392            spawn: ioctl() failed on I_PUSH/"consem"
4393
4394       21   ERROR_LDTERM
4395            spawn: ioctl() failed on I_PUSH/"ldterm"
4396
4397       22   ERROR_TTCOMPAT
4398            spawn: ioctl() failed on I_PUSH/"ttcompat"
4399
4400       23   ERROR_TIOCSETP
4401            spawn: ioctl() failed on TIOCSETP
4402
4403       24   ERROR_TIOCSETC
4404            spawn: ioctl() failed on TIOCSETC
4405
4406       25   ERROR_TIOCSETD
4407            spawn: ioctl() failed on TIOCSETD
4408
4409       26   ERROR_TIOCSLTC
4410            spawn: ioctl() failed on TIOCSLTC
4411
4412       27   ERROR_TIOCLSET
4413            spawn: ioctl() failed on TIOCLSET
4414
4415       28   ERROR_INIGROUPS
4416            spawn: initgroups() failed
4417
4418       29   ERROR_FORK
4419            spawn: fork() failed
4420
4421       30   ERROR_EXEC
4422            spawn: exec() failed
4423
4424       32   ERROR_PTYS
4425            get_pty: not enough ptys
4426
4427       34   ERROR_PTY_EXEC
4428            waiting for initial map
4429
4430       35   ERROR_SETUID
4431            spawn: setuid() failed
4432
4433       36   ERROR_INIT
4434            spawn: can't initialize window
4435
4436       46   ERROR_TIOCKSET
4437            spawn: ioctl() failed on TIOCKSET
4438
4439       47   ERROR_TIOCKSETC
4440            spawn: ioctl() failed on TIOCKSETC
4441
4442       48   ERROR_SPREALLOC
4443            spawn: realloc of ttydev failed
4444
4445       49   ERROR_LUMALLOC
4446            luit: command-line malloc failed
4447
4448       50   ERROR_SELECT
4449            in_put: select() failed
4450
4451       54   ERROR_VINIT
4452            VTInit: can't initialize window
4453
4454       57   ERROR_KMMALLOC1
4455            HandleKeymapChange: malloc failed
4456
4457       60   ERROR_TSELECT
4458            Tinput: select() failed
4459
4460       64   ERROR_TINIT
4461            TekInit: can't initialize window
4462
4463       71   ERROR_BMALLOC2
4464            SaltTextAway: malloc() failed
4465
4466       80   ERROR_LOGEXEC
4467            StartLog: exec() failed
4468
4469       83   ERROR_XERROR
4470            xerror: XError event
4471
4472       84   ERROR_XIOERROR
4473            xioerror: X I/O error
4474
4475       90   ERROR_SCALLOC
4476            Alloc: calloc() failed on base
4477
4478       91   ERROR_SCALLOC2
4479            Alloc: calloc() failed on rows
4480
4481       102  ERROR_SAVE_PTR
4482            ScrnPointers: malloc/realloc() failed
4483
4484       121  ERROR_MMALLOC
4485            my_memmove: malloc/realloc failed
4486

BUGS

4488       Large pastes do not work on some systems.  This is not a bug in  xterm;
4489       it  is  a  bug  in  the pseudo terminal driver of those systems.  xterm
4490       feeds large pastes to the pty only as fast as the pty will accept data,
4491       but  some  pty  drivers do not return enough information to know if the
4492       write has succeeded.
4493
4494       Many of the options are not resettable after xterm starts.
4495
4496       This program still needs to be rewritten.  It should be split into very
4497       modular  sections, with the various emulators being completely separate
4498       widgets that do not know about each other.  Ideally, you'd like  to  be
4499       able  to  pick and choose emulator widgets and stick them into a single
4500       control widget.
4501
4502       There needs to be a dialog box to allow entry  of  the  Tek  COPY  file
4503       name.
4504

SEE ALSO

4506       resize(1), luit(1), X(7), pty(4), tty(4)
4507       Xterm Control Sequences (this is the file ctlseqs.ms).
4508
4509       http://invisible-island.net/xterm/xterm.html
4510       http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
4511

AUTHORS

4513       Far too many people, including:
4514
4515       Loretta Guarino Reid (DEC-UEG-WSL), Joel McCormack (DEC-UEG-WSL), Terry
4516       Weissman (DEC-UEG-WSL), Edward Moy (Berkeley),  Ralph  R.  Swick  (MIT-
4517       Athena),  Mark  Vandevoorde  (MIT-Athena),  Bob McNamara (DEC-MAD), Jim
4518       Gettys (MIT-Athena), Bob Scheifler (MIT X Consortium), Doug Mink (SAO),
4519       Steve  Pitschke  (Stellar),  Ron Newman (MIT-Athena), Jim Fulton (MIT X
4520       Consortium), Dave Serisky (HP),  Jonathan  Kamens  (MIT-Athena),  Jason
4521       Bacon,  Stephen P. Wall, David Wexelblat, and Thomas Dickey (invisible-
4522       island.net).
4523
4524
4525
4526                                X Window System                       XTERM(1)
Impressum