Input, Output, and Display Environment Variables

CCITCP2=host-name

host-name

The TCP host name, IPv4 address, or IPv6 address of the machine running the MFDS daemon you want to contact from the session.

CCITCP2_PORT=port-number

port-number

The number of the port on which the MFDS service is listening.

CCITCPT_serice-name=[unused], MFNODE:node-name, MFPORT:port-number

service-name

The name of the CCI service to which the client is to connect. On UNIX platforms, this must be in upper case.

unused

The parameter before the comma is not used with CCITCPT, but supported for consistency with CCITCPS.

node-name

The host name or IP address to connect.

port-number

The TCP port to connect.

CCITCPT_MYSERVICE=,MFNODE:localhst.MFPORT:3000

COBAIFNAME=base-name

base-name

The base name of the .aif files.

The .aif file contains details of breakpoints and monitors.

COBATTR={0|1|2|3|4|5|6|7}

0

Provides standard, default behavior.

1

When a COBOL program displays text subject to a HIGHLIGHT clause, the run-time system uses the bold mode. The run-time system uses the default mode for normal text. Specifying dim mode in the terminfo entry for the terminal has no affect. The LOWLIGHT clause has no effect.

2

High and low intensity space characters are not assumed to be the same as normal mode space characters.

3

Behavior is a combination of parameters 1 and 2.

4

Provides compatibility with default behavior of products before COBOL version 3.2.

5

Behavior is a combination of parameters 4 and 1.

6

Behavior is a combination of parameters 4 and 2.

7

Behavior is a combination of parameters 1, 2, and 4.

COBATTR=0

COBATTR=1

COBCONFIG=path-name

path-name

The directory that contains the COBOL configuration file, which tailors the run-time system.

COBCONFIG=/home/mydir/cobconfig

COBCONFIGJVM=path-name

path-name

The location of a Java properties file.

COBCONFIG.BLOCK=path

path

The full path to the location of the application configuration file.

COBDIR=path-name

path-name

The directory that contains the required Micro Focus COBOL system software.

This example causes the compiler to search the directory /home/products/cobse20 for the Micro Focus COBOL system software.

COBDIR=/home/products/cobse20

COBKEYTIMEOUT=trans-time

trans-time

A number in the range 1 through 126 that represents the maximum elapsed time required for a terminal to transmit any valid escape sequence to the run-time system over the line or network connection.

The run-time system calculates an appropriate default value for n from the baud rate of the terminal.

When a terminal key is depressed, the terminal might send in response a single character or a group of characters to the run-time system. Typically, such a group of characters starts with an escape character and the group of characters is known as an escape sequence. A terminal might send an escape sequence for one depression of a function key. It might also send the same sequence of characters for a depression of the Escape key followed by the depression of one or more alphabetic or numeric data keys. The only difference apparent to the run-time system is the interval between the arrival of each character; the user cannot type as fast as the escape sequence is generated by the terminal.

If a terminal is connected over a network that sends the characters to the run-time system in discrete packets, then the network can alter the intervals between each character arriving at the run-time system. COBKEYTIMEOUT is available to help compensate for typical network delays so the run-time system identifies escape sequences correctly.

COBLANG=LE-option

LE-option

A COBOL language environment (LE) option.

COBLPFORM line-number[[:line-number][...]]

line-number

A single line number of a channel. Null entries are ignored. Those channels that have line number zero, function-names S01-S052, CSP, or are undefined, are set to line 1.

In the following example, C01 equals 1, C02 equals 3, and so on:

COBLPFORM 1:3:5:7:9:11:13:15:17:19:21:23

In this next example, C01 equals 3, C02 equals 5, C03 equals 1, and C04 equals 9. C03 equals 1 because its value is a space and therefore undefined, and channels C05 - C12 are also undefined:

COBLPFORM :3::5: :9

COBMAINSTACK=stack-size

stack-size

The size of the main stack in bytes.

You might need to set COBMAINSTACK in any of the following circumstances:

