# x3270 Resources

Resources are used to configure x3270. Resources are named items with string, integer or Boolean values.

Resource definitions come from the following sources:

- Default values are compiled into x3270.
- Standard X11 methods can be used to override the compiled-in defaults. These methods include:
  - The x3270 app-defaults file (only if x3270 is built with app-defaults support). This can be a locale-specific or generic app-defaults file located in the user's home directory or in the system X11 directory.
  - Definitions set by the xrdb command.
  - The ~/.Xdefaults file.
- If a session file foo.x3270 is specified on the command line, its contents are applied. Otherwise, if the x3270 profile (~/.x3270pro) exists, it is read and its contents are applied. These definitions override resource values defined by X11 methods and compiled-in defaults.
- Command-line options override all other resource definitions. If more than one command-line option sets a resource, the last one is used.

Many resources have their own command-line switches, which are listed below. Those that do not can still be set from the command-line via the -xrm command-line option. For example x3270.bsdTm can be set by the following command-line option:

         -xrm 'x3270.bsdTm: true'

Note that -xrm is supported on all of the 3270 emulators, not just on x3270.

## Resource File Syntax

A resource file (app-defaults file, profile or session file) has the following syntax.

- Each definition consists of:

          x3270.resource-name: value

- Comment lines begin with !.
- Line continuation is indicated by a backshash (\) character at the end of a line.
- Multi-line resources, such as keymap definitions, are split with newline characters, e.g.:

          x3270.keymap.foo: \
            <Key>a: String("bob") \n\
            <Key>b: String("fred") \n\
            <Key>c: String("joe")

## Alphabetical Resource List

Name: x3270.activeIcon
Type: Boolean
Default: false
Command Line: -activeicon
Description:

When true, x3270's icon becomes a live miniature of the screen display.

Name: x3270.aidWait
Type: Boolean
Default: false
Command Line: -set aidWait , -clear aidWait
Description:

When true, x3270 will not block a script after executing an AID action (Enter, Clear, PF or PA). It is then script's responsibility to poll x3270's status until it shows that the keyboard is no longer unlocked.

Name: x3270.allowResize
Type: Boolean
Default: true
Description:

When true, the x3270 window can be resized by the mouse (actually, by the window manager). When false, the window can only be resized from menu options. The purpose of disabling mouse resizing is to allow a window bigger than will fit on the screen, which some window managers (e.g., mwm) will not allow if permitted to resize it.

Name: x3270.altCursor
Type: Boolean
Default: false
Command Line: -set altCursor , -clear altCursor
Option: Options -> Toggles -> Underline Cursor
Option: Options -> Toggles -> Block Cursor
Description:

When true, this causes x3270 to use the alternate (underscore) cursor. When false, it will use a block cursor.

Name: x3270.aplMode
Type: Boolean
Default: false
Command Line: -apl
Description:

Enables x3270 APL mode. APL mode appends apl to the list of names in x3270.keymap (causing the Alt key plus many alphanumeric keys to produce basic APL symbols), sets x3270.composeMap to apl (allowing Compose key sequences to construct complex APL symbols), and sets x3270.charset to apl (allowing the display of APL symbols using several of the 3270 fonts).

Name: x3270.background
Type: String
Default: white
Command Line: -bg , -rv
Description:

The background color for menus, buttons, and on monochrome X11 displays, the emulator window.

Name: x3270.bellVolume
Type: Integer
Description:

Controls the volume used when ringing the terminal bell. The value ranges from -100 (silent) through 0 (normal) to +100 (loud). Not all X11 servers can vary the bell volume, other than turning it on and off. This resource can be overridden by x3270.visualBell, which if true, will replace the bell with a flash of the screen.

Name: x3270.bindLimit
Type: Boolean
Default: true
Description:

When true, x3270 will restrict its screen dimensions to those specified in the BIND image sent by the host. If false, it will not.

Name: x3270.blankFill
Type: Boolean
Default: false
Command Line: -set blankFill , -clear blankFill
Option: Options -> Toggles -> Blank Fill
Description:

When true, in 3270 mode x3270 will automatically convert trailing blanks in a field to NULLs in order to insert a character, and will automatically convert leading NULLs to blanks so that input data is not squeezed to the left. This works around some of the quirkier behavior of real 3270 terminals.

Name: x3270.boldColor
Type: String
Default: green
Description:

This resource defines the X11 color used to display intensified text in 3278 mode.

Previous versions of x3270 implemented something called pseudo-color mode, where a monochrome (3278) terminal was emulated with various colors assigned to different kinds of fields. To emulate pseudo-color mode with the current version of x3270, select 3278 emulation with x3270.model, set x3270.inputColor to orange and set x3270.boldColor to cyan.

Name: x3270.bsdTm
Type: Boolean
Default: false
Description:

Defines x3270's response to the TELNET DO TIMING MARK option. When set to false, x3270 will respond to DO TIMING MARK with WONT TIMING MARK, which is consistent with most modern TELNET clients. When true, x3270 will respond with WILL TIMING MARK, which is consistent with the old BSD telnet command and with previous versions of x3270. In either case, x3270 will never respond to a DONT TIMING MARK option.

Name: x3270.caDir
Type: String
Command Line: -cadir
Description:

Defines a directory containing CA (root) certificates, used to validate a certificate presented by the host during SSL negotiation. The default is determined by the OpenSSL library on your workstation.

Name: x3270.caFile
Type: String
Command Line: -cafile
Description:

Defines a PEM-format file containing CA (root) certificates, used to validate a certificate presented by the host during SSL negotiation.

Name: x3270.certFile
Type: String
Command Line: -certfile
Description:

Gives the name of a certificate file, provided to the host if requested during SSL negotiation. The default file format is PEM; it can be overridden by x3270.certFileType. The private key for the certificate is specified by x3270.keyFile. If x3270.chainFile is specified, it overrides x3270.certFile.

Name: x3270.certFileType
Type: String
Default: pem
Command Line: -certfiletype
Description:

Gives the type of the certificate file specified by x3270.certFile. The value can be pem or asn1.

Name: x3270.chainFile
Type: String
Command Line: -chainfile
Description:

