# wb3270 Resources

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

Resource definitions come from the following sources:

- Default values are compiled into wb3270.
- If a session file foo.wb3270 is specified on the command line, its contents are applied. These definitions override resource values defined by 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 wb3270.bsdTm can be set by the following command-line option:

         -xrm "wb3270.bsdTm: true"

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

## Resource File Syntax

A resource file (session file) has the following syntax.

- Each definition consists of:

          wb3270.resource-name: value

- Comment lines begin with !.
- Line continuation is indicated by a backshash (\) character at the end of a line.

## Alphabetical Resource List

Name: wb3270.acceptHostname
Type: String
Command Line: -accepthostname
Description:

Defines a specific name to accept when validating the name presented in the server's SSL/TLS certificate, instead of using the name used to make the connection. (The form DNS:name is also accepted for backwards compatibility.)

Name: wb3270.alwaysInsert
Type: Boolean
Default: false
Description:

When true, wb3270 will set insert mode by default, and insert mode can only be disabled by the ToggleInsert() action.

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

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

Name: wb3270.bindUnlock
Type: Boolean
Default: false
Description:

When true, wb3270 will unlock the keyboard as soon as the host sends a BIND image. Otherwise, it will wait until the host sends a Write command.

Note that in some previous releases, unlocking as soon as the BIND image was recevied was the default, and this behavior could be overridden (forcing wb3270 to wait for the Write) by the B: option on the hostname. Since waiting for the Write is now the default, B: is still supported as a no-op.

Name: wb3270.blankFill
Type: Boolean
Default: true
Command Line: -set blankFill , -clear blankFill
Description:

When true, in 3270 mode wb3270 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: wb3270.bsdTm
Type: Boolean
Default: false
Description:

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

Name: wb3270.clientCert
Type: String
Command Line: -clientcert
Description:

Gives the name of a client certificate, provided during SSL/TLS negotiation. The certificate is searched for in the Personal store.

Name: wb3270.codepage
Type: String
Default: bracket
Command Line: -codepage
Description:

This defines the host EBCDIC code page, 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.

To display the code pages supported by wb3270, use the -v command-line option or the Query(CodePages) action.

Name: wb3270.confDir
Type: String
Default: .
Description:

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

The default is to search the directory where wb3270 was started, which usually its installation directory.

Name: wb3270.connectTimeout
Type: Integer
Command Line: -connecttimeout
Description:

Specifies a timeout, in seconds, that wb3270 will wait for a host connection to complete. If this is not set, the timeout will be determined by the operating system. Note that wb3270 will wait for the lesser of the two times (the specified timeout and the system-defined timeout).

Name: wb3270.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 wb3270.sbcsCgcsgid for the single-byte (SBCS) character set.

Name: wb3270.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: wb3270.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 wb3270 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: wb3270.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 (wb3270 gathers a line of input before forwarding it ot the host), entering this character at the keyboard will cause wb3270 to discard the last character on the input line.

When connected in character-at-a-time mode (wb3270 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: wb3270.ftAllocation
Type: String
Default: default
Description:

Defines the default allocation type for files sent to TSO hosts by IND$FILE file transfers. Possible values are default, which lets the host decide the allocation type, or tracks, cylinders, or avblock.

Name: wb3270.ftAvblock
Type: Integer
Description:

Defines the default AVBOCK (average block) allocation size for files sent to TSO hosts by IND$FILE file transfers.

Name: wb3270.ftBlksize
Type: Integer
Description:

Defines the default block size for files sent to TSO hosts by IND$FILE file transfers.

Name: wb3270.ftBufferSize
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: wb3270.ftCr
Type: String
Default: auto
Description:

Defines the default action for line separators (carriage returns and line feeds) in ASCII files during IND$FILE file transfers. The value can be auto, which will add them when files are received from the host and remove them when they are sent to the host, add (same as auto), remove (same as auto), or keep, meaning no special processing is done.

Name: wb3270.ftDirection
Type: String
Default: receive
Description:

Defines the default IND$FILE file transfer direction, from the perspective of the workstation. The value can be either send (send file from workstation to host) or receive (receive file from host to workstation).

Name: wb3270.ftExist
Type: String
Default: keep
Description:

Defines the default behavior for IND$FILE file transfers when the destination file already exists. The value keep means that the transfer will be aborted, replace means that the file will be overwritten unconditionally, and append means that the new file will be appended to the old file.

Name: wb3270.ftHost
Type: String
Default: tso
Description:

Defines the default host type for IND$FILE file transfers. The value can be vm, tso or cics.

Name: wb3270.ftHostFile
Type: String
Description:

Defines the default host file name for IND$FILE file transfers.

Name: wb3270.ftLocalFile
Type: String
Description:

Defines the default local file name for IND$FILE file transfers.

Name: wb3270.ftLrecl
Type: Integer
Description:

Defines the default logical record length for files sent to the host via IND$FILE.

Name: wb3270.ftMode
Type: String
Default: ascii
Description:

Defines the default mode for IND$FILE file transfers: ascii (text, with translation between the workstation's code page and EBCDIC), or binary (no translation).

Name: wb3270.ftPrimarySpace
Type: Integer
Description:

Defines the default primary space allocation for files sent to TSO hosts via IND$FILE.

Name: wb3270.ftRecfm
Type: String
Default: default
Description:

Defines the default record format for files sent to the host using IND$FILE. Possibe values are default, fixed, variable, and undefined. The default value of 'default' lets IND$FILE choose an appropriate format.

Name: wb3270.ftRemap
Type: String
Default: yes
Description:

Defines the default mapping behavior for ASCII files transferred with IND$FILE. When set to yes, ASCII files are translated by wb3270 to produce as accurate a mapping as possible between the workstation's code page and the host's EBCDIC code page. When set to no, only the fixed translation built into the IND$FILE application is run, which (roughly) maps ISO 8859-1 to host code page 37.

Name: wb3270.ftSecondarySpace
Type: Integer
Description:

Defines the default secondary space allocation for files sent to TSO hosts via IND$FILE.

Name: wb3270.ftWindowsCodePage
Type: Integer
Description:

The Windows code page to use for translating between EBCDIC and ASCII in IND$FILE file transfers. The default is to use the system ANSI code page. This value can be overridden in the File Transfer dialog and by a parameter to the Transfer action.

Name: wb3270.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 wb3270.hostname.

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

Name: wb3270.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: wb3270.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: wb3270.insertMode
Type: Boolean
Default: false
Description:

Controls 3270 insert mode.

Name: wb3270.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: wb3270.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 wb3270 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 wb3270 sends each keystroke to the host), this is the ASCII character that is sent to the host by the DeleteField action.

Name: wb3270.lineWrap
Type: Boolean
Default: true
Command Line: -set lineWrap , -clear lineWrap
Description:

This setting is used only in NVT mode. When true, wb3270 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: wb3270.loginMacro
Type: String
Command Line: -loginmacro
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 wb3270.hostsFile is in use and a matching entry is found, the login macro from that entry will be used in preference to the wb3270.loginMacro.

Name: wb3270.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 wb3270 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: wb3270.model
Type: String
Default: 3279-4-E
Command Line: -model
Description:

The terminal model that wb3270 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.
  3279 specifies a color 3270 display.
- 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: wb3270.monoCase
Type: Boolean
Default: false
Command Line: -set monoCase , -clear monoCase
Description:

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

Name: wb3270.newEnviron
Type: Boolean
Default: true
Description:

If true, wb3270 will respond to the TELNET NEW-ENVIRONMENT option. If false, it will not.

Name: wb3270.nopSeconds
Type: Integer
Description:

If nonzero, wb3270 will send a TELNET NOP to the host every n seconds. This can be used to keep host sessions running that would otherwise be terminated due to inactivity.

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

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

Name: wb3270.nvtMode
Type: Boolean
Default: false
Command Line: -nvt
Description:

When true, causes wb3270 to start immediately in NVT mode and allow keyboard input immediately, instead of waiting for the host to send data or negotiate 3270 mode. It also causes the default terminal type to be xterm.

NVT mode can also be selected per session by prepending an A: onto the hostname.

Name: wb3270.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: wb3270.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: wb3270.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 wb3270.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 wb3270 in this mode.

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

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

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

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

Name: wb3270.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 wb3270 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: wb3270.reverseInputMode
Type: Boolean
Default: false
Description:

When true in 3270 mode, input fields fill in the opposite direction of the screen display.

Name: wb3270.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 wb3270 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: wb3270.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 wb3270.dbcsCgcsgid for the double-byte (DBCS) character set.

Name: wb3270.screenTrace
Type: Boolean
Default: false
Command Line: -set screenTrace , -clear screenTrace
Description:

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

Name: wb3270.screenTraceFile
Type: String
Description:

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

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

If defined, wb3270 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. The syntax of this resource is [address:]port, where address is an IPv4 or IPv6 address such as 127.0.0.1 or 0.0.0.0, and port is a TCP port such as 4081. The address can also be specified as * to indicate 0.0.0.0. A numeric IPv6 address must be enclosed in square brackets, e.g., [1234:5678::3], to avoid ambiguity between the colons inside the address and the colon separating the address from the port. If no address is specified, it defaults to 127.0.0.1.

Name: wb3270.scriptPortOnce
Type: Boolean
Default: false
Command Line: -scriptportonce
Description:

If defined, wb3270 will accept only one script connection. When that connection is broken, it will exit.

Name: wb3270.startTls
Type: Boolean
Default: true
Description:

If true, wb3270 will accept the TELNET STARTTLS negotiation from the host. If false, it will reject them.

Name: wb3270.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 at the prompt. 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: wb3270.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 wb3270.model.

Name: wb3270.trace
Type: Boolean
Default: false
Command Line: -trace , -set trace , -clear trace
Description:

When true, wb3270 writes information about events and actions, as well as a hexadecimal representation of all network traffic (and its interpretation) into a file, which defaults to x3trc.process-id.txt. The directory where the file is written is defined by wb3270.traceDir. If wb3270.traceFile is defined, it gives the entire pathname and wb3270.traceDir is ignored.

Name: wb3270.traceDir
Type: String
Description:

Defines the directory that trace files are written into.

Name: wb3270.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.

Name: wb3270.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: wb3270.unlockDelayMs
Type: Integer
Default: 350
Description:

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

Name: wb3270.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: wb3270.verifyHostCert
Type: Boolean
Default: true
Command Line: -noverifycert , -verifycert
Description:

If true (the default), wb3270 will verify SSL/TLS host certificates, and not allow an SSL/TLS connection to complete unless the host certificate can be validated. If false, wb3270 will not verify SSL/TLS host certificates.

This resource is overridden by a y: prepended to the hostname when connecting, which disables certificate checking.

Name: wb3270.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 wb3270 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 wb3270 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

acceptHostname | alwaysInsert | bindLimit | bindUnlock
blankFill | bsdTm | clientCert | codepage
confDir | connectTimeout | dbcsCgcsgid | devName
eof | erase | ftAllocation | ftAvblock
ftBlksize | ftBufferSize | ftCr | ftDirection
ftExist | ftHost | ftHostFile | ftLocalFile
ftLrecl | ftMode | ftPrimarySpace | ftRecfm
ftRemap | ftSecondarySpace | ftWindowsCodePage | hostname
icrnl | inlcr | insertMode | intr
kill | lineWrap | loginMacro | lnext
model | monoCase | newEnviron | nopSeconds
numericLock | nvtMode | onlcr | oerrLock
oversize | port | proxy | quit
reverseInputMode | rprnt | sbcsCgcsgid | screenTrace
screenTraceFile | scriptPort | scriptPortOnce | startTls
suppressActions | termName | trace | traceDir
traceFile | traceFileSize | unlockDelayMs | user
verifyHostCert | werase

## Basic Configuration Resources

codepage | connectTimeout | hostname | model
port | proxy

## NVT-Mode Resources

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

## Protocol Resources

bindLimit | bindUnlock | bsdTm | dbcsCgcsgid
devName | ftBufferSize | sbcsCgcsgid | termName
user

## Terminal Interaction Resources

blankFill | ftAllocation | ftAvblock | ftBlksize
ftCr | ftDirection | ftExist | ftHost
ftHostFile | ftLocalFile | ftLrecl | ftMode
ftPrimarySpace | ftRecfm | ftRemap | ftSecondarySpace
ftWindowsCodePage | nopSeconds | numericLock | nvtMode
oerrLock

## Security Resources

acceptHostname | clientCert | startTls | suppressActions
verifyHostCert

## Tracing Resources

screenTrace | screenTraceFile | trace | traceDir
traceFile | traceFileSize

## Other Resources

alwaysInsert | confDir | insertMode | loginMacro
monoCase | newEnviron | oversize | reverseInputMode
scriptPort | scriptPortOnce | unlockDelayMs

wb3270 version 4.0ga10 Tue Jul 7 11:17:49 CDT 2020