• If you are deploying native OO COBOL Enterprise JavaBeans (EJBs) to WebSphere on the AIX platform.
• If you are using the multi-threaded run-time system.
• If you have IF STATEMENTS with a very large number of ELSE clauses.
• If you have a large amount of local-storage data.

COBMODE={32|64};

32|64

Specify the bitness you want to use when starting the server.

COBMODE=32;

COBOPT="[set environment-variable=parameter]
[option[...]]
[[cobextn: .ext [.ext]][...]]"

or

COBOPT=[path-name/]file-name

environment-variable

Any one environment variable supported by Enterprise Server.

parameter

A parameter used by the specified environment variable.

option

A cob command-line directive. See Compiler Directives for details.

ext

A filename extension that, in addition to the standard ones of .cob, .CBL, or .cbl, denotes a file that the compiler should treat as a COBOL source file. If more than one is specified on one line then they must be separated by a space or tab character.

If a line does not begin with one of the identifiers set or cobextn: then it is taken as an options line.

This example enables ANSI 85 standard COBOL syntax and sets COBCPY to the specified list of paths.

COBOPT="CANS85
set COBCPY=$COBDIR/srclib/:$HOME/mylib:"
export COBOPT

This next example specifies that cob options are contained in the file options in the temp directory:

export COBOPT=temp/options

COBPATH=path-name[:path[...]]

path-name

The full or relative path to a directory for the run-time system to search for a dynamically loadable program (.int, .gnt or callable shared object) file.

When more than one path-name is specified, a null path name represents the current working directory.

COBPATH=/home/mydir/srclib:otherlib

COBPRFDIR=path-name[[:path-name][...]]

path-name

The full path of a directory to search.

COBPRINTER="command-line"

command-line

A command line supported by your system and that can be executed by the system shell. Typically, it is simply the name of a print spooler or other executable, but if the shell is escaped when setting the value then any command-line arguments can be used.

COBPRINTER="myspooler -a $TMPDIR/spoolfile"

COBSES={option}[[:option][...]]

option

One or more of the following, all of which are case sensitive:

-a	Include keystrokes made to and screen output from the Animator
-f file-name	Play back recording in file-name in fast forward mode
-p file-name	Play back recording in file-name at normal speed
-r file-name1	Record keystrokes in file-name
-s file-name	Record screen output in file-name
-t terminal-number	Terminal number for multi-user screen recordings
1 Do not combine with either -f or -p.

file-name

The name of the recording file.

terminal-number

The terminal number for multi-user screen recordings.

COBSW={+|-}switch[...]

+

Sets the switch.

-

Unsets the switch.

switch

A run-time switch. See Run-time Switches for details.

COBSW=-A

COBSW=+0+D

COBTERMINFO=path-name[[:path-name][...]]

path-name

A search directory that identifies a terminfo database containing terminal settings tailored for COBOL applications.

COBTERMINFO=$COBDIR/terminfo

The COBOL system takes the value of the standard UNIX environment variable TERM as the name of the terminal in use. It uses this to search for the appropriate terminal information in a terminfo database. The run-time system first searches the databases identified in COBTERMINFO and then, if the terminal information is not found it searches the database identified in the standard UNIX environment variable TERMINFO.

Micro Focus recommends that the first directory listed in COBTERMINFO is $COBDIR/terminfo so that the terminfo database supplied with this COBOL system is found first. For commonly used terminals, this terminfo contains settings that are fuller and more appropriate to COBOL than those normally available in the UNIX system terminfo database.

When debugging using Animator, COBTERMINFO must be set to $COBDIR/terminfo.

COBTERMINFO can also be used to identify a terminfo database that is portable between UNIX systems. Such a database conforms to the standard UNIX database format but does not include any supplementary, UNIX implementation-dependent terminal information. Many UNIX system terminfo databases are not portable because they include such supplementary information. The COBOL system ignores any such nonportable details.

COBTERMINFO=$COBDIR/terminfo:/home/mydir/terms

COLUMNS=number-of-columns

number-of-columns

Specifies the width of the terminal screen or window as represented by the number of columns that display.

