These environment variables relate to configuring the input and output and the display.
Syntax
set CCITCP2=hostname
CCITCP2=hostname export CCITCP2
Parameters
hostname is the TCP hostname or dotted decimal IP address of the machine running the CCITCP2 daemon you wish to contact from that session.
Comments
The environment variable value will always take precedence over any value set using the Configuration Utility. To restore a process to using the value set by the Configuration Utility simply set the environment variable to an empty string, such as
set CCITCP2=
Alternatively, if this environment variable is set system-wide (by creating a system variable in the system environment settings, or by using a CONFIG.SYS file) then this value will always take precedence over any value set using the Configuration Utility.
Syntax
set CCITCP2_PORT=port
CCITCP2_PORT=port export CCITCP2_PORT
Syntax
CCITRACE=filename [options]
| /F or -F | logs the details of CCI API calls to the trace file. The default is OFF, unless a filename any other trace option is specified, in which case it is always ON. |
| /P or -P | logs the details of protocol-level calls to the trace file. The default is OFF. If this flag is OFF, then only the details of the CCI user-level API will be traced. If this flag is ON, the level of function tracing may be greatly increased. |
| /D or -D | logs the contents of all buffers passed to and from the CCI functions. The default is OFF. Data tracing may not be allowed if the application has been coded to prohibit data tracing for security reasons. |
So to create a CCI trace file with the default name of ccitrc1.trc (with matching ccitrc1.idx file) which traces CCI API function flow, along with the underlying protocol function flow, but with no tracing of the user data passed to these calls, the value of the CCITRACE environment variable would be /P.
The CCI.INI file can also be used to control trace options, but any values specified by the CCITRACE environment variable will take precedence.
Specifies the directory path that Animator is to search for the session (.aif) file for the program being animated, if it is not found in the same directory as the information (.idy) file. Animator can update the session file to record information held between sessions. The .aif file contains details of breakpoints and monitors.
Syntax
COBAIF=pathname export COBAIF
Parameters
Comments
If the .aif file is not found in the directory specified, a search is made of the directories specified by the COBIDY environment variable. If the file is still not found, the current directory is searched.
If an .aif file does not exist, Animator creates it as follows:
Specifies the basename of the Animator session file (.aif ) for the program being animated. The .aif file contains details of breakpoints and monitors.
Syntax
COBAIFNAME=basename export COBAIFNAME
Parameters
Comments
You need to specify this environment variable if you are starting Animator using COBSW=+A and you want to save breakpoints for subsequent animation sessions. You can also specify it if you are starting Animator using the command anim; in this case the basename you specify overrides the application name as the basename of the .aif file.
Specifies non-standard behavior for HIGHLIGHT and LOWLIGHT clauses used with ACCEPT and DISPLAY statements. It provides compatibility with earlier COBOL products. You should avoid using it wherever possible as support might be discontinued at some future date.
Syntax
COBATTR=n export COBATTR
Parameters
n A value in the range 0 through 7. It can be one of the following values, or a cumulative value; for example, specifying a value of 6 would result in the behavior described for values 4 and 2.
Provides standard, default behavior.
When a COBOL program displays text subject to a HIGHLIGHT or LOWLIGHT clause, the run-time system uses respectively the bold or dim mode specified in the terminfo entry for the terminal. If the bold or dim mode is not specified, then the HIGHLIGHT or LOWLIGHT clause respectively has no effect.
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.
High and low intensity space characters are not assumed to be the same as normal mode space characters.
As for 1 and 2 above
Provides compatibility with default behavior of products before COBOL version 3.2.
When a COBOL program displays text subject to a HIGHLIGHT clause, the effect depends on whether the dim mode is specified in the terminfo entry for the terminal. If dim mode is specified, then the run-time system uses the default mode for highlighted text and the dim mode for normal text. If the dim mode is not specified, then the run-time system uses the bold mode for highlighted text and default mode for normal text. The LOWLIGHT clause has no effect, giving the same appearance as normal text.
Example
COBATTR=1 export COBATTR
Specifies a run-time configuration file that tailors the run-time configurable options in some way.
Syntax
SET COBCONFIG=pathname
COBCONFIG=pathname export COBCONFIG
Parameters
Comments
If $COBCONFIG is not set then the file $COBDIR/etc/cobconfig is searched for instead.
Example
COBCONFIG=/home/mydir/cobconfig export COBCONFIG
SET COBCONFIG=/home/mydir/cobconfig
Values
Specifies the directory where the required Micro Focus COBOL system is installed. Many of the COBOL system components and utilities require and use this information. If the COBDIR environment variable is not set then the COBOL system acts as if it had been set to the default COBOL system directory. This default directory is /opt/microfocus/VisualCOBOL on UNIX systems.
SET COBDIR=pathname
COBDIR=pathname export COBDIR
Parameters
Comments
The Micro Focus COBOL system is normally installed in the default COBOL system directory and so does not require COBDIR to be set. COBDIR only needs to be set when your COBOL system has been installed in a different directory such as when more than one version of the COBOL system is available at the same time.
Example
SET COBDIR=/home/products/cobse20
COBDIR=/home/products/cobse20 export COBDIR
This causes the Cob utility to search the directory /home/products/cobse20 for the Micro Focus COBOL system software.
Specifies the maximum elapsed time, in tenths of a second, for the connected terminal to transmit any valid escape sequence to the runtime system.
When a terminal key is depressed, the terminal might send in response a single character or a group of characters to the runtime 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 runtime 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 runtime system in discrete packets, then the network can alter the intervals between each character arriving at the runtime system. COBKEYTIMEOUT is available to help compensate for typical network delays so the runtime system identifies escape sequences correctly.
Syntax
SET COBKEYTIMEOUT=n
COBKEYTIMEOUT=n export COBKEYTIMEOUT
Parameters
n 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 runtime system over the line or network connection. On encountering a lone Escape character, the runtime system waits n tenths of a second before assuming that the character does not introduce an escape sequence. The runtime system calculates an appropriate default value for n from the baud rate of the terminal.
Example 1:
COBLPFORM 1:3:5:7:9:11:13:15:17:19:21:23
In this example C01 equals 1, C02 equals 3, and so on.
Example 2:
COBLPFORM :3::5: :9
In this example, C01 equals 3, C02 equals 5, C03 equals 1, and C04 equals 9. You can specify only a single line number for each channel.
In example 2 above, channels C05 - C12 are undefined. If a print statement specifies channel C05 - C12, the line is printed at line 1. In addition, in the example shown, C03 equals 1 because its value is a space and therefore undefined.
Any WRITE BEFORE/AFTER PAGE statements cause positioning to be at line 1. Each line advance increases the line number by one. A request to skip to a line number less than or equal to the current line causes a new page to begin. The appropriate number of line feeds are then generated.
Specifies the size of the main stack.
Syntax
SET COBMAINSTACK=n
COBMAINSTACK=n export COBMAINSTACK
Parameters
n A number in the range 1 through nnn that represents the size of the main stack.
Comments
You might need to set COBMAINSTACK in any of the following circumstances:
If you are using the multi-threaded run-time system
If you have IF STATEMENTS with a very large number of ELSE clauses
Syntax
COBMODE=mode; export COBMODE
Parameters
mode = 32 or 64.
Example
COBMODE=32; export COBMODE
Syntax
COBOPT="[set environment-variable=value] [options] ... [cobextn: .ext [.ext] ... ]" export COBOPT
or
COBOPT=[pathname/]filename export COBOPT
If a line does not begin with one of the identifiers set or cobextn: then it is taken as an options line.
Comments
COBOPT can either contain options that supplement or override the system default options defined in $COBDIR/etc/cobopt, or it can specify the path of a file that contains such options. The options can extend over more than one line and each line must have the same format as described for the file $COBDIR/etc/cobopt in the chapter COBOL System Interface (cob).
Examples
COBOPT="CANS85 set COBCPY=$COBDIR/srclib/:$HOME/mylib:" export COBOPT
This enables ANSI 85 standard COBOL syntax and sets COBCPY to the specified list of paths.
COBOPT=temp/options
Specifies that cob options are contained in the file options in the directory temp.
Specifies the directory or directories that the runtime system is to search for dynamically loadable .int and .gnt files, or callable shared objects.
Syntax
SET COBPATH=pathname[:pathname]...
COBPATH=pathname[:pathname]... export COBPATH
Parameters
pathname A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX), that the runtime system is to search for a dynamically loadable program (.int, .gnt or callable shared object) file. When more than one pathname is specified, a null pathname represents the current working directory.
Example
SET COBPATH=u:/home/mydir/srclib:otherlib
COBPATH=u:/home/mydir/srclib:otherlib export COBPATH
Specifies the name of a print spooler that is to receive, via its standard input stream (stdin), output from any DISPLAY UPON PRINTER statement.
Syntax
SET COBPRINTER=command-line
COBPRINTER=command-line export COBPRINTER
Parameters
Comments
Each DISPLAY UPON PRINTER statement executed by your COBOL program causes a new invocation of command-line. Each invocation receives the data referenced in the DISPLAY statement, and is followed by a system end-of-file condition.
Example
SET COBPRINTER="myspooler -a $TMPDIR\spoolfile"
COBPRINTER="myspooler -a $TMPDIR/spoolfile" export COBPRINTER
Specifies the UNIX Session Recorder functions to perform.
Syntax
COBSES={option[filename]}...
export COBSES
option can be one or more of the following:
These flags are all case sensitive. Also, you cannot combine the -r flag with either -f or -p.
Syntax
SET COBSW=[+/-}s...
COBSW=[+/-}s... export COBSW
A list of the runtime switches to set or unset.
Example
SET COBSW=+0+D
COBSW=+0+D export COBSW
This enables runtime switch 0 and the ANSI COBOL debug switch.
COBTERMINFO=pathname[:pathname]... export COBTERMINFO
Parameters
pathname A list of search directories, each item separated by a colon, that identify a terminfo database containing terminal settings tailored for COBOL applications. A null pathname represents the current working directory.
Comments
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 runtime 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.
If COBTERMINFO is not set, the runtime system acts as if it had been set to $COBDIR/terminfo.
Micro Focus recommend 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.
Example
COBTERMINFO=$COBDIR/terminfo:/home/mydir/terms export COBTERMINFO
Specifies the column width of the terminal screen or window, overriding the specified terminal default.
Syntax
COLUMNS=n export COLUMNS
Parameters
n The width of the terminal screen or window, in column positions.
Comments
The default, when COLUMNS is unset or null, is to use the cols value defined in the specified terminal's terminfo entry, or the current width of the terminal window if you are using an X terminal. The terminal type is specified using the standard UNIX environment variable, TERM.
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.
Example
COLUMNS=100 export COLUMNS
ES_CAS_API=value export ES_CAS_API
SET ES_CAS_API=value
The utility will attempt to log messages.
ES_CONSOLE_LOG=port export ES_CONSOLE_LOG
Can be any combination of the following:
ES_ESMAC_DISP_MAX_OVERRIDE=value export ES_ESMAC_DISP_MAX_OVERRIDE
ES_ESMAC_DISP_MAX_OVERRIDE=value
ES_MAX_CATALOG_LINES=number export ES_MAX_CATALOG_LINES
ES_MAX_CATALOG_LINES=number
ES_OTMA_TIMEOUT=seconds export ES_OTMA_TIMEOUT
SET ES_OTMA_TIMEOUT=seconds
Syntax
ES_SEP_DORMANT_TIME=seconds export ES_SEP_DORMANT_TIME
ES_SEP_DORMANT_TIME=seconds
Values
Default
Transient SEPs are terminated after 2 seconds of inactivity.
Syntax
ES_SERVER=name export ES_SERVER
ES_SERVER=name
Values
Default
ESDEMO/ESDEMO64
Syntax
ES_USR_DFLT_ESMAC=user export ES_USR_DFLT_ESMAC
SET ES_USR_DFLT_ESMAC=user
Values
Default
mfuser
Syntax
ES_ESM_DISABLE_DFLTUSER_ESMAC=value export ES_ESM_DISABLE_DFLTUSER_ESMAC
ES_ESM_DISABLE_DFLTUSER_ESMAC=value
Values
Default
Default ESMAC user is not disabled.
Syntax
LANG=language[_territory[.codepage]] export LANG
Example
LANG=fr_FR export LANG
Syntax
LINES=n export LINES
Parameters
n The depth of the terminal screen or window, in lines.
Comments
The default, when LINES is unset or null, is to use the lines value as defined in the specified terminal's terminfo entry, or the current depth of the terminal window if you are using X windows. The terminal type is specified via the standard UNIX environment variable, TERM.
On non-windowing environments, where the terminal screen area cannot be resized, the LINES values does not need to be set.
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.
Example
LINES=50 export LINES
Specifies the directory or directories for the UNIX system, Cob and the run-time system to search for shared libraries and callable shared objects. It must be set to 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.
Syntax
LD_LIBRARY_PATH=pathname[:pathname]... export LD_LIBRARY_PATH
pathname A path or a list of paths, each separated by a colon (:).
Comments
The list of directories must include $COBDIR/lib. The COBDIR environment variable is described earlier.
This environment variable is a system environment variable; see your UNIX documentation for more information.
Example
LD_LIBRARY_PATH=$COBDIR/lib:/home/mydir/myapp:$LD_LIBRARY_PATH export LD_LIBRARY_PATH
Syntax
LIBPATH=pathname[:pathname]... export LIBPATH
Parameters
pathname A directory to search for shared libraries.
Example
LIBPATH=$COBDIR/lib:/lib:/usr/lib
Syntax
SET MAINFRAME_FLOATING_POINT=fpstatus
MAINFRAME_FLOATING_POINT=fpstatus export MAINFRAME_FLOATING_POINT
Parameters
fpstatus Which format to use for floating point data items. This must be one of:
Setting MAINFRAME_FLOATING_POINT to anything other than true has the same effect as setting it to false.
The setting of this environment variable can be overridden by the NATIVE-FLOATING-POINT directive.
|
Country Code (MFCODESET) |
EBCDIC CCSIDs | Language |
|---|---|---|
| AUTOMATIC
AUTO |
Operating system default - sets country code based on CBL_GET_OS_INFO | |
| DEFAULT | For a single-byte character set environment, 0437 (US English) selected; else 0081 (Japanese Katakana Extended) selected. | |
| 0031 | 37, 1140 | Dutch |
| 0033 | 297, 1147 | French |
| 0034 | 284, 1145 | Spanish |
| 0039 | 280, 1144 | Italian |
| 0043 | 273, 1141 | German (Austrian) |
| 0044 | 285, 1146 | UK English |
| 0045 | 277, 1142 | Danish |
| 0046 | 278, 1143 | Swedish |
| 0047 | 277, 1142 | Norwegian |
| 0049 | 273, 1141 | German |
| 0066 | 838 | Thai Extended |
| 0081† | 930 (290, 300) | * Japanese Katakana Extended |
| 0082 | 933 (833, 834) | *Korean |
| 0086 | 13676 (836, 837) | *Simplified Chinese |
| 0351 | 37, 1140 | Portuguese |
| 0358 | 278, 1143 | Finnish |
| 0437 | 37, 1140 | US English |
| 0500 | 500, 1148 | International (Latin 1) |
| 0886 | 937 (37, 835) | *Traditional Chinese |
| 0930 † | 930 (290, 300) | *Japanese Katakana Extended |
| 0939 † | 939 (1027, 300) | *Japanese Latin Extended |
| 9122 † | 9122 (290, 300) | *Japanese Katakana |
Character sets marked with an asterisk (*) are capable of mixed single-byte and double-byte character conversion. EBCDIC CCSIDs in these rows indicate the mixed-byte CCSID first, followed by the single-byte, then double-byte Code Page Global Identifiers (CPGIDs) in parenthesis.
Other EBCDIC CCSIDs in parentheses reflect a 'non-Euro, Euro' pair for appropriate country codes.
For database applications using a DBMS server on Windows, use the table above.
For Windows and UNIX database applications accessing a UNIX database created with single-byte character sets 819 or 923, use the following table:
| Country Code
(MFCODESET) |
EBCDIC CCSIDs | Languages |
|---|---|---|
| 1140 | 37,1140 | Dutch US English Portuguese |
| 1141 | 273,1141 | German (Austrian) German |
| 1142 | 277,1142 | Danish Norwegian |
| 1143 | 278,1143 | Swedish Finnish |
| 1144 | 280,1144 | Italian |
| 1145 | 284,1145 | Spanish |
| 1146 | 285,1146 | UK English |
| 1147 | 297,1147 | French |
| 1148 | 500,1148 | International (Latin 1) |
If you are not using UK or US language settings, you must also set the codepage in your PC environment settings:
Syntax
SET MFCSCFG=filename
MFCSCFG=filename export MFCSCFG
Parameters
filename The name of the configuration file.
Example
SET MFCSCFG=/home/mydir/mfclisrv.cfg
MFCSCFG=/home/mydir/mfclisrv.cfg export MFCSCFG
Comments
The value of MFCSCFG is overridden by any value defined in the command line. If neither of the above yields a filename, the default filename mfclisrv.cfg is assumed, and is searched for in the current directory. If that in turn is not found, the default settings for the configuration entries are used.
Syntax
SET MFLOGDIR=dirname
MFLOGDIR=dirname export MFLOGDIR
Parameters
dirname The name of the directory for log files.
Example
SET MFLOGDIR=/home/mydir/logs
MFLOGDIR=/home/mydir/logs export MFLOGDIR
Specifies a configuration file for Language Environment (LE) runtime options.
Syntax
SET MFLECONFIG=filename
MFLECONFIG=filename export MFLECONFIG
Parameters
filename The file containing the LE runtime options you want to use.
Specifies the directories to be searched by all UNIX programs, including the runtime system, when finding executables to be run.
Syntax
PATH=pathname[:pathname]... export PATH
Parameters
pathname A directory to search for executables.
Example
PATH=$COBDIR/bin:$PATH export PATH
Syntax
TERM=name export TERM
Parameters
name The name of the terminal in the terminfo database.
Example
TERM=at386 export TERM
Specifies the directory to be searched by all UNIX programs, including the runtime system, for the UNIX system terminfo database.
Syntax
TERMINFO=pathname export TERMINFO
Parameters
pathname The name of a directory that contains the UNIX system terminfo database.
Comments
The UNIX system terminfo database is used by all UNIX applications that need to use a terminal. However, COBOL applications tend to make much fuller and sophisticated use of the terminal and require a fuller terminfo description than is required by typical UNIX applications such as vi. 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.
Syntax
TMPDIR=pathname export TMPDIR
Parameters
pathname The directory used by UNIX applications for any temporary work files. Temporary work files can be created by COBOL utilities such as Cob or by the runtime system when it executes statements such as SORT. If you do not specify a directory, the system default directory is used.
Comments
You might need to use this environment variable if the runtime system needs to page data to disk when creating heaps or sorting.