Gives the name of a certificate chain file, provided to the host if requested during SSL negotiation. The file contains a PEM-format certificate, optionally followed by any intermediate certificates used to sign it, and the CA (root) certificate. The private key for the certificate is specified by x3270.keyFile. If x3270.chainFile is specified, it overrides x3270.certFile.

Name: x3270.charClass
Type: String
Description:

Defines groups of characters that should be treated the same when doing cut and paste of words. Identical in use to the xterm resource of the same name.

Name: x3270.charset
Type: String
Default: bracket
Command Line: -charset
Option: Options -> Character Set
Description:

This defines the host EBCDIC character set, that is, what glyph (image) is displayed for each EBCDIC code sent by the host, and what EBCDIC code is sent to the host for each character typed on the keyboard. This is more correctly referred to as the host code page.

To display the character sets supported by x3270, use the -v command-line option.

Name: x3270.charsetList
Type: String
Description:

Defines the Options -> Character Set menu. Can contain '>' characters to define a menu hierarchy.

See the file X3270.xad for an example.

Name: x3270.color8
Type: Boolean
Default: false
Description:

If true, x3270 will respond to a Query(Color) with a list of 8 supported colors. If false, it will send a list of 16 colors. The 8-color setting is required for some hosts which abort a session if 16 colors are reported.

Name: x3270.colorBackground
Type: String
Default: black
Description:

The background color for the emulator window. This resource is used only on color X11 displays when x3270.model specifies 3278 mode. On monochrome X11 displays, the background color is white, unless -rv (reverse video) is selected on the command line; in 3279 mode, the screen background is determined by x3270.colorScheme.

Name: x3270.colorScheme
Type: String
Default: default
Option: Options -> Color Scheme
Description:

Defines the colors used to paint the emulator window in 3279 (full-color) mode. This resource is used only when x3270.model specifies a 3279 display. x3270.colorScheme is just the name of the color scheme. The actual color scheme definition for color scheme foo is x3270.colorScheme.foo.

Name: x3270.colorScheme.foo
Type: String
Description:

An individual color scheme definition. I.e., to define color scheme foo, a resource named x3270.colorScheme.foo must be defined.

Each resource is a whitespace-separated list of 23 items:

1. X11 color for host color 0 NeutralBlack (also used for NVT color 0)
2. X11 color for host color 1 Blue (also used for NVT color 4)
3. X11 color for host color 2 Red (also used for NVT color 1)
4. X11 color for host color 3 Pink (also used for NVT color 5)
5. X11 color for host color 4 Green (also used for NVT color 2)
6. X11 color for host color 5 Turquoise
7. X11 color for host color 6 Yellow (also used for NVT color 3)
8. X11 color for host color 7 NeutralWhite
9. X11 color for host color 8 Black
10. X11 color for host color 9 DeepBlue
11. X11 color for host color 10 Orange
12. X11 color for host color 11 Purple
13. X11 color for host color 12 PaleGreen
14. X11 color for host color 13 PaleTurquoise (also used for NVT color 6)
15. X11 color for host color 14 Grey
16. X11 color for host color 15 white (also used for NVT color 7)
17. X11 color to use if one of 0..15 cannot be allocated (white or black)
18. X11 color to use as the default screen background
19. X11 color to use as the select background
20. Host color (0..15) for unprotected, unhighlighted fields
21. Host color (0..15) for unprotected, highlighted fields
22. Host color (0..15) for protected, unhighlighted fields
23. Host color (0..15) for protected, highlighted fields

Note: Host color 0 (NeutralBlack) means black on a display screen (a white-on-black device) and white on a printer (a black-on-white device). Host color 7 (NeutralWhite) means white on a display screen and black on a printer.

Name: x3270.composeMap
Type: String
Default: latin1
Description:

Gives the name of the map used to define the pairs of characters that form composite characters with the Compose key. The definition of compose map foo is the resource x3270.composeMap.foo.

Name: x3270.composeMap.foo
Type: String
Description:

An individual compose map definition. Each line in the resource is of the form:

             keysym1 + keysym2 = keysym3

meaning "when the Compose key is pressed, followed by keysym1 and keysym2 (in either order), interpret it as keysym3." The definitions are case-sensitive.

Name: x3270.confDir
Type: String
Default: /usr/local/etc/x3270
Description:

Defines the x3270 configuration directory, where x3270 will search for the ibm_hosts file by default. (See x3270.hostsFile.)

Name: x3270.connectFileName
Type: String
Default: ~/.x3270connect
Description:

Gives the name of the file to store the recently-connected host list in. If given the value none, no file will be read or written. Note that by default, this file is shared among all instances of x3270 that run under the same username.

Name: x3270.crosshair
Type: Boolean
Default: false
Command Line: -set crosshair , -clear crosshair
Option: Options -> Toggles -> Crosshair Cursor
Description:

When true, causes x3270 to display a crosshair over the cursor: lines extending with height and width of the screen.

Name: x3270.cursorBlink
Type: Boolean
Default: false
Command Line: -set cursorBlink , -clear cursorBlink
Option: Options -> Toggles -> Blinking Cursor
Description:

When true, causes x3270 to use a blinking cursor.

Name: x3270.cursorColor
Type: String
Default: red
Description:

On color X11 displays, this is the color of the text cursor. This resource is used only if x3270.useCursorColor is true.

Name: x3270.cursorPos
Type: Boolean
Default: true
Command Line: -set cursorPos , -clear cursorPos
Option: Options -> Toggles -> Track Cursor
Description:

When true, causes x3270 to display the cursor location in the OIA (the status line).

Name: x3270.dbcsCgcsgid
Type: String
Description:

Overrides the compiled-in value of the CGCSGID for the current host character set, which will be reported to the host in response to a Query(Character Sets). The value is an integer, which can be prefixed with '0x' to be in hexadecimal. The upper 16 bits are the GCSGID (character set) and the lower 16 bits are the CPGID (code page). This value applies only to the double-byte (DBCS) character set. Use x3270.sbcsCgcsgid for the single-byte (SBCS) character set.

Name: x3270.debugTracing
Type: Boolean
Default: true
Description:

If true, options are available on the File menu to trace the 3270 data stream and X11 events. If false, these options are not displayed.

Name: x3270.dftBufferSize
Type: Integer
Default: 4096
Description:

Specifies the default buffer size for DFT IND$FILE file transfers. This value can be overridden in the File Transfer dialog and by a parameter to the Transfer action.

Name: x3270.devName
Type: String
Command Line: -devname
Description:

Specifies the device name (workstation ID) sent in response to a TELNET NEW-ENVIRON sub-negotiation request, used by iSeries hosts (RFC 4777).

Name: x3270.disconnectClear
Type: Boolean
Default: false
Description:

If true, x3270 will clear the screen when a host disconnects.

Name: x3270.doConfirms
Type: Boolean
Default: true
Description:

When true, x3270 will display a pop-up to report successful completion of certain operations, such as screen printing. When false, these pop-ups are not displayed.

Name: x3270.dsTrace
Type: Boolean
Default: false
Command Line: -trace , -set dsTrace , -clear dsTrace
Option: File -> Trace Data Stream
Description:

When true, x3270 writes a hexadecimal representation of all network traffic (and its interpretation) into a file, which defaults to /tmp/x3trc.pid. It also pops up a window to watch the file as it is created, with the pathname of the file as the window title. The command run in the window is defined by x3270.traceCommand. The directory prefix is defined by x3270.traceDir. If x3270.traceFile is defined, it gives the entire pathname and x3270.traceDir is ignored.

Name: x3270.emulatorFont
Type: String
Default: 3270
Command Line: -efont
Option: Options -> Font
Description:

The font used for the emulator window. By default it is 3270, a 14-pixel clone of a real 3278 display font. Other 3270-specific fonts are available in 8-, 12-, 16-, 24- and 32-pixel sizes. Any standard X11 constant-spaced font can also be used, provided that it implements a display character set compatible with the host code page (x3270.charset). However, the special OIA (status line) symbols are only available with the 3270 fonts.

Name: x3270.emulatorFontList.foo
Type: String
Description:

A list of fonts for display character set foo. This list will be presented by the Options -> Font menu when the host code page (x3270.charset) requires display character set foo.

The list can include '>' characters to present a hierarchy of options.

See the file X3270.xad for an example.

Name: x3270.eof
Type: String
Default: ^D
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name.

When connected in line-at-a-time mode (when x3270 gathers a line of input before forwarding it to the host), entering this character at the keyboard causes the current line of input to be forwarded to the host without a trailing CR/LF sequence.

Name: x3270.erase
Type: String
Default: ^?
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name.

When connected in line-at-a-time mode (x3270 gathers a line of input before forwarding it ot the host), entering this character at the keyboard will cause x3270 to discard the last character on the input line.

When connected in character-at-a-time mode (x3270 sends each keystroke to the host as it is entered), this is the character that will be sent to the host by the Erase action.

Name: x3270.eventTrace
Type: Boolean
Default: false
Command Line: -set eventTrace , -clear eventTrace
Option: File -> Trace Keyboard/Mouse Events
Description:

When true, x3270 traces information about keyboard and mouse events into a file. The default file name is /tmp/x3trc.pid. It also pops up a window to watch the file as it is created, with the pathname of the file as the window title. The command run in the window is defined by x3270.traceCommand. The directory prefix is defined by x3270.traceDir. If x3270.traceFile is defined, it gives the entire pathname and x3270.traceDir is ignored.

Name: x3270.extended
Type: Boolean
Default: false
Command Line: -extended
Description:

Deprecated resource -- replaced by x3270.model syntax

Indicates support for the 3270 Extended Data Stream.

Name: x3270.fixedSize
Type: String
Description:

Specifies a fixed size for the x3270 display window. If set, x3270 will not allow its window to be resized by the window manager. The syntax is widthxheight. The 3270 display screen will float in the center of the window if necessary.

Name: x3270.foreground
Type: String
Default: black
Command Line: -fg , -rv
Description:

The foreground color for menus, buttons, and on monochrome X11 displays, the emulator display.

Name: x3270.highlightBold
Type: Boolean
Default: false
Description:

If true, highlighted fields will be displayed in bold. If false, highlighted fields will be displayed in the normal font.

Name: x3270.hostname
Type: String
Description:

Gives the name of the host to connect to. The name can include the usual options (prefixes to specify special connection options, LU names, and port). A hostname specified on the command line takes precedence over x3270.hostname.

The most common use of x3270.hostname is in session files, where a file is used to pass all of the options to establish a x3270 session.

Name: x3270.hostsFile
Type: String
Default: /usr/local/etc/x3270/ibm_hosts
Description:

The pathname of a file listing the host names that appear on the File -> Connect menu. The file can also be used to create hostname aliases and to define a set of actions to perform when connecting to a host.

The format of the file is explained on the ibm_hosts manual page. The default pathname is actually ibm_hosts in the directory defined by x3270.confDir.

Name: x3270.iconFont
Type: String
Default: nil2
Description:

The font used to paint the text inside the active icon (see x3270.activeIcon). The default of nil2 is a one-by-two pixel font that produces a "greeked" picture of the screen image.

Name: x3270.iconLabelFont
Type: String
Default: 8x13
Description:

When x3270.activeIcon and x3270.labelIcon are true, this is the name of the font used to paint the icon label.

Name: x3270.icrnl
Type: Boolean
Default: true
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name. It controls whether input carriage returns are mapped to newlines.

Name: x3270.idleCommand
Type: String
Description:

When x3270.idleCommand is defined, it specifies a command to execute after a period of keyboard inactivity (no AID keys pressed). The x3270.idleCommand can be an arbitrary sequence of x3270 actions, but it should include an action which generates an AID (Enter, Clear, PF or PA). x3270.idleCommandEnabled must be true in order for the x3270.idleCommand to take effect. (This is so an idle command can be defined, but needs to be enabled explicitly at some point after login.) x3270.idleTimeout specifies the inactivity interval.

Name: x3270.idleCommandEnabled
Type: Boolean
Default: false
Description:

Controls whether x3270.idleCommand has effect as soon as a host session is established. (This is so an idle command can be defined, but needs to be explicitly enabled at some point after login.)

Name: x3270.idleTimeout
Type: String
Default: ~7m
Description:

The timeout value for x3270.idleCommand. If the value ends in h, it specifies hours; if it ends in m it specifies minutes; if it ends in s or does not have an alphanumeric suffix, it specifies seconds.

If the value begins with a tilde ~, the time will be randomly varied +/-10% from the value specified.

Name: x3270.inlcr
Type: Boolean
Default: false
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name. It controls whether input newlines are mapped to carriage returns.

Name: x3270.inputColor
Type: String
Default: green
Description:

This resource defines the color used to display light-pen selectable text in 3278 (monochrome) emulation mode.

Previous versions of x3270 implemented something called pseudo-color mode, where a monochrome (3278) terminal was emulated with various colors assigned to different kinds of fields. To emulate pseudo-color mode with the current version of x3270, select 3278 emulation with x3270.model, set x3270.inputColor to orange and set x3270.boldColor to cyan.

If the resource x3270.modifiedSel is true, modified fields are also displayed using x3270.inputColor.

Name: x3270.inputMethod
Type: String
Command Line: -im
Description:

Specifies the name of the multi-byte input method. The default is specified by the XMODIFIERS environment variable, if set, or will be constructed by Xlib based on the current locale.

Name: x3270.intr
Type: String
Default: ^C
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name. When this character is typed on the keyboard, the TELNET IP (Interrupt Process) sequence is sent to the host.

Name: x3270.invertKeypadShift
Type: Boolean
Default: false
Description:

When true, causes the PF1-PF12 and PF13-PF24 keys on the pop-up keypad to be swapped. Normally, the low-numbered keys appear; when Shift, Alt, Ctrl or Meta is pressed, the high-numbered keys appear. With this resource true, that is reversed.

Name: x3270.keyFile
Type: String
Command Line: -keyfile
Description:

Gives the name of a file containg the private key for the certificate specified by x3270.certFile or x3270.chainFile. The default file type is PEM; it can be overridden by x3270.keyFileType. If the private key is encrypted, the password is specified by x3270.keyPasswd.

Name: x3270.keyFileType
Type: String
Default: pem
Command Line: -keyfileType
Description:

Gives the type of the private key file specified by x3270.keyFile. The value can be pem or asn1.

Name: x3270.keyHeight
Type: Integer
Default: 24
Description:

Defines the height of the keys on the pop-up keypad.

Name: x3270.keymap
Type: String
Command Line: -keymap
Description:

The name of the keyboard map to use. It can be a single keymap name or a comma-separated list of keymaps, which will be applied in order.

Each keymap can optionally be defined in three separate parts: a common keymap, which is applied at all times, an NVT-mode keymap, which is applied only in NVT mode, and a 3270-mode keymap, which is only applied in 3270 mode. The NVT-mode keymap has the same name as the common keymap, with the suffix .nvt appended. The 3270-mode keymap has the suffix .3270 appended. Thus specifying a x3270.keymap value of foo implies the use of three different keymaps (if found): foo, foo.nvt and foo.3270.

After that, the string .user is appended to the keymap name and three more keymaps are searched for: foo.user, foo.user.nvt and foo.user.3270, for a total of six.

If no x3270.keymap is defined, the environment variables $KEYMAP and $KEYBD are checked, in that order, for the name. x3270.keymap is only the name; the keymap definition for name foo is the resource x3270.keymap.foo.

Name: x3270.keymap.foo
Type: String
Description:

The definition of keymap foo. Please refer to the How To Create a Custom Keymap document for a full description of the syntax.

Name: x3270.keypad
Type: String
Default: right
Description:

This controls the position of the pop-up keypad. It can have one of five values:

- left, a pop-up window positioned to the left of the main x3270 window
- right, a pop-up window positioned to the right of the main x3270 window
- bottom, a pop-up window positioned below the main x3270 window
- integral, making the keypad an extension of the bottom of the main window itself
- insideRight, placing the keypad over the upper-right corner of the emulator window, just below the keypad button on the menu bar

Name: x3270.keypad.keyHeight
Type: Integer
Default: 24
Description:

The height in pixels of all of the buttons on the keypad.

Name: x3270.keyPasswd
Type: String
Command Line: -keypasswd
Description:

Gives the password for the private key file specified by x3270.keyFile, if it is encrypted. The value can take one of two forms. file:filename specifies that the password is in a file. string:string gives the password value in the resource itself.

Name: x3270.keyWidth
Type: Integer
Default: 48
Description:

The width in pixels of the lower tier of buttons on a horizontal keypad.

Name: x3270.keypad.largeKeyWidth
Type: Integer
Default: 56
Description:

The width in pixels of the lower tier of buttons on a vertical keypad.

Name: x3270.keypad.paWidth
Type: Integer
Default: 36
Description:

The width in pixels of PA and cursor keys on the keypad.

Name: x3270.keypad.pfWidth
Type: Integer
Default: 32
Description:

The width in pixels of PF keys on the keypad.

Name: x3270.keypadBackground
Type: String
Default: grey70
Description:

On color X11 displays, this is the color of the empty area behind the buttons on the main window and keypad window. On monochrome X11 displays, these areas are filled with a 50% grey bitmap.

Name: x3270.keypadOn
Type: Boolean
Default: false
Description:

If true, the keypad will automatically appear when x3270 is started.

Name: x3270.kill
Type: String
Default: ^U
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name.

When connected in line-at-a-time mode (when x3270 gathers a line of input before forwarding it to the host), entering this character at the keyboard causes the current input line to be erased.

When connected in character-at-a-time mode (when x3270 sends each keystroke to the host), this is the ASCII character that is sent to the host by the DeleteField action.

Name: x3270.labelIcon
Type: Boolean
Default: false
Description:

When x3270.activeIcon is true, the twm window manager will not put a label on x3270's icon. Setting x3270.labelIcon to true causes x3270 to supply its own label for the icon.

The icon label is drawn using the font specified by x3270.iconLabelFont.

Name: x3270.largeKeyWidth
Type: Integer
Default: 56
Description:

Defines the width of the "large" keys in the lower section of the pop-up keypad.

Name: x3270.lineWrap
Type: Boolean
Default: true
Command Line: -set lineWrap , -clear lineWrap
Option: Options -> Toggles -> Wraparound
Description:

This setting is used only in NVT mode. When true, x3270 will automatically insert a CR/LF sequence when output reaches the end of a line. When false, output will pile up at the end of each line until the host sends a CR/LF sequence.

Name: x3270.loginMacro
Type: String
Description:

Defines a sequence of commands to run as soon as a host connection is established. Usually these would be commands used to navigate through login screens, such String, Tab and Enter.

If a x3270.hostsFile is in use and a matching entry is found, the login macro from that entry will be used in preference to the x3270.loginMacro.

Name: x3270.lnext
Type: String
Default: ^V
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name.

When connected in line-at-a-time mode (when x3270 gathers a line of input before forwarding it to the host), entering this character at the keyboard removes any special meaning from the next character entered.

Name: x3270.lockedCursor
Type: String
Default: X_cursor
Description:

The name of the mouse cursor displayed with x3270 is not connected to a host.

Name: x3270.m3279
Type: Boolean
Default: false
Command Line: -color
Description:

Deprecated resource -- replaced by x3270.model syntax

Indicates support for color (a 3279 terminal).

Name: x3270.macros
Type: String
Description:

Defines a set of macros assigned to the Macros menu that appears when connected to a host. The syntax is similar to a keymap (an X11 translation table), except that rather than a keysym name, the left-hand side is a name that will appear on the menu. A list of actions can be specified on the right-hand side.

x3270.macros defines a set of macros for all hosts. To specify a set of macros for host foo, use x3270.macros.foo.

Name: x3270.macros.foo
Type: String
Description:

Defines a set of macros assigned to the Macros menu that appears when connected to host foo. It overrides the contents of x3270.macros. See x3270.macros for details on its syntax.

Name: x3270.marginedPaste
Type: Boolean
Default: false
Command Line: -set marginedPaste , -clear marginedPaste
Option: Options -> Toggles -> Paste With Left Margin
Description:

When true, x3270 will use the current cursor position as a left margin for pasted data: no pasted data will be input into an area to the left of the current cursor positon.

Name: x3270.menuBar
Type: Boolean
Default: true
Description:

If false, the menu bar will not be displayed at the top of the x3270 main window. The three pull-down menus are still available, however, by pressing Ctrl and each of the mouse buttons.

Name: x3270.model
Type: String
Default: 3279-4-E
Command Line: -model
Option: Options -> Screen Size
Description:

The terminal model that x3270 is emulating. The model is in three parts, separated by dashes; each part is optional.

- 3278 or 3279
  3278 specifies a monochrome (green) 3270 display. If used on a color X11 display, it will cause all fields to be drawn in green. 3278 is the default for monochrome X11 displays.
  3279 specifies a color 3270 display. This is the default for color X11 displays.
- 2, 3, 4 or 5 The model number, which determines the size of the screen. Model 2 has 24 rows and 80 columns. Model 3 has 32 rows and 80 columns. Model 4 has 43 rows and 80 columns. Model 5 has 27 rows and 132 columns. The default is 4.
- E An optional suffix which indicates support for the 3270 Extended Data Stream (color, extended attributes, Query Reply). 3279 implies E.

Name: x3270.modifiedSel
Type: Boolean
Default: false
Description:

When true, modified fields are displayed in a different color than other modifiable fields. In 3278 mode, this color is the "input" (light pen selectable) color, defined by x3270.inputColor. In 3279 mode, this is the color whose index is defined by x3270.modifiedSelColor. When x3270.modifiedSel is false, modified fields are displayed in the same colors as unmodified fields.

Name: x3270.modifiedSelColor
Type: Integer
Default: 10
Description:

In 3279 mode, when x3270.modifiedSel is true, this is index of the host color used to display modified fields. The default value of 10 corresponds to "orange". (See x3270.colorSchemes for the host color index definitions.)

Name: x3270.mono
Type: Boolean
Default: false
Command Line: -mono
Description:

If true, x3270 will operate as if it were running on a monochrome X11 display.

Name: x3270.monoCase
Type: Boolean
Default: false
Command Line: -set monoCase , -clear monoCase
Option: Options -> Toggles -> Monocase
Description:

When true, causes x3270 to run in uppercase-only mode.

Name: x3270.noOther
Type: Boolean
Default: false
Description:

If true, the "Other" options are disabled for selecting fonts and connecting to hosts, limiting users to the options provided on the menus.

Name: x3270.normalCursor
Type: String
Default: top_left_arrow
Description:

Defines the mouse cursor that x3270 uses when it is connected to a host, not waiting for the host to complete a command, and the keyboard is not locked.

Name: x3270.numericLock
Type: Boolean
Default: false
Description:

When true, causes x3270 to lock the keyboard when non-numeric data is entered into fields with the Numeric attribute.

Name: x3270.normalColor
Type: String
Default: green
Description:

On color X11 displays in 3278 mode, this is the color of normal-intensity text. On monochrome X11 displays, normal text uses the foreground color.

Name: x3270.onlcr
Type: Boolean
Default: true
Description:

Used only in NVT line-at-a-time mode; similar to the stty parameter of the same name. It controls whether output newlines are mapped to CR/LF sequences.

Name: x3270.oerrLock
Type: Boolean
Default: true
Description:

If true, operator errors (typing into protected fields, insert overflow, etc.) will cause the keyboard to lock with an error message in the OIA (status line). If false, these errors will simply cause the terminal bell will ring, without any keyboard lock or message.

Name: x3270.once
Type: Boolean
Default: false
Command Line: -once
Description:

When true, x3270 will exit as soon as a host disconnects. The default is false if no hostname is specified on the command line or in a session file, true otherwise.

Name: x3270.oversize
Type: String
Command Line: -oversize
Description:

Sets the screen dimensions to be larger than the default for the chosen model. Its value is a string in the format colsxrows. It is used only if the x3270.model includes the "-E" (extended data stream) suffix, and only if the specified dimensions are larger than the model number defaults. Also, only hosts that support the Query Reply structured field will function properly with x3270 in this mode.

Name: x3270.paWidth
Type: Integer
Default: 36
Description:

Defines the width of the PA keys in the lower section of the pop-up keypad.

Name: x3270.pfWidth
Type: Integer
Default: 32
Description:

Defines the width of the PF keys on the pop-up keypad.

Name: x3270.port
Type: String
Default: telnet
Command Line: -port
Description:

The name of the default TCP port for x3270 to connect to. This can be either a symbolic name from /etc/services, or an integer.

Name: x3270.proxy
Type: String
Command Line: -proxy
Description:

Defines a proxy server that x3270 will use to connect to hosts. The value is of the form type:server[:port], where options for type are described on the x3270 manual page.

Name: x3270.preeditType
Type: String
Default: OverTheSpot+1
Command Line: -pt
Description:

The preedit type for the multi-byte input method. Valid values are OverTheSpot, OffTheSpot, Root and OnTheSpot. The value for OverTheSpot can include an optional suffix, a signed number indicating the vertical distance in rows of the preedit window from the cursor position, e.g. OverTheSpot+1 or OverTheSpot-2.

Name: x3270.printerLu
Type: String
Command Line: -printerlu
Description:

If a value is set, x3270 will automatically start a pr3287 printer session when a host connection is established. If the value is ".", the pr3287 session will be associated with the interactive terminal session (this requires that the host supports TN3270E). Otherwise, the value is taken as the LU name to associate with the printer session.

Name: x3270.printer.assocCommandLine
Type: String
Default: pr3287 -assoc %L% -command %C% %R% %P% %V% %O% %H%
Description:

The shell command to use to start a printer session, when associated with the current TN3270E session LU (when x3270.printerLU is "."). Within the string, the following substitutions are made:

- %C% is replaced with the x3270.printer.command
- %H% is replaced with the current host name
- %L% is replaced with the current session's LU
- %O% is replaced with the value of x3270.printer.options
- %P% is replaced with the current session's proxy option (x3270.proxy)
- %R% is replaced with an option to pass the current character set
- %V% is replaced with SSL-related options

Name: x3270.printer.command
Type: String
Default: lpr
Description:

The name of the command supplied to the "-command" option of the pr3287 program to print each job. This is the text which is substituted for %C in x3270.printer.assocCommandLine and x3270.printer.luCommandLine resources.

Name: x3270.printer.luCommandLine
Type: String
Default: pr3287 -command %C% %R% %P% %V% %O% %L%@%H%
Description:

The shell command to use to start a printer session, when associated with a specific LU. Within the string, the following substitutions are made:

- %C% is replaced with x3270.printer.command
- %H% is replaced with the current host name
- %L% is replaced with the LU value entered into the dialog box
- %O% is replaced with the value of x3270.printer.options
- %P% is replaced with current session's proxy option (x3270.proxy)
- %R% is replaced with an option to pass the current character set
- %V% is replaced with SSL-related options

Name: x3270.printer.options
Type: String
Description:

Defines extra parameters to substutute for the %O% token in the printer command line.

Name: x3270.printTextCommand
Type: String
Default: lpr
Description:

The shell command used by the PrintText action. An ASCII image of the 3270 display becomes the standard input to this command. If the first character of the command is '@', the usual pop-up windows before and after the text is printed will not appear.

Name: x3270.printWindowCommand
Type: String
Default: xwd -id %d | xpr | lpr
Description:

The shell command used by the PrintWindow action. The X11 window identifier of the main x3270 window is substituted for any %d in the command. If the first character of the command is '@', the usual pop-up windows before and after the window is printed will not appear.

Name: x3270.quit
Type: String
Default: ^\
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name. When connected in line-at-a-time mode (when x3270 gathers a line of input before forwarding it to the host), entering this character at the keyboard causes the TELNET BREAK sequence to be sent to the host.

Name: x3270.reconnect
Type: Boolean
Default: false
Description:

When true, x3270 will automatically reconnect to a host after it disconnects.

Name: x3270.rectangleSelect
Type: Boolean
Default: false
Command Line: -set rectangleSelect , -clear rectangleSelect
Option: Options -> Toggles -> Select by Rectangles
Description:

When true, x3270 will always select rectangular areas of the screen. When false, x3270 will select rectangular areas in 3270 mode, but in NVT mode it will select continuous areas of the screen like xterm.

Name: x3270.rprnt
Type: String
Default: ^R
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name. When connected in line-at-a-time mode (when x3270 gathers a line of input before forwarding it to the host), entering this character at the keyboard causes the current input line to be redisplayed.

Name: x3270.saveLines
Type: Integer
Default: 64
Command Line: -sl
Description:

The number of display lines to save for the scroll bar.

Name: x3270.sbcsCgcsgid
Type: String
Description:

Overrides the compiled-in value of the CGCSGID for the current host character set. The value is an integer, which can be prefixed with '0x' to be in hexadecimal. The upper 16 bits are the GCSGID (character set) and the lower 16 bits are the CPGID (code page). This value applies only to the single-byte (SBCS) character set. Use x3270.dbcsCgcsgid for the double-byte (DBCS) character set.

Name: x3270.schemeList
Type: String
Description:

Lists the options on the Color Scheme menu. Can contain '>' characters to indicate a menu hierarchy. See the file X3270.xad for an example.

Name: x3270.screenTrace
Type: Boolean
Default: false
Command Line: -set screenTrace , -clear screenTrace
Option: File -> Save Screen(s) in File
Description:

When true, x3270 will save an ASCII version of the screen image in a file every time it changes. The file name defaults to /tmp/x3scr.pid. The directory prefix is defined by x3270.traceDir. If x3270.screenTraceFile is defined, it defines the file name and x3270.traceDir is ignored.

Name: x3270.screenTraceFile
Type: String
Description:

If defined, gives the name of the file that screen traces will be written into.

Name: x3270.scripted
Type: Boolean
Default: false
Command Line: -script
Description:

When true, x3270 will read commands from standard input. The rules for these commands are documented in the x3270-script manual page.

Name: x3270.scriptPort
Type: Integer
Command Line: -scriptport
Description:

If defined, x3270 will accept script connections on the specified local TCP port. The rules for the commands passed over these connections are documented in the x3270-script manual page.

Name: x3270.scrollBar
Type: Boolean
Default: false
Command Line: -sb , +sb , -set scrollBar , -clear scrollBar
Description:

When true, x3270 will display a scroll bar to the right of the emulator window.

Name: x3270.secure
Type: Boolean
Default: false
Description:

When true, x3270 will prevent users from executing arbitrary commands from within the program. In particular, the File -> Execute an Action menu option is disabled, as are the pop-ups which allow editing the commands for File -> Print Screen Text and File -> Print Window Bitmap, and x3270.disconnectClear is true. See x3270.noOther and x3270.suppressActions for additional security options.

Name: x3270.selectBackground
Type: String
Default: dimGrey
Description:

On color X11 displays, this is the background color used for selected text (text highlighted with the mouse for cut and paste). On monochrome X11 displays, selected text is in reverse video.

Name: x3270.selfSignedOk
Type: Boolean
Default: false
Description:

When true, x3270 will allow SSL authentication with a host that uses a self-signed certificate.

Name: x3270.showTiming
Type: Boolean
Default: false
Command Line: -set showTiming , -clear showTiming
Option: Options -> Toggles -> Show Timing
Description:

When true, x3270 will display on the OIA (status line) the time that the host takes to unlock the keyboard after an AID is sent.

Name: x3270.socket
Type: Boolean
Default: false
Command Line: -socket
Description:

When true, x3270 will create a Unix-domain socket than can be used by an external script to control the session. The name of the socket is /tmp/x3sck.pid. The -p option of the x3270if command can be used to connect to this socket.

Name: x3270.*suppress
Type: Boolean
Description:

When true, suppresses a menu item. For example, setting x3270*executeActionOption.suppress to true will remove the Execute an Action option on the File menu. The names of the menu items generally end in 'Option' and have label resources in X3270.xad.

Name: x3270.suppressActions
Type: String
Description:

A list of whitespace-separated action names, with or without parentheses, which are to be ignored. The actions will be completely inaccessible, whether by keymaps, scripts, macros or the Execute an Action menu option. This resource is intended to be used as a security precaution for users who can define their own keymaps, but who do not have access to resource definitions or command-line options.

Name: x3270.suppressFontMenu
Type: Boolean
Default: false
Description:

If true, the Options -> Font menu will not be displayed.

Name: x3270.suppressHost
Type: Boolean
Default: false
Description:

If true, x3270 will omit the hostname from the File -> About x3270 -> Connection Status pop-up.

Name: x3270.termName
Type: String
Command Line: -tn
Description:

An alternate name to be sent in response to the host's TELNET DO OPTION TERMINAL-NAME request. The default is IBM-, followed by the value of x3270.model.

Name: x3270.title
Type: String
Command Line: -title
Description:

Sets the title for the x3270 window, overriding the default of constructing the name from the host that is connected to.

Name: x3270.traceCommand
Type: String
Default: tail -f
Description:

Defines the command that runs in the trace window.

Name: x3270.traceDir
Type: String
Default: /tmp
Description:

Defines the directory that trace files are written into.

Name: x3270.traceFile
Type: String
Command Line: -tracefile
Description:

If defined, gives the name of the file that data stream and event traces will be written into. If it begins with ">>", data will be appended to the file. If given the value stdout, traces will be written to standard output. If given the value none, then the traces will be piped directory to the monitor window, and no file will be created.

Name: x3270.traceFileSize
Type: String
Command Line: -tracefilesize
Description:

If defined, gives a limit on the size of the file that data stream and event traces will be written into. If not defined, or defined as 0, there will be no limit on the size of the file. The value is a number, followed by an optional suffix. If the suffix is K (e.g., 128K), the value will be multiplied by 1024. If the suffix is M, the value will be multiplied by (1024*1024). The size limit enforced at operation boundaries, not per byte, so the actual file may grow slightly larger. When the file size exceeds the limit, the trace file will be renamed with a "-" appended and a new file started.

Name: x3270.traceMonitor
Type: Boolean
Default: true
Description:

When true, x3270 will create a window to monitor data stream and event traces. When false, no monitor window will be created (and the value of none for x3270.traceFile will be considered invalid).

Name: x3270.unlockDelay
Type: Boolean
Default: true
Description:

When x3270 sends the host an AID (the Enter, Clear, PF or PA actions), it locks the keyboard until the host sends a reply to unlock it. Some hosts unlock the keyboard before they are actually finished processing the command, which can cause scripts to malfunction subtly. To avoid this, x3270 implements a hack to briefly delay actually unlocking the keyboard. When x3270.unlockDelay is true, the keyboard unlock will be delayed for x3270.unlockDelayMs milliseconds. Setting it to false removes this delay, except when executing a macro.

Name: x3270.unlockDelayMs
Type: Integer
Default: 350
Description:

Overrides the default value for the unlock delay (the delay between the host unlocking the keyboard and x3270 actually performing the unlock). The value is in milliseconds; use 0 to turn off the delay completely, including for macros.

Name: x3270.useCursorColor
Type: Boolean
Default: false
Description:

If false, the cursor will be drawn using the same color as the text behind it. If true, on color X11 displays the cursor will be drawn with the color specified by x3270.cursorColor.

Name: x3270.user
Type: String
Command Line: -user
Description:

Specifies the user name sent in response to a TELNET NEW-ENVIRON sub-negotiation request, used by iSeries hosts (RFC 4777).

Name: x3270.verifyHostCert
Type: Boolean
Default: false
Command Line: -verifycert
Description:

If false (the default), x3270 will not verify SSL host certificates. If true or if the -verifycert option is given, x3270 will verify SSL host certificates, and not allow an SSL or SSL/TLS connection to complete unless the host certificate can be validated.

Name: x3270.visibleControl
Type: Boolean
Default: false
Command Line: -set visibleControl , -clear visibleControl
Option: Options -> Toggles -> Visible Control Characters
Description:

If true, control characters will be displayed on the screen (normally they are blank). Control characters, displayed with underlines, are as follows:

- <: The EBCDIC SO character (begins a DBCS subfield)
- >: The EBCDIC SI character (ends a DBCS subfield)
- P: The start of a protected field
- M: The start of a modified field
- U: The start of an unprotected field
- .: The EBCDIC NUL character

Name: x3270.visualBell
Type: Boolean
Default: false
Description:

When true, x3270 will flash the screen in response to an ALARM WCC or BELL character, rather than ringing the terminal's bell.

Name: x3270.visualSelect
Type: Boolean
Default: false
Description:

This resource controls how x3270 displays light pen selectable fields that do not have a color explicitly set by the host. When true, x3270 will display these fields using the color defined by x3270.visualSelectColor. When false, x3270 will display these fields based on their highlighting attribute. This attribute is used only in 3279 mode.

Name: x3270.visualSelectColor
Type: Integer
Default: 6
Description:

The host color index of the color to use to display light pen selectable fields. This resource is used only if x3270.visualSelect is true. The default is 6 (yellow).

Name: x3270.waitCursor
Type: String
Default: watch
Description:

The name of the mouse cursor displayed when x3270 is connected to a host, but is unable to process keyboard input. Cursor names are in the file <X11/cursorfont.h>.

Name: x3270.werase
Type: String
Default: ^W
Description:

This setting is used only in NVT mode, and is similar in function to the stty parameter of the same name. When connected in line-at-a-time mode (when x3270 gathers a line of input before forwarding it to the host), entering this character at the keyboard erases the last word of input.

When connected in character-at-a-time mode (when x3270 sends each keystroke to the host), this is the ASCII character that is sent to the host by the DeleteWord action.

## Index of All Resources

activeIcon | aidWait | allowResize | altCursor
aplMode | background | bellVolume | bindLimit
blankFill | boldColor | bsdTm | caDir
caFile | certFile | certFileType | chainFile
charClass | charset | charsetList | color8
colorBackground | colorScheme | colorScheme.foo | composeMap
composeMap.foo | confDir | connectFileName | crosshair
cursorBlink | cursorColor | cursorPos | dbcsCgcsgid
debugTracing | dftBufferSize | devName | disconnectClear
doConfirms | dsTrace | emulatorFont | emulatorFontList.foo
eof | erase | eventTrace | extended
fixedSize | foreground | highlightBold | hostname
hostsFile | iconFont | iconLabelFont | icrnl
idleCommand | idleCommandEnabled | idleTimeout | inlcr
inputColor | inputMethod | intr | invertKeypadShift
keyFile | keyFileType | keyHeight | keymap
keymap.foo | keypad | keypad.keyHeight | keyPasswd
keyWidth | keypad.largeKeyWidth | keypad.paWidth | keypad.pfWidth
keypadBackground | keypadOn | kill | labelIcon
largeKeyWidth | lineWrap | loginMacro | lnext
lockedCursor | m3279 | macros | macros.foo
marginedPaste | menuBar | model | modifiedSel
modifiedSelColor | mono | monoCase | noOther
normalCursor | numericLock | normalColor | onlcr
oerrLock | once | oversize | paWidth
pfWidth | port | proxy | preeditType
printerLu | printer.assocCommandLine | printer.command | printer.luCommandLine
printer.options | printTextCommand | printWindowCommand | quit
reconnect | rectangleSelect | rprnt | saveLines
sbcsCgcsgid | schemeList | screenTrace | screenTraceFile
scripted | scriptPort | scrollBar | secure
selectBackground | selfSignedOk | showTiming | socket
*suppress | suppressActions | suppressFontMenu | suppressHost
termName | title | traceCommand | traceDir
traceFile | traceFileSize | traceMonitor | unlockDelay
unlockDelayMs | useCursorColor | user | verifyHostCert
visibleControl | visualBell | visualSelect | visualSelectColor
waitCursor | werase

## Basic Configuration Resources

charset | hostname | keymap | model
port | proxy | printerLu

## Appearance Resources

activeIcon | altCursor | background | boldColor
colorBackground | colorScheme | colorScheme.foo | crosshair
cursorBlink | cursorColor | cursorPos | emulatorFont
fixedSize | foreground | highlightBold | iconFont
iconLabelFont | inputColor | keyHeight | keypad
keypad.keyHeight | keyWidth | keypad.largeKeyWidth | keypad.paWidth
keypad.pfWidth | keypadBackground | labelIcon | largeKeyWidth
lockedCursor | menuBar | modifiedSel | modifiedSelColor
normalCursor | normalColor | paWidth | pfWidth
selectBackground | showTiming | title | useCursorColor
visualSelect | visualSelectColor | waitCursor

## NVT-Mode Resources

eof | erase | icrnl | inlcr
intr | kill | lineWrap | lnext
onlcr | quit | rprnt | werase

## Protocol Resources

bindLimit | bsdTm | color8 | dbcsCgcsgid
dftBufferSize | devName | sbcsCgcsgid | termName
user

## Terminal Interaction Resources

blankFill | idleCommand | idleCommandEnabled | idleTimeout
marginedPaste | numericLock | oerrLock | rectangleSelect
visualBell

## Security Resources

caDir | caFile | certFile | certFileType
chainFile | debugTracing | keyFile | keyFileType
keyPasswd | noOther | secure | selfSignedOk
*suppress | suppressActions | verifyHostCert

## Tracing Resources

debugTracing | dsTrace | eventTrace | screenTrace
screenTraceFile | traceDir | traceFile | traceFileSize
traceMonitor

## Other Resources

aidWait | allowResize | aplMode | bellVolume
charClass | charsetList | composeMap | composeMap.foo
confDir | connectFileName | disconnectClear | doConfirms
emulatorFontList.foo | hostsFile | inputMethod | invertKeypadShift
keymap.foo | keypadOn | loginMacro | macros
macros.foo | mono | monoCase | once
oversize | preeditType | printer.assocCommandLine | printer.command
printer.luCommandLine | printer.options | printTextCommand | printWindowCommand
reconnect | saveLines | schemeList | scripted
scriptPort | scrollBar | socket | suppressFontMenu
suppressHost | traceCommand | unlockDelay | unlockDelayMs
visibleControl

## Deprecated Resources

extended | m3279

x3270 version 3.3.12ga12 Tue Feb 26 13:46:41 CST 2013