Resource definitions come from the following sources:
-xrm 'ws3270.bsdTm: true'Note that -xrm is supported on all of the 3270 emulators, not just on x3270.
ws3270.resource-name: value
Defines a specific name to accept when validating the name presented in the server's SSL certificate, instead of using the name or IP address used to make the connection. Takes one of three forms: any, which disables name checking, DNS:name, which specifies a DNS hostname, and IP:address, which specifies a numeric IPv4 or IPv6 address.
Name: ws3270.bindLimitWhen true, ws3270 will restrict its screen dimensions to those specified in the BIND image sent by the host. If false, it will not.
Name: ws3270.blankFillWhen true, in 3270 mode ws3270 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: ws3270.bsdTmDefines ws3270's response to the TELNET DO TIMING MARK option. When set to false, ws3270 will respond to DO TIMING MARK with WONT TIMING MARK, which is consistent with most modern TELNET clients. When true, ws3270 will respond with WILL TIMING MARK, which is consistent with the old BSD telnet command and with previous versions of ws3270. In either case, ws3270 will never respond to a DONT TIMING MARK option.
Name: ws3270.caDirDefines a directory containing CA (root) certificates, used to validate a certificate presented by the host during SSL negotiation. There is no default directory. The default is to use the file root_certs.txt in in the wc3270 AppData directory.
Name: ws3270.caFileDefines a PEM-format file containing CA (root) certificates, used to validate a certificate presented by the host during SSL negotiation. The default is to use the file root_certs.txt in in the wc3270 AppData directory.
Name: ws3270.certFileGives 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 ws3270.certFileType. The private key for the certificate is specified by ws3270.keyFile. If ws3270.chainFile is specified, it overrides ws3270.certFile.
Name: ws3270.certFileTypeGives the type of the certificate file specified by ws3270.certFile. The value can be pem or asn1.
Name: ws3270.chainFileGives 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 ws3270.keyFile. If ws3270.chainFile is specified, it overrides ws3270.certFile.
Name: ws3270.charsetThis 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 ws3270, use the -v command-line option.
Name: ws3270.color8If true, ws3270 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: ws3270.confDirDefines the ws3270 configuration directory, where ws3270 will search for the ibm_hosts file by default. (See ws3270.hostsFile.)
The default is to search the directory where ws3270 was started, which usually its installation directory.
Name: ws3270.dbcsCgcsgidOverrides 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 ws3270.sbcsCgcsgid for the single-byte (SBCS) character set.
Name: ws3270.dftBufferSizeSpecifies 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: ws3270.devNameSpecifies the device name (workstation ID) sent in response to a TELNET NEW-ENVIRON sub-negotiation request, used by iSeries hosts (RFC 4777).
Name: ws3270.dsTraceDeprecated resource -- replaced by ws3270.trace
When true, ws3270 writes 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 ws3270.traceDir. If ws3270.traceFile is defined, it gives the entire pathname and ws3270.traceDir is ignored.
Name: ws3270.eofThis 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 ws3270 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: ws3270.erase
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 (ws3270 gathers a line of input before forwarding it ot the host), entering this character at the keyboard will cause ws3270 to discard the last character on the input line.
When connected in character-at-a-time mode (ws3270 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: ws3270.eventTraceDeprecated resource -- replaced by ws3270.trace
When true, ws3270 traces information about keyboard and mouse events into a file. The default file name is x3trc.process-id.txt. The directory where the file is written is defined by ws3270.traceDir. If ws3270.traceFile is defined, it gives the entire pathname and ws3270.traceDir is ignored.
Name: ws3270.extendedDeprecated resource -- replaced by ws3270.model syntax
Indicates support for the 3270 Extended Data Stream.
Name: ws3270.ftCodePageThe 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: ws3270.hostnameGives 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 ws3270.hostname.
The most common use of ws3270.hostname is in session files, where a file is used to pass all of the options to establish a ws3270 session.
Name: ws3270.hostsFileThe pathname of a file containing hostname aliases. The file can also be used 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.
Name: ws3270.icrnlThis 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: ws3270.idleCommandWhen ws3270.idleCommand is defined, it specifies a command to execute after a period of keyboard inactivity (no AID keys pressed). The ws3270.idleCommand can be an arbitrary sequence of ws3270 actions, but it should include an action which generates an AID (Enter, Clear, PF or PA). ws3270.idleCommandEnabled must be true in order for the ws3270.idleCommand to take effect. (This is so an idle command can be defined, but needs to be enabled explicitly at some point after login.) ws3270.idleTimeout specifies the inactivity interval.
Name: ws3270.idleCommandEnabledControls whether ws3270.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: ws3270.idleTimeoutThe timeout value for ws3270.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: ws3270.inlcrThis 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: ws3270.intrThis 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: ws3270.keyFileGives the name of a file containg the private key for the certificate specified by ws3270.certFile or ws3270.chainFile. The default file type is PEM; it can be overridden by ws3270.keyFileType. If the private key is encrypted, the password is specified by ws3270.keyPasswd.
Name: ws3270.keyFileTypeGives the type of the private key file specified by ws3270.keyFile. The value can be pem or asn1.
Name: ws3270.keyPasswdGives the password for the private key file specified by ws3270.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: ws3270.killThis 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 ws3270 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 ws3270 sends each keystroke to the host), this is the ASCII character that is sent to the host by the DeleteField action.
Name: ws3270.lineWrapThis setting is used only in NVT mode. When true, ws3270 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: ws3270.loginMacroDefines 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 ws3270.hostsFile is in use and a matching entry is found, the login macro from that entry will be used in preference to the ws3270.loginMacro.
Name: ws3270.lnextThis 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 ws3270 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: ws3270.localCpForces ws3270 to use the specified codepage in place of the system ANSI codepage. This codepage is used when interpreting keymap files and when generating trace files.
Name: ws3270.m3279Deprecated resource -- replaced by ws3270.model syntax
Indicates support for color (a 3279 terminal).
Name: ws3270.modelThe terminal model that ws3270 is emulating. The model is in three parts, separated by dashes; each part is optional.
When true, causes ws3270 to run in uppercase-only mode.
Name: ws3270.newEnvironIf true, ws3270 will respond to the TELNET NEW-ENVIRONMENT option. If false, it will not.
Name: ws3270.numericLockWhen true, causes ws3270 to lock the keyboard when non-numeric data is entered into fields with the Numeric attribute.
Name: ws3270.onlcrUsed 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: ws3270.oerrLockIf 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: ws3270.onceWhen true, ws3270 will exit as soon as a host disconnects. The default is false if no hostname is specified on the command line, true otherwise.
Name: ws3270.oversizeSets 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 ws3270.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 ws3270 in this mode.
Name: ws3270.portThe name of the default TCP port for ws3270 to connect to. This can be either a symbolic name from /etc/services, or an integer.
Name: ws3270.proxyDefines a proxy server that ws3270 will use to connect to hosts. The value is of the form type:server[:port], where options for type are described on the ws3270 manual page.
Name: ws3270.quitThis 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 ws3270 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: ws3270.rprntThis 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 ws3270 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: ws3270.sbcsCgcsgidOverrides 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 ws3270.dbcsCgcsgid for the double-byte (DBCS) character set.
Name: ws3270.screenTraceWhen true, ws3270 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 ws3270.traceDir. If ws3270.screenTraceFile is defined, it defines the file name and ws3270.traceDir is ignored. file name.
Name: ws3270.screenTraceFileIf defined, gives the name of the file that screen traces will be written into.
Name: ws3270.scriptPortIf defined, ws3270 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: ws3270.selfSignedOkWhen true, ws3270 will allow SSL authentication with a host that uses a self-signed certificate.
Name: ws3270.suppressActionsA 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: ws3270.termNameAn 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 ws3270.model.
Name: ws3270.tlsIf true, ws3270 will accept TLS negotiations from the host (if the OpenSSL DLLs are installed). If false, it will reject them.
Name: ws3270.traceWhen true, ws3270 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 ws3270.traceDir. If ws3270.traceFile is defined, it gives the entire pathname and ws3270.traceDir is ignored.
Name: ws3270.traceDirDefines the directory that trace files are written into.
Name: ws3270.traceFileIf 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: ws3270.traceFileSizeIf 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: ws3270.typeaheadWhen true, ws3270 will store keystrokes in a buffer when the keyboard is locked. When false, these keystrokes will be dropped.
Name: ws3270.unlockDelayWhen ws3270 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, ws3270 implements a hack to briefly delay actually unlocking the keyboard. When ws3270.unlockDelay is true, the keyboard unlock will be delayed for ws3270.unlockDelayMs milliseconds. Setting it to false removes this delay, except when executing a macro.
Name: ws3270.unlockDelayMsOverrides the default value for the unlock delay (the delay between the host unlocking the keyboard and ws3270 actually performing the unlock). The value is in milliseconds; use 0 to turn off the delay completely, including for macros.
Name: ws3270.userSpecifies the user name sent in response to a TELNET NEW-ENVIRON sub-negotiation request, used by iSeries hosts (RFC 4777).
Name: ws3270.utf8Forces local I/O to use UTF-8 encoding, regardless of the local codepage.
Name: ws3270.verifyHostCertIf false (the default), ws3270 will not verify SSL host certificates. If true or if the -verifycert option is given, ws3270 will verify SSL host certificates, and not allow an SSL or SSL/TLS connection to complete unless the host certificate can be validated.
Name: ws3270.weraseThis 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 ws3270 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 ws3270 sends each keystroke to the host), this is the ASCII character that is sent to the host by the DeleteWord action.
charset | hostname | model | port |
proxy |
eof | erase | icrnl | inlcr |
intr | kill | lineWrap | lnext |
onlcr | quit | rprnt | werase |
bindLimit | bsdTm | color8 | dbcsCgcsgid |
dftBufferSize | devName | sbcsCgcsgid | termName |
user |
blankFill | idleCommand | idleCommandEnabled | idleTimeout |
numericLock | oerrLock |
acceptHostname | caDir | caFile | certFile |
certFileType | chainFile | keyFile | keyFileType |
keyPasswd | selfSignedOk | suppressActions | tls |
verifyHostCert |
dsTrace | eventTrace | screenTrace | screenTraceFile |
trace | traceDir | traceFile | traceFileSize |
confDir | ftCodePage | hostsFile | loginMacro |
localCp | monoCase | newEnviron | once |
oversize | scriptPort | typeahead | unlockDelay |
unlockDelayMs | utf8 |
extended | m3279 |
ws3270 version 3.3.15ga4 Fri Oct 3 20:26:24 CDT 2014