On non-windowing environments, where the terminal screen area cannot be resized, the COLUMNS values does not need to be set. Terminals that can switch into a wide mode (usually from 80 through 132 columns) have a terminal name ending in "w" and these are automatically supported, without the need to set COLUMNS.

In windowing environments, where the size of windows can be changed, the initial size of the window is used in preference to the cols value in terminfo. When the window is resized, the new size is reread. If the new size is greater than the initial size then the extra columns might not be used.

If you want to use the full width of the window you might need to set COLUMNS to the current column width of the window on some platforms.

Using COLUMNS values that do not correspond to the actual width of the window produces unexpected results.

COLUMNS=100

ES_CAS_API=ON

ON

The utility is invoked by a call, and messages are not sent to the console or command line.

ES_CSKL_NO_MSG_CONSOLE=ON

ON

CSKL does not write message to console.log.

ES_ESMAC_DISP_MAX_OVERRIDE=value

value

An integer denoting the number of lines to display to a maximum of 99999.

ES_ESMAC_DISP_MAX_OVERRIDE=1000

ES_JES_SPOOL_ORDER=1

1

Displays the list in descending order by JOBID.

ES_LEGACY_ECI=Y

Y

Micro Focus ECI is used.

ES_MAX_CATALOG_LINES=number

number

The number of lines to display up to a maximum of 99999.

ES_MAX_CATALOG_LINES=5000

ES_OTMA_TIMEOUT=wait-time

wait-time

The number of seconds to wait. The maximum is 43199.

ES_OTMA_TIMEOUT=120

(2 minutes)

ES_SEP_DORMANT_TIME=wait-time

wait-time

The number of seconds that the Transient SEP is inactive.

ES_SEP_DORMANT_TIME=2

ES_SERVER=server-name

server-name

The server name.

32-bit

ES_SERVER=ESDEMO

64-bit

ES_SERVER=ESDEMO64

ES_SYSOUT_HOLD={msg-class}[msg-class[...]]

msg-class

A message class to send to the Complete queue with an Out Hold status.

ES_SYSOUT_HOLD=AB

ES_TN2370_FORCE_ALT=ON

ON

Enables alternative screen size.

ES_TN3270_MODEL_LOG=Y

Y

Model names are written to TSQ TN32MODL.

ES_USR_DFLT_CICS=userid

userid

An alternative default user name.

ES_USR_DFLT_CICS=CICSUSER

ES_USR_DFLT_ESMAC=userid

userid

The default user name.

ES_USR_DFLT_ESMAC=MFUSER

ES_USR_DFLT_JES=userid

userid

The default user name.

ES_USR_DFLT_JES=JESUSER

ES_ESM_DISABLE_DFLTUSER_ESMAC=Y

Y

Disables the default ESMAC user, disables the DEFAULT button on the logon screen, and forces users to always enter a valid user ID and password.

JAVA_HOME=path-name

path-name

The full path to the location of the JAVA_HOME location.

LANG=unix-language[_territory[.code-page]]

unix-language

The spoken/written language in which your program is to run. This determines which message catalog is open so that if an error occurs, the error message is output in the selected language. unix-language can take any of the following values:

Value	Language
en_US	US English
en_GB	UK English
jp_JP	Japanese (EUC encoding)
jp_JP.sjis	Japanese (Shift-JIS encoding)
jp_JP.utf8	Japanese (UTF8 encoding)

territory

The country in which your program is to run.

code-page

The character set code to use for your program.

LANG=fr_FR

LD_LIBRARY_PATH={$COBDIR/lib|path-name}[:path-name[...]]

path-name

The full path to a directory to search.

If you have installed the product to a directory other than the default, you must set this variable, and include $COBDIR/lib on all platforms except AIX (which uses LIBPATH). It should also include any directories that contain callable shared objects used by your application.

If you have installed the product in the default directory (/opt/microfocus/EnterpriseDeveloper), you do not need to set this variable.

LD_LIBRARY_PATH=$COBDIR/lib:/home/mydir/myapp:$LD_LIBRARY_PATH

LIBPATH={$COBDIR/lib|path-name}[:path-name[...]]

path-name

The full path to a directory to search.

If you have installed the product in the default directory (/opt/microfocus/EnterpriseDeveloper), you do not need to set this variable.

LIBPATH=$COBDIR/lib:/lib:/usr/lib

LINES=line-depth

line-depth

The depth of the terminal screen or window, in lines.

In windowing environments, where the size of windows can be changed, the initial size of the window is used in preference to the lines value in terminfo. When the window is resized, the new size is reread. If the new size is greater than the initial size then the extra lines might not be used.

If you want to use the full depth of the window you might need to set LINES to the current depth of the window on some platforms.

Using LINES values that do not correspond to the actual depth of the window produces unexpected results.

LINES=50

MAINFRAME_FLOATING_POINT={true|false}

true

Use IBM hexadecimal-format floating-point data items.

false

Use IEEE-format floating-point data items.

MAINFRAME_FLOATING_POINT=false

MF_CHARSET={{A|ASCII}|{E|EBCDIC}}

A|ASCII

Use the ASCII character set.

E|EBCDIC

Use the EBCDIC character set.

MF_CHARSET=A

MF_SPOOL_ARCHIVE_LOC=path-name

path-name

The base location for files archived as part of the spool housekeeping process

MF_USESCA5={ON|OFF}

ON

The server uses version 5 of the Open SCA.

OFF

The server uses the default version of Open SCA.

MF_USESCA5=ON

MF_USESCA7={ON|OFF}

ON

Accepts CA7 Scheduler control statements as comments.

OFF

Diagnoses CA7 Scheduler control statements as errors.

MF_USESCA7=ON

MFCODESET=country-code

country-code

The country code required for translation. See Supported Country Codes for a list of countries and codes.

MFCSCFG=[path-name/]file-name

path-name

The full path to the location of the configuration file.

file-name

The name of the configuration file.

MFCSCFG=mfclisrv.cfg

MFCSCFG=/home/mydir/mfclisrv.cfg

MFLECONFIG=path-name/file-name

path-name

The full path to the location of the ile containing the LE run-time options you want to use.

file-name

The name of the file containing the LE run-time options you want to use.

MFLOGDIR=path-name

path-name

The full path to the location of log files.

MFLOGDIR=/home/mydir/logs

MFLECONFIG=path-name/file-name

path-name

The full path to the location of the ile containing the LE run-time options you want to use.

file-name

The name of the file containing the LE run-time options you want to use.

MFSUB={SUBI|ASUBI}

MQSERVER=channel-name/transport-type/{machine-name|ip-address(port-number)}
   [,{machine-name|ip-address}(port-number)][...]]

channel-name

The name of a channel as defined on the server.

transport-type

The communications protocol, which can be any of the following:

• TCP
• LU62
• NETBIOS
• SPX

machine-name

The name of the server machine.

ip-address

The machine IP address.

port-number

The number of the port used.

This environment variable is IBM-defined, and more information may be found in the relevant IBM publication.

MQSERVER=CHANNEL3/TCP/QServer(1414)

MQSERVER=CHANNEL1/TCP/10.120.99.999(1414),10.120.98.888(1414)

PATH=path-name[;[path-name][...]]

path-name

The full or relative path to a directory to search for executables.

PATH=u:/home/mydir/srclib:otherlib

TERM=term-type-name

term-type-name

The name of a terminal type listed in the terminfo database.

TERM=at386

TERMINFO=path-name

path-name

The full path to the directory that contains the UNIX system terminfo database.

Some terminal capabilities, such as those set during the initialization of the terminal to control the use of function keys, commonly conflict with the needs of typical COBOL applications. In such cases, the terminal information required by COBOL can be stored in a separate terminfo database and referenced using COBTERMINFO.

TMPDIR=path-name

path-name

The full path to an alternative directory in which to store temporary work files.

You might need to use this environment variable if the run-time system needs to page data to disk when creating heaps or sorting.

TXMAPP=path-name

path-name

The full path to the location of the BMS load module.

TXRDTP=path-name

path-name

The full path to the MSS resource definition (RDO) files.