Wikia

How To Wiki

How to configure xterm/All configs

Talk0
1,789pages on
this wiki

< How to configure xterm

All Xterm confugurations

Resources

The program understands all of the core X Toolkit resource names and classes. Application specific resources (e.g., "XTerm.NAME") follow:

backarrowKeyIsErase (class BackarrowKeyIsErase)
Tie the VTxxx backarrowKey and ptyInitialErase resources together by setting the DECBKM state according to whether the initial value of stty erase is a backspace (8) or delete (127) character. The default is false, which disables this feature.

hold (class Hold)
If true, xterm will not immediately destroy its window when the shell command completes. It will wait until you use the window manager to destroy/kill the window, or if you use the menu entries that send a signal, e.g., HUP or KILL. You may scroll back, select text, etc., to perform most graphical operations. Resizing the display will lose data, however, since this involves interaction with the shell which is no longer running.
hpFunctionKeys (class HpFunctionKeys)
Specifies whether or not HP Function Key escape codes should be generated for function keys instead of standard escape sequences. See also the keyboardType resource.
iconGeometry (classIconGeometry)
Specifies the preferred size and position of the application when iconified. It is not necessarily obeyed by all window managers.

iconName (class IconName)
Specifies the icon name. The default is the application name.
keyboardType (class KeyboardType)
Enables one (or none) of the various keyboard-type resources: hpFunctionKeys, scoFunctionKeys, sunFunctionKeys and sunKeyboard. The resource's value should be one of the corresponding strings hp, sco, sun or vt220. The individual resources are provided for legacy support; this resource is simpler to use.

maxBufSize (class MaxBufSize)
Specify the maximum size of the input buffer. The default is 32768. You cannot set this to a value less than the minBufSize resource. It will be increased as needed to make that value evenly divide this one.
On some systems you may want to increase one or both of the
maxBufSize and minBufSize resource values to achieve better performance if the operating system prefers larger buffer sizes.
messages (class Messages)

Specifies whether write access to the terminal is allowed initially. See <a href="mesg">mesg</a>(1). The default is true.
minBufSize (class MinBufSize)
Specify the minimum size of the input buffer, i.e., the amount of data that xterm requests on each read. The default is 4096. You cannot set this to a value less than 64.
ptyHandshake (class PtyHandshake)
If true, xterm will perform handshaking during initialization to ensure that the parent and child processes update the utmp and

stty state. The default is true.

ptyInitialErase (class PtyInitialErase)
If true, xterm will use the pseudo-terminal's sense of the stty erase value. If false, xterm will set the stty erase value to match its own configuration, using the kb string from the termcap entry as a reference, if available. In either case, the result is applied to the TERMCAP variable which xterm sets. The default is false.

sameName (class SameName)
If the value of this resource is true, xterm does not send title and icon name change requests when the request would have no effect: the name is not changed. This has the advantage of preventing flicker and the disadvantage of requiring an extra round trip to the server to find out the previous value. In practice this should never be a problem. The default is true.
scoFunctionKeys (class ScoFunctionKeys)
Specifies whether or not SCP Function Key escape codes should be generated for function keys instead of standard escape sequences. See also the keyboardType resource.
sessionMgt (class SessionMgt)

If the value of this resource is true, xterm sets up session manager callbacks for XtNdieCallback and XtNsaveCallback. The default is true.
sunFunctionKeys (class SunFunctionKeys)
Specifies whether or not Sun Function Key escape codes should be generated for function keys instead of standard escape sequences. See also the keyboardType resource.
sunKeyboard (class SunKeyboard)

Specifies whether or not Sun/PC keyboard layout should be assumed rather than DEC VT220. This causes the keypad '+' to be mapped to ','. and CTRL F1-F12 to F11-F20, depending on the setting of the ctrlFKeys resource. so xterm emulates a DEC VT220 more accurately. Otherwise (the default, with sunKeyboard set to false), xterm uses PC-style bindings for the function keys and keypad.
PC-style bindings
use the Shift, Alt, Control and Meta keys as modifiers for function-keys and keypad (see the document Xterm Control Sequences for details). The PC-style bindings are analogous to PCTerm, but not the same thing. Normally these bindings do not conflict with the use of the Meta key as described for the

eightBitInput resource. If they do, note that the PC-style bindings are evaluated first. See also the keyboardType resource.

termName (class TermName)
Specifies the terminal type name to be set in the TERM environment variable.
title (class Title)
Specifies a string that may be used by the window manager when displaying this application.
toolBar (class ToolBar)

Specifies whether or not the toolbar should be displayed. The default is true.
ttyModes (class TtyModes)
Specifies a string containing terminal setting keywords and the characters to which they may be bound. Allowable keywords include: brk, dsusp, eof, eol, eol2, erase, erase2, flush, intr, kill, lnext, quit, rprnt, start, status, stop, susp, switch and weras. Control characters may be specified as ^char (e.g., ^c or ^u) and ^? may be used to indicate delete (127). Use ^- to denote undef. Use \034 to represent ^\, since a literal backslash in an X resource escapes the next character.

This is very useful for overriding
the default terminal settings without having to do an stty every time an xterm is started. Note, however, that the stty program on a given host may use different keywords; xterm's table is built-in.
useInsertMode (class UseInsertMode)
Force use of insert mode by adding appropriate entries to the TERMCAP environment variable. This is useful if the system termcap is broken. The default is false.
utmpDisplayId (class UtmpDisplayId)

Specifies whether or not xterm should try to record the display identifier (display number and screen number) as well as the hostname in the system utmp log file. The default is true.
utmpInhibit (classUtmpInhibit)
Specifies whether or not xterm should try to record the user's terminal in the system utmp log file. If true, xterm will not try. The default is false.

waitForMap (class WaitForMap)
Specifies whether or not xterm should wait for the initial window map before starting the subprocess. The default is false.
zIconBeep (class ZIconBeep)
Same as -ziconbeep command line argument. If the value of this resource is non-zero, xterms that produce output while iconified will cause an XBell sound at the given volume and have "***" prepended to their icon titles. Most window managers will detect this change immediately, showing you which window has the output. (A similar feature was in x10 xterm.) The default is false.


The following resources are specified as part of the vt100 widget (class VT100): These are specified by patterns such as "XTerm.vt100.NAME":

activeIcon (class ActiveIcon)
Specifies whether or not active icon windows are to be used when the xterm window is iconified, if this feature is compiled into xterm. The active icon is a miniature representation of the content of the window and will update as the content changes. Not all window managers necessarily support application icon windows. Some window managers will allow you to enter keystrokes into the active icon window. The default is false.
allowC1Printable (class AllowC1Printable)
If true, overrides the mapping of C1 controls (codes 128-159) to make them be treated as if they were printable characters. Although this corresponds to no particular standard, some users insist it is a VT100. The default is false.
allowSendEvents (class AllowSendEvents)

Specifies whether or not synthetic key and button events (generated using the X protocol SendEvent request) should be interpreted or discarded. The default is false meaning they are discarded. Note that allowing such events creates a very large security hole. The default is false.
allowWindowOps (class AllowWindowOps)
Specifies whether extended window control sequences (as used in dtterm) for should be allowed. The default is true.
alwaysHighlight (class AlwaysHighlight)
Specifies whether or not xterm should always display a highlighted text cursor. By default (if this resource is false), a hollow text cursor is displayed whenever the pointer moves out of the window or the window loses the input focus. The default is false.
alwaysUseMods (class AlwaysUseMods)
Override the numLock resource, telling xterm to use the Alt and Meta modifiers to construct parameters for function key sequences even if those modifiers appear in the translations resource. The default is false.

answerbackString (classAnswerbackString)
Specifies the string that xterm sends in response to an ENQ (control/E) character from the host. The default is a blank string, i.e., '. A hardware VT100 implements this feature as a setup option.
appcursorDefault (class AppcursorDefault)
If true, the cursor keys are initially in application mode. This is the same as the VT102 private DECCKM mode, The default is false.
appkeypadDefault (class AppkeypadDefault)
If true, the keypad keys are initially in application mode. The default is false.
autoWrap (classAutoWrap)
Specifies whether or not auto-wraparound should be enabled. This is the same as the VT102 DECAWM. The default is true.

awaitInput (class AwaitInput)
Specifies whether or not the xterm uses a 50 millisecond timeout to await input (i.e., to support the Xaw3d arrow scrollbar). The default is false.
backarrowKey (class BackarrowKey)
Specifies whether the backarrow key transmits a backspace (8) or delete (127) character. This corresponds to the DECBKM control sequence. The default (backspace) is true. Pressing the control key toggles this behavior.
background (class Background)

Specifies the color to use for the background of the window. The default is XtDefaultBackground.
bellOnReset (class BellOnReset)
Specifies whether to sound a bell when doing a hard reset. The default is true.
bellSuppressTime (class BellSuppressTime)
Number of milliseconds after a bell command is sent during which additional bells will be suppressed. Default is 200. If set non-zero, additional bells will also be suppressed until the server reports that processing of the first bell has been completed; this feature is most useful with the visible bell.
boldColors (class ColorMode)
Specifies whether to combine bold attribute with colors like the IBM PC, i.e., map colors 0 through 7 to colors 8 through 15. These normally are the brighter versions of the first 8 colors, hence bold. The default is true.
boldFont (class BoldFont)
Specifies the name of the bold font to use instead of overstriking. There is no default for this resource.

boldMode (class BoldMode)
This specifies whether or not text with the bold attribute should be overstruck to simulate bold fonts if the resolved bold font is the same as the normal font. It may be desirable to disable bold fonts when color is being used for the bold attribute. Note that xterm has one bold font which you may set explicitly. It attempts to match a bold font for the other font selections (font1 through font6). If the normal and bold fonts are distinct, this resource has no effect. The default is true.
Although xterm attempts to match a bold font for other font selections,
the font server may not cooperate. Since X11R6, bitmap fonts have been scaled. The font server claims to provide the bold font that xterm requests, but the result is not always readable. XFree86 provides a feature which can be used to suppress the scaling. In the X server's configuration file (e.g., /etc/X11/xorg.conf), you can add ":unscaled" to the end of the directory specification for the "misc" fonts, which comprise the fixed-pitch fonts that are used by xterm. For example

FontPath "/usr/share/X11/fonts"
would become
FontPath "/usr/share/X11/fonts/misc/:unscaled"
Depending on your configuration, the font server may have its own configuration
file. The same ":unscaled" can be added to its configuration file at the end of the directory specification for "misc".
brokenLinuxOSC (class BrokenLinuxOSC)
If true, xterm applies a workaround to ignore malformed control sequences that a Linux script might send. Compare the palette control sequences documented in console_codes with ECMA-48. The default is true.

brokenSelections (classBrokenSelections)
If true, xterm in 8-bit mode will interpret STRING selections as carrying text in the current locale's encoding. Normally STRING selections carry ISO-8859-1 encoded text. Setting this resource to true violates the ICCCM; it may, however, be useful for interacting with some broken X clients. The default is false.
brokenStringTerm (class BrokenStringTerm)
provides a work-around for some ISDN routers which start an application control string without completing it. Set this to true if xterm appears to freeze when connecting. The default is false.

c132 (class C132)
Specifies whether or not the VT102 DECCOLM escape sequence, used to switch between 80 and 132 columns, should be honored. The default is false.
cacheDoublesize (classCacheDoublesize)
Specifies the maximum number of double-sized fonts which are cached by xterm. The default (8) may be too large for some X terminals with limited memory. Set this to zero to disable doublesize fonts altogether.
charClass (class CharClass)
Specifies comma-separated lists of character class bindings of the form [low-]high:value. These are used in determining which sets of characters should be treated the same when doing cut and paste. See the CHARACTER CLASSES section.

cjkWidth (class CjkWidth)
Specifies whether xterm should follow the traditional East Asian width convention. When turned on, characters with East Asian Ambiguous (A) category in UTR 11 have a column width of 2. You may have to set this option to true if you have some old East Asian terminal based programs that assume that line-drawing characters have a column width of 2. The default is false.
color0 (classColor0)
color1 (class Color1)
color2 (class Color2)
color3 (class Color3)

color4 (class Color4)
color5 (class Color5)
color6 (class Color6)
color7 (class Color7)
These specify the colors for the ISO 6429 extension. The defaults are, respectively, black, red3, green3, yellow3, a customizable dark blue, magenta3, cyan3, and gray90. The default shades of color are chosen to allow the colors 8-15 to be used as brighter versions.
color8 (classColor8)
color9 (class Color9)

color10 (class Color10)
color11 (class Color11)
color12 (class Color12)
color13 (class Color13)
color14 (class Color14)
color15 (class Color15)

These specify the colors for the ISO 6429 extension if the bold attribute is also enabled. The default resource values are respectively, gray30, red, green, yellow, a customizable light blue, magenta, cyan, and white.
color16 (class Color16)
through
color255 (class Color255)
These specify the colors for the 256-color extension. The default resource values are for colors 16 through 231 to make a 6x6x6 color cube, and colors 232 through 255 to make a grayscale ramp.
colorAttrMode (class ColorAttrMode)
Specifies whether colorBD, colorBL, colorRV, and colorUL should override ANSI colors. If not, these are displayed only when no ANSI colors have been set for the corresponding position. The default is false.

colorBD (class ColorBD)
This specifies the color to use to display bold characters if the colorBDMode resource is enabled. The default is XtDefaultForeground.
colorBDMode (classColorAttrMode)
Specifies whether characters with the bold attribute should be displayed in color or as bold characters. Note that setting colorMode off disables all colors, including bold. The default is false.
colorBL (classColorBL)
This specifies the color to use to display blink characters if the colorBLMode resource is enabled. The default is XtDefaultForeground.
colorBLMode (class ColorAttrMode)
Specifies whether characters with the blink attribute should be displayed in color. Note that setting colorMode off disables all colors, including this. The default is false.

colorMode (class ColorMode)
Specifies whether or not recognition of ANSI (ISO 6429) color change escape sequences should be enabled. The default is true.
colorRV (class ColorRV)
This specifies the color to use to display reverse characters if the colorRVMode resource is enabled. The default is XtDefaultForeground.
colorRVMode (class ColorAttrMode)
Specifies whether characters with the reverse attribute should be displayed in color. Note that setting colorMode off disables all colors, including this. The default is false.
colorUL (classColorUL)

This specifies the color to use to display underlined characters if the colorULMode resource is enabled. The default is XtDefaultForeground.
colorULMode (class ColorAttrMode)
Specifies whether characters with the underline attribute should be displayed in color or as underlined characters. Note that setting colorMode off disables all colors, including underlining. The default is false.
ctrlFKeys (class CtrlFKeys)
In VT220 keyboard mode (see sunKeyboard resource), specifies the amount by which to shift F1-F12 given a control modifier (CTRL). This allows you to generate key symbols for F10-F20 on a Sun/PC keyboard. The default is 10, which means that CTRL F1 generates the key symbol for F11.
curses (class Curses)

Specifies whether or not the last column bug in <a href="more">more</a>(1) should be worked around. See the -cu option for details. The default is false.
cursorBlink (class CursorBlink)
Specifies whether to make the cursor blink. The default is false.
cursorColor (class CursorColor)
Specifies the color to use for the text cursor. The default is XtDefaultForeground. Xterm attempts to keep this color from being the same as the background color, since it draws the cursor by filling the background of a text cell. The same restriction applies to control sequences which may change this color.

cursorOffTime (class CursorOffTime)
Specifies the duration of the "off" part of the cursor blink cycle-time in milliseconds. The same timer is used for text blinking. The default is 300.
cursorOnTime (class CursorOnTime)
Specifies the duration of the "on" part of the cursor blink cycle-time, in milliseconds. The same timer is used for text blinking. The default is 600.
cutNewline (class CutNewline)
If false, triple clicking to select a line does not include the Newline at the end of the line. If true, the Newline is selected. The default is true.
cutToBeginningOfLine (class CutToBeginningOfLine)
If false, triple clicking to select a line selects only from the current word forward. If true, the entire line is selected. The default is true.
decTerminalID (class DecTerminalID)

Specifies the emulation level (100=VT100, 220=VT220, etc.), used to determine the type of response to a DA control sequence. Leading non-digit characters are ignored, e.g., "vt100" and "100" are the same. The default is 100.
deleteIsDEL (class DeleteIsDEL)
Specifies whether the Delete key on the editing keypad should send DEL (127) or the VT220-style Remove escape sequence. The default is false, for the latter.
dynamicColors (class DynamicColors)
Specifies whether or not escape sequences to change colors assigned to different attributes are recognized.
eightBitControl (class EightBitControl)
Specifies whether or not control sequences sent by the terminal should be eight-bit characters or escape sequences. The default is false.
eightBitInput (classEightBitInput)
If true, Meta characters (a single-byte character combined with the keys modifier key) input from the keyboard are presented as a single character with the eighth bit turned on. The terminal is put into 8-bit mode. If false, Meta characters are converted into a two-character sequence with the character itself preceded by ESC. On startup, xterm tries to put the terminal into 7-bit mode. The metaSendsEscape resource may override this. The default is true.

Generally keyboards do not have a key labeled "Meta",
but "Alt" keys are common, and they are conventionally used for "Meta". If they were synonymous, it would have been reasonable to name this resource "altSendsEscape", reversing its sense. For more background on this, see the meta function in curses.
Note that the Alt key is not necessarily the same as the
Meta modifier. xmodmap lists your key modifiers. X defines modifiers for shift, (caps) lock and control, as well as 5 additional modifiers which are generally used to configure key modifiers. xterm inspects the same information to find the modifier associated with either Meta key (left or right), and uses that key as the Meta modifier. It also looks for the NumLock key, to recognize the modifier which is associated with that.

If your xmodmap configuration
uses the same keycodes for Alt- and Meta-keys, xterm will only see the Alt-key definitions, since those are tested before Meta-keys. NumLock is tested first. It is important to keep these keys distinct; otherwise some of xterm's functionality is not available.
eightBitOutput (class EightBitOutput)
Specifies whether or not eight-bit characters sent from the host should be accepted as is or stripped when printed. The default is true, which means that they are accepted as is.
faceName (class FaceName)

Specify the pattern for fonts selected from the FreeType library if support for that library was compiled into xterm. There is no default. If not specified, or if there is no match for both normal and bold fonts, xterm uses the font and related resources.
faceNameDoublesize (class FaceNameDoublesize)
Specify an double-width font for cases where an application requires this, e.g., in CJK applications. There is no default. If the application uses double-wide characters and this resource is not given, xterm will use a scaled version of the font given by faceName.

faceSize (class FaceSize)
Specify the pointsize for fonts selected from the FreeType library if support for that library was compiled into xterm. The default is 14.
font (class Font)
Specifies the name of the normal font. The default is fixed.
See the discussion of the locale resource,
which describes how this font may be overridden.
NOTE: some resource files use patterns such as

*font:
fixed
which are overly broad, affecting both
xterm.vt100.font
and
xterm.vt100..utf8fonts.font
which is probably not what you intended.
font1 (class Font1)
Specifies the name of the first alternative font.
font2 (classFont2)
Specifies the name of the second alternative font.

font3 (class Font3)
Specifies the name of the third alternative font.
font4 (class Font4)
Specifies the name of the fourth alternative font.
font5 (class Font5)
Specifies the name of the fifth alternative font.
font6 (class Font6)
Specifies the name of the sixth alternative font.
fontDoublesize (class FontDoublesize)

Specifies whether xterm should attempt to use font scaling to draw doublesize characters. Some older font servers cannot do this properly, will return misleading font metrics. The default is true. If disabled, xterm will simulate doublesize characters by drawing normal characters with spaces between them.
forceBoxChars (class ForceBoxChars)
Specifies whether xterm should assume the normal and bold fonts have VT100 line-drawing characters:
-
The fixed-pitch ISO-8859-*-encoded fonts used by xterm normally have the VT100 line-drawing glyphs in cells 1-31. Other fixed-pitch fonts may be more attractive, but lack these glyphs.

-
When using an ISO-10646-1 font and the wideChars resource is true, xterm uses the Unicode glyphs which match the VT100 line-drawing glyphs.
If false, xterm checks for missing glyphs in the font
and makes line-drawing characters directly as needed. If true, xterm uses whatever is in the font without checking. The default is false.
foreground (class Foreground)

Specifies the color to use for displaying text in the window. Setting the class name instead of the instance name is an easy way to have everything that would normally appear in the text color change color. The default is XtDefaultForeground.
freeBoldBox (class freeBoldBox)
Specifies whether xterm should assume the bounding boxes for normal and bold fonts are compatible. If false, xterm compares them and will reject choices of bold fonts that do not match the size of the normal font. The default is false, which means that the comparison is performed.
geometry (class Geometry)
Specifies the preferred size and position of the VT102 window. There is no default for this resource.
highlightColor (class HighlightColor)

Specifies the color to use for the background of selected or otherwise highlighted text. If not specified, reverse video is used. The default is XtDefaultForeground.
highlightSelection (class HighlightSelection)
If false, selecting with the mouse highlights all positions on the screen between the beginning of the selection and the current position. If true, xterm highlights only the positions that contain text that can be selected. The default is false.
Depending on the way your applications write to the screen, there may
be trailing blanks on a line. Xterm stores data as it is shown on the screen. Erasing the display changes the internal state of each cell so it is not considered a blank for the purpose of selection. Blanks written since the last erase are selectable. If you do not wish to have trailing blanks in a selection, use the trimSelection resource.
hpLowerleftBugCompat (class HpLowerleftBugCompat)

Specifies whether to work around a bug in HP's xdb, which ignores termcap and always sends ESC F to move to the lower left corner. true causes xterm to interpret ESC F as a request to move to the lower left corner of the screen. The default is false.
i18nSelections (class I18nSelections)
If false, xterm will never request the targets COMPOUND_TEXT or TEXT. The default is true. It may be set to false in order to work around ICCCM violations by other X clients.

iconBorderColor (class BorderColor)
Specifies the border color for the active icon window if this feature is compiled into xterm. Not all window managers will make the icon border visible.
iconBorderWidth (class BorderWidth)
Specifies the border width for the active icon window if this feature is compiled into xterm. The default is 2. Not all window managers will make the border visible.
iconFont (classIconFont)
Specifies the font for the miniature active icon window, if this feature is compiled into xterm. The default is "nil2".

internalBorder (classBorderWidth)
Specifies the number of pixels between the characters and the window border. The default is 2.
italicULMode (class ColorAttrMode)
Specifies whether characters with the underline attribute should be displayed in an italic font or as underlined characters.
jumpScroll (class JumpScroll)
Specifies whether or not jump scroll should be used. This corresponds to the VT102 DECSCLM private mode. The default is true.
keyboardDialect (classKeyboardDialect)
Specifies the initial keyboard dialect, as well as the default value when the terminal is reset. The value given is the same as the final character in the control sequences which change character sets. The default is B, which corresponds to US ASCII.
nameKeymap (class NameKeymap)

See the discussion of the keymap() action.
limitResize (class LimitResize)
Limits resizing of the screen via control sequence to a given multiple of the display dimensions. The default is 1.
locale (class Locale)
Specifies how to use luit, an encoding converter between UTF-8 and locale encodings. The resource value (ignoring case) may be:
true
xterm will use the encoding specified by the users' LC_CTYPE locale (i.e., LC_ALL, LC_CTYPE, or LANG variables) as far as possible. This is realized by always enabling UTF-8 mode and invoking luit in non-UTF-8 locales.

medium
xterm will follow users' LC_CTYPE locale only for UTF-8, east Asian, and Thai locales, where the encodings were not supported by conventional 8bit mode with changing fonts. For other locales, xterm will use conventional 8bit mode.
checkfont
If mini-luit is compiled-in, xterm will check if a Unicode font has been specified. If so, it checks if the character encoding for the current locale is POSIX, Latin-1 or Latin-9, uses the appropriate mapping to support those with the Unicode font. For other encodings, xterm assumes that UTF-8 encoding is required.

false
xterm will use conventional 8bit mode or UTF-8 mode according to utf8 resource or -u8 option.
Any other value, e.g., UTF-8 or ISO8859-2,
is assumed to be an encoding name; luit will be invoked to support the encoding. The actual list of supported encodings depends on luit. The default is medium.

Regardless of your locale and encoding,
you need an ISO-10646-1 font to display the result. Your configuration may not include this font, or locale-support by xterm may not be needed. At startup, xterm uses a mechanism equivalent to the load-vt-fonts(utf8Fonts, Utf8Fonts) action to load font name subresources of the VT100 widget. That is, resource patterns such as "*vt100.utf8Fonts.font" will be loaded, and (if this resource is enabled), override the normal fonts. If no subresources are found, the normal fonts such as "*vt100.font", etc., are used. The resource files distributed with xterm use ISO-10646-1 fonts, but do not rely on them unless you are using the locale mechanism.

localeFilter (class LocaleFilter)
Specifies the file name for the encoding converter from/to locale encodings and UTF-8 which is used with the -lc option or locale resource. The help message shown by xterm -help lists the default value, which depends on your system configuration.
loginShell (class LoginShell)
Specifies whether or not the shell to be run in the window should be started as a login shell. The default is false.
marginBell (class MarginBell)

Specifies whether or not the bell should be rung when the user types near the right margin. The default is false.
metaSendsEscape (class MetaSendsEscape)
If true, Meta characters (a character combined with the Meta modifier key) are converted into a two-character sequence with the character itself preceded by ESC. This applies as well to function key control sequences, unless xterm sees that Meta is used in your key translations. If false, Meta characters input from the keyboard are handled according to the eightBitInput resource. The default is false.

mkWidth (class MkWidth)
Specifies whether xterm should use a built-in version of the wide character width calculation. The default is false.
modifyCursorKeys (class ModifyCursorKeys)
Tells how to handle the special case where Control-, Shift-, Alt- or Meta-modifiers are used to add a parameter to the escape sequence returned by a cursor-key. The default is 2:
Set it to 0 to use the old/obsolete behavior.

Set it to 1 to prefix modified sequences with CSI.
Set it to 2 to force the modifier to be the second parameter.

Set it to 3 to mark the sequence with a '>' to hint that it is private.

modifyOtherKeys (class ModifyOtherKeys)
Like modifyCursorKeys, tells xterm to construct an escape sequence for other keys (such as "2") when modified by Control-, Alt- or Meta-modifiers. This feature does not apply to function keys and well-defined keys such as ESC or the control keys. The default is 0:
Set it to 0 to disable this feature.

Set it to 1 to enable this feature for keys except Tab and some special control character cases, e.g., Control-Space to make a NUL.
Set it to 1 to enable this feature for keys including the exceptions listed.
multiClickTime (class MultiClickTime)

Specifies the maximum time in milliseconds between multi-click select events. The default is 250 milliseconds.
multiScroll (class MultiScroll)
Specifies whether or not scrolling should be done asynchronously. The default is false.
nMarginBell (class Column)
Specifies the number of characters from the right margin at which the margin bell should be rung, when enabled.
numLock (class NumLock)
If true, xterm checks if NumLock is used as a modifier (see <a href="xmodmap">xmodmap</a>(1)). If so, this modifier is used to simplify the logic when implementing special NumLock for the sunKeyboard resource. Also (when sunKeyboard is false), similar logic is used to find the modifier associated with the left and right Alt keys. The default is true.

oldXtermFKeys (class OldXtermFKeys)
If true, xterm will use old-style control sequences for function keys F1 to F4, for compatibility with X Consortium xterm. Otherwise, it uses the VT100-style codes for PF1 to PF4. The default is false.
on2Clicks (class On2Clicks)
on3Clicks (class On3Clicks)
on4Clicks (class On4Clicks)

on5Clicks (class On5Clicks)
Specify selection behavior in response to multiple mouse clicks. A single mouse click is always interpreted as described in the SELECTION section (see POINTER USAGE). Multiple mouse clicks (using the button which activates the select-start action) are interpreted according to the resource values of on2Clicks, etc. The resource value can be one of these:
word
Select a word as determined by the charClass resource. See the CHARACTER CLASSES section.

line
Select a line (counting wrapping).
group
Select a group of adjacent lines (counting wrapping). The selection stops on a blank line.
page
Select all visible lines, i.e., the page.
all
Select all lines, i.e., including the saved lines.
regex
Select a word as determined by the regular expression which follows in the resource value.
none
No selection action is associated with this resource. xterm interprets it as the end of the list. For example, you may use it to disable triple (and higher) clicking by setting on3Clicks to none.

The default values for on2Clicks and on3Clicks are
word and line, respectively. There is no default value for on4Clicks or on5Clicks, making those inactive. On startup, xterm determines the maximum number of clicks by the onXClicks resource values which are set.

pointerColor (class PointerColor)
Specifies the foreground color of the pointer. The default is XtDefaultForeground.
pointerColorBackground (classPointerColorBackground)
Specifies the background color of the pointer. The default is XtDefaultBackground.
pointerShape (class Cursor)
Specifies the name of the shape of the pointer. The default is xterm.
popOnBell (classPopOnBell)
Specifies whether the window would be raised when Control-G is received. The default is false.
printAttributes (class PrintAttributes)

Specifies whether to print graphic attributes along with the text. A real DEC VTxxx terminal will print the underline, highlighting codes but your printer may not handle these. A 0 disables the attributes. A 1 prints the normal set of attributes (bold, underline, inverse and blink) as VT100-style control sequences. A 2 prints ANSI color attributes as well. The default is 1.
printerAutoClose (class PrinterAutoClose)
If true, xterm will close the printer (a pipe) when the application switches the printer offline with a Media Copy command. The default is false.
printerCommand (class PrinterCommand)
Specifies a shell command to which xterm will open a pipe when the first MC (Media Copy) command is initiated. The default is a blank string. If the resource value is given as a blank string, the printer is disabled.
printerControlMode (class PrinterControlMode)

Specifies the printer control mode. A 1 selects autoprint mode, which causes xterm to print a line from the screen when you move the cursor off that line with a line feed, form feed or vertical tab character, or an autowrap occurs. Autoprint mode is overridden by printer controller mode (a 2), which causes all of the output to be directed to the printer. The default is 0.
printerExtent (class PrinterExtent)
Controls whether a print page function will print the entire page (true), or only the portion within the scrolling margins (false). The default is false.
printerFormFeed (class PrinterFormFeed)
Controls whether a form feed is sent to the printer at the end of a print page function. The default is false.
renderFont (class RenderFont)
If xterm is built with the Xft library, this controls whether the faceName resource is used. The default is true.

resizeGravity (class ResizeGravity)
Affects the behavior when the window is resized to be taller or shorter. NorthWest specifies that the top line of text on the screen stay fixed. If the window is made shorter, lines are dropped from the bottom; if the window is made taller, blank lines are added at the bottom. This is compatible with the behavior in R4. SouthWest (the default) specifies that the bottom line of text on the screen stay fixed. If the window is made taller, additional saved lines will be scrolled down onto the screen; if the window is made shorter, lines will be scrolled off the top of the screen, and the top saved lines will be dropped.
reverseVideo (class ReverseVideo)
Specifies whether or not reverse video should be simulated. The default is false.
reverseWrap (class ReverseWrap)

Specifies whether or not reverse-wraparound should be enabled. This corresponds to xterm's private mode 45. The default is false.
rightScrollBar (class RightScrollBar)
Specifies whether or not the scrollbar should be displayed on the right rather than the left. The default is false.
saveLines (class SaveLines)
Specifies the number of lines to save beyond the top of the screen when a scrollbar is turned on. The default is 64.
scrollBar (class ScrollBar)
Specifies whether or not the scrollbar should be displayed. The default is false.
scrollBarBorder (class ScrollBarBorder)

Specifies the width of the scrollbar border. Note that this is drawn to overlap the border of the xterm window. Modifying the scrollbar's border affects only the line between the VT100 widget and the scrollbar. The default value is 1.
scrollKey (class ScrollCond)
Specifies whether or not pressing a key should automatically cause the scrollbar to go to the bottom of the scrolling region. This corresponds to xterm's private mode 1011. The default is false.
scrollLines (class ScrollLines)
Specifies the number of lines that the scroll-back and scroll-forw actions should use as a default. The default value is 1.

scrollTtyOutput (class ScrollCond)
Specifies whether or not output to the terminal should automatically cause the scrollbar to go to the bottom of the scrolling region. The default is true.
selectToClipboard (class SelectToClipboard)
Tells xterm whether to use the PRIMARY or CLIPBOARD for SELECT tokens in the selection mechanism. The set-select action can change this at runtime, allowing the user to work with programs that handle only one of these mechanisms. The default is false, which tells it to use PRIMARY.
shiftFonts (class ShiftFonts)

Specifies whether to enable the actions larger-vt-font() and smaller-vt-font(), which are normally bound to the shifted KP_Add and KP_Subtract. The default is true.
showBlinkAsBold (class ShowBlinkAsBold)
Tells xterm whether to display text with blink-attribute the same as bold. If xterm has not been configured to support blinking text, the default is true., which corresponds to older versions of xterm, otherwise the default is false.

showMissingGlyphs (class ShowMissingGlyphs)
Tells xterm whether to display a box outlining places where a character has been used that the font does not represent. The default is false.
signalInhibit (class SignalInhibit)
Specifies whether or not the entries in the Main Options menu for sending signals to xterm should be disallowed. The default is false.
tekGeometry (class Geometry)

Specifies the preferred size and position of the Tektronix window. There is no default for this resource.
tekInhibit (class TekInhibit)
Specifies whether or not the escape sequence to enter Tektronix mode should be ignored. The default is false.
tekSmall (class TekSmall)
Specifies whether or not the Tektronix mode window should start in its smallest size if no explicit geometry is given. This is useful when running xterm on displays with small screens. The default is false.
tekStartup (class TekStartup)
Specifies whether or not xterm should start up in Tektronix mode. The default is false.

tiXtraScroll (class TiXtraScroll)
Specifies whether xterm should scroll to a new page when processing the ti termcap entry, i.e., the private modes 47, 1047 or 1049. This is only in effect if titeInhibit is true, because the intent of this option is to provide a picture of the full-screen application's display on the scrollback without wiping out the text that would be shown before the application was initialized. The default for this resource is false.
titeInhibit (classTiteInhibit)
Specifies whether or not xterm should remove ti and te termcap entries (used to switch between alternate screens on startup of many screen-oriented programs) from the TERMCAP string. If set, xterm also ignores the escape sequence to switch to the alternate screen. Xterm

supports terminfo in a different way, supporting composite control sequences (also known as private modes) 1047, 1048 and 1049 which have the same effect as the original 47 control sequence. The default for this resource is false.

translations (classTranslations)
Specifies the key and button bindings for menus, selections, programmed strings, etc. The translations resource, which provides much of xterm's configurability, is a feature of the X Toolkit Intrinsics library (Xt). See the ACTIONS section.
trimSelection (class TrimSelection)
If you set highlightSelection, you can see the text which is selected, including any trailing spaces. Clearing the screen (or a line) resets it to a state containing no spaces. Some lines may contain trailing spaces when an application writes them to the screen. However, you may not wish to paste lines with trailing spaces. If this resource is true, xterm will trim trailing spaces from text which is selected. It does not affect spaces which result in a wrapped line, nor will it trim the trailing newline from your selection. The default is false.

underLine (class UnderLine)
This specifies whether or not text with the underline attribute should be underlined. It may be desirable to disable underlining when color is being used for the underline attribute. The default is true.
utf8 (class Utf8)
This specifies whether xterm will run in UTF-8 mode. If you set this resource, xterm also sets the wideChars resource as a side-effect. The resource is an integer, expected to range from 0 to 3:

  • UTF-8 mode is initially off. The command-line option +u8 sets the resource to this value. Escape sequences for turning UTF-8 mode on/off are allowed.
  • UTF-8 mode is initially on. Escape sequences for turning UTF-8 mode on/off are allowed.
  • The command-line option -u8 sets the resource to this value. Escape sequences for turning UTF-8 mode on/off are ignored.
  • This is the default value of the resource. It is changed during initialization depending on whether the locale resource was set, to 0 or 2. See the locale resource for additional discussion of non-UTF-8 locales.

If you want to set the value of utf8, it should be in this range.
Other nonzero values are treated the same as 1, i.e., UTF-8 mode is initially on, and escape sequences for turning UTF-8 mode on/off are allowed.
utf8Fonts (class Utf8Fonts)
See the discussion of the locale resource.
utf8Latin1 (class Utf8Latin1)
If true, allow an ISO-8859-1 normal font to be combined with an ISO-10646 font if the latter is given via the -fw option or its corresponding resource value. The default is false.

utf8Title (class Utf8Title)
Applications can set xterm's title by writing a control sequence. Normally this control sequence follows the VT220 convention, which encodes the string in ISO-8859-1 and allows for an 8-bit string terminator. If xterm is started in a UTF-8 locale, it translates the ISO-8859-1 string to UTF-8 to work with the X libraries which assume the string is UTF-8.
However, some users may wish to write a title string encoded in UTF-8.
Set this resource to true to allow UTF-8 encoded title strings. That cancels the translation to UTF-8, allowing UTF-8 strings to be displayed as is.
The default is false.
veryBoldColors (class VeryBoldColors)
Specifies whether to combine video attributes with colors specified by colorBD, colorBL, colorRV and colorUL. The resource value is the sum of values for each attribute:


1 for reverse,
2 for underline,
4 for bold and
8 for blink.

The default is 0.
visualBell (class VisualBell)
Specifies whether or not a visible bell (i.e., flashing) should be used instead of an audible bell when Control-G is received. The default is false.
visualBellDelay (class VisualBellDelay)
Number of milliseconds to delay when displaying a visual bell. Default is 100. If set to zero, no visual bell is displayed. This is useful for very slow displays, e.g., an LCD display on a laptop.
vt100Graphics (class VT100Graphics)
This specifies whether xterm will interpret VT100 graphic character escape sequences while in UTF-8 mode. The default is true, to provide support for various legacy applications.

wideBoldFont (class WideBoldFont)
This option specifies the font to be used for displaying bold wide text. By default, it will attempt to use a font twice as wide as the font that will be used to draw bold text. If no doublewidth font is found, it will improvise, by stretching the bold font.
wideChars (class WideChars)
Specifies if xterm should respond to control sequences that process 16-bit characters. The default is false.
wideFont (class WideFont)
This option specifies the font to be used for displaying wide text. By default, it will attempt to use a font twice as wide as the font that will be used to draw normal text. If no doublewidth font is found, it will improvise, by stretching the normal font.
ximFont (class XimFont)

This option specifies the font to be used for displaying the preedit string in the "OverTheSpot" input method.
In "OverTheSpot" preedit type, the preedit (preconversion)
string is displayed at the position of the cursor. It is the XIM server's responsibility to display the preedit string. The XIM client must inform the XIM server of the cursor position. For best results, the preedit string must be displayed with a proper font. Therefore, xterm informs the XIM server of the proper font. The font is be supplied by a "fontset", whose default value is "*". This matches every font, the X library automatically chooses fonts with proper charsets. The ximFont resource is provided to override this default font setting.


The following resources are specified as part of the tek4014 widget (class Tek4014). These are specified by patterns such as "XTerm.tek4014.NAME":

font2 (class Font)
Specifies font number 2 to use in the Tektronix window.
font3 (class Font)
Specifies font number 3 to use in the Tektronix window.
fontLarge (class Font)
Specifies the large font to use in the Tektronix window.
fontSmall (class Font)
Specifies the small font to use in the Tektronix window.

ginTerminator (class GinTerminator)
Specifies what character(s) should follow a GIN report or status report. The possibilities are none, which sends no terminating characters, CRonly, which sends CR, and CR&EOT, which sends both CR and EOT. The default is none.
height (class Height)
Specifies the height of the Tektronix window in pixels.
initialFont (class InitialFont)
Specifies which of the four Tektronix fonts to use initially. Values are the same as for the set-tek-text action. The default is large.

width (class Width)
Specifies the width of the Tektronix window in pixels.


The resources that may be specified for the various menus are described in the documentation for the Athena SimpleMenu widget. The name and classes of the entries in each of the menus are listed below. Resources named "lineN" where N is a number are separators with class SmeLine.


The mainMenu has the following entries:

toolbar (class SmeBSB)
This entry invokes the set-toolbar(toggle) action.
securekbd (class SmeBSB)
This entry invokes the secure() action.

allowsends (class SmeBSB)
This entry invokes the allow-send-events(toggle) action.
redraw (class SmeBSB)
This entry invokes the redraw() action.
logging (class SmeBSB)

This entry invokes the logging(toggle) action.
print (class SmeBSB)
This entry invokes the print() action.
print-redir (class SmeBSB)
This entry invokes the print-redir() action.

8-bit-control (class SmeBSB)
This entry invokes the set-8-bit-control(toggle) action.
backarrow key (class SmeBSB)
This entry invokes the set-backarrow(toggle) action.
num-lock (class SmeBSB)

This entry invokes the set-num-lock(toggle) action.
alt-esc (class SmeBSB)
This entry invokes the alt-sends-escape(toggle) action.
meta-esc (class SmeBSB)
This entry invokes the meta-sends-escape(toggle) action.

delete-is-del (class SmeBSB)
This entry invokes the delete-is-del(toggle) action.
oldFunctionKeys (class SmeBSB)
This entry invokes the old-function-keys(toggle) action.
hpFunctionKeys (classSmeBSB)
This entry invokes the hp-function-keys(toggle) action.

scoFunctionKeys (class SmeBSB)
This entry invokes the sco-function-keys(toggle) action.
sunFunctionKeys (class SmeBSB)
This entry invokes the sun-function-keys(toggle) action.
sunKeyboard (class SmeBSB)

This entry invokes the sunKeyboard(toggle) action.
suspend (class SmeBSB)
This entry invokes the send-signal(tstp) action on systems that support job control.
continue (class SmeBSB)
This entry invokes the send-signal(cont) action on systems that support job control.

interrupt (classSmeBSB)
This entry invokes the send-signal(int) action.
hangup (class SmeBSB)
This entry invokes the send-signal(hup) action.
terminate (class SmeBSB)
This entry invokes the send-signal(term) action.

kill (class SmeBSB)
This entry invokes the send-signal(kill) action.
quit (class SmeBSB)
This entry invokes the quit() action.


The vtMenu has the following entries:

scrollbar (class SmeBSB)
This entry invokes the set-scrollbar(toggle) action.
jumpscroll (class SmeBSB)
This entry invokes the set-jumpscroll(toggle) action.
reversevideo (class SmeBSB)

This entry invokes the set-reverse-video(toggle) action.
autowrap (class SmeBSB)
This entry invokes the set-autowrap(toggle) action.
reversewrap (class SmeBSB)
This entry invokes the set-reversewrap(toggle) action.

autolinefeed (class SmeBSB)
This entry invokes the set-autolinefeed(toggle) action.
appcursor (class SmeBSB)
This entry invokes the set-appcursor(toggle) action.
appkeypad (class SmeBSB)

This entry invokes the set-appkeypad(toggle) action.
scrollkey (class SmeBSB)
This entry invokes the set-scroll-on-key(toggle) action.
scrollttyoutput (class SmeBSB)
This entry invokes the set-scroll-on-tty-output(toggle) action.

allow132 (class SmeBSB)
This entry invokes the set-allow132(toggle) action.
cursesemul (class SmeBSB)
This entry invokes the set-cursesemul(toggle) action.
visualbell (class SmeBSB)

This entry invokes the set-visualbell(toggle) action.
poponbell (class SmeBSB)
This entry invokes the set-poponbell(toggle) action.
marginbell (class SmeBSB)
This entry invokes the set-marginbell(toggle) action.

cursorblink (class SmeBSB)
This entry invokes the set-cursorblink(toggle) action.
titeInhibit (class SmeBSB)
This entry invokes the set-titeInhibit(toggle) action.
activeicon (class SmeBSB)

This entry toggles active icons on and off if this feature was compiled into xterm. It is enabled only if xterm was started with the command line option +ai or the activeIcon resource is set to True.
softreset (class SmeBSB)
This entry invokes the soft-reset() action.
hardreset (class SmeBSB)

This entry invokes the hard-reset() action.
clearsavedlines (class SmeBSB)
This entry invokes the clear-saved-lines() action.
tekshow (class SmeBSB)
This entry invokes the set-visibility(tek,toggle) action.

tekmode (class SmeBSB)
This entry invokes the set-terminal-type(tek) action.
vthide (class SmeBSB)
This entry invokes the set-visibility(vt,off) action.
altscreen (class SmeBSB)

This entry invokes the set-altscreen(toggle) action.


The fontMenu has the following entries:

fontdefault (class SmeBSB)
This entry invokes the 'set-vt-font'(d) action.

font1 (class SmeBSB)
This entry invokes the '''set-vt-font(1) action.
font2 (class SmeBSB)
This entry invokes the '''set-vt-font(2) action.
font3 (class SmeBSB)

This entry invokes the '''set-vt-font(3) action.
font4 (class SmeBSB)
This entry invokes the '''set-vt-font(4) action.
font5 (class SmeBSB)
This entry invokes the '''set-vt-font(5) action.

font6 (classSmeBSB)
This entry invokes the '''set-vt-font(6) action.
fontescape (class SmeBSB)
This entry invokes the 'set-vt-font'(e) action.
fontsel (class SmeBSB)

This entry invokes the 'set-vt-font'(s) action.
font-linedrawing (class SmeBSB)
This entry invokes the 'set-font-linedrawing'(s) action.
font-doublesize (class SmeBSB)
This entry invokes the 'set-font-doublesize'(s) action.

render-font (class SmeBSB)
This entry invokes the 'set-render-font'(s) action.
utf8-mode (class SmeBSB)
This entry invokes the 'set-utf8-mode'(s) action.
utf8-title (class SmeBSB)

This entry invokes the 'set-utf8-title'(s) action.


The tekMenu has the following entries:

tektextlarge (class SmeBSB)
This entry invokes the '''set-tek-text(l) action.

tektext2 (class SmeBSB)
This entry invokes the '''set-tek-text(2) action.
tektext3 (class SmeBSB)
This entry invokes the '''set-tek-text(3) action.
tektextsmall (class SmeBSB)

This entry invokes the 'set-tek-text'(s) action.
tekpage (classSmeBSB)
This entry invokes the tek-page() action.
tekreset (class SmeBSB)
This entry invokes the tek-reset() action.

tekcopy (class SmeBSB)
This entry invokes the tek-copy() action.
vtshow (class SmeBSB)
This entry invokes the set-visibility(vt,toggle) action.
vtmode (class SmeBSB)

This entry invokes the set-terminal-type(vt) action.
tekhide (class SmeBSB)
This entry invokes the set-visibility(tek,toggle) action.


The following resources are useful when specified for the Athena Scrollbar widget:

thickness (class Thickness)

Specifies the width in pixels of the scrollbar.
background (class Background)
Specifies the color to use for the background of the scrollbar.
foreground (class Foreground)
Specifies the color to use for the foreground of the scrollbar. The thumb of the scrollbar is a simple checkerboard pattern alternating pixels for foreground and background color.


ReferencesEdit

Around Wikia's network

Random Wiki