Terminfo Database and Terminal Devices

EBCDIC/ASCII Translation Tables

Appendix A: Micro Focus Environment Variables

This appendix lists all the environment variables that can be set when using the Micro Focus COBOL system, and provides a brief summary of each one:

Details on the use of these environment variables can be found in the main body of the manual set. dd_ routines provide an alternative method of assigning values to environment variables. These are detailed in the chapter Filenames in your File Handling book.

Note: The syntax in the following descriptions is shown as required for the sh and ksh. Other shells, such as csh, require a syntax of the form:

setenv env_var value

where the parameters are:

CCITCP2

Specifies the TCP address of the machine running the CCITCP2 registration daemon. It is associated with the Common Communications Interface (CCITCP). See your Configuring CCI book for details.

Syntax:

CCITCP2=hostname
export CCITCP2

Parameters:

Comments:

There are two methods of specifying the level of tracing: the CCITRACE environment variable and the control-buffer parameter passed to a CCI-Trace function call.

CCITRACE

Specifies the style of the traced output.

Syntax:

CCITRACE=filename[options] 
export CCITRACE

Parameters:

Comments:

See your Configuring CCI book for detailed information on CCI application call tracing.

COBAIF

Specifies the directories in which Animator searches for or creates the Animator session file (.aif) for the program being animated. The .aif file contains details of breakpoints and monitors.

Syntax:

COBAIF=pathname
export COBAIF

Parameters:

Comments:

If the .aif file is not found on the path specified by COBAIF, a search is made of the directories specified by the COBIDY environment variable. If the session file is still not found, the current directory is searched.

If an .aif file does not exist, Animator creates it as follows:

• If COBAIF is set, the .aif file is created in the first directory specified by COBAIF
  
• If COBAIF is not set, it is created in the directory specified in the environment variable COBIDY from which the program .idy file was loaded
  
  
• If COBAIF and COBIDY are not set, or if the first directory specified by COBIDY is not found, the .aif file is created in the current directory.

There is also an Animator directive COBAIF; see the chapter Directives for Animator in your Debugging Handbook for details.

COBANIMOPT

Specifies directives to be used by Animator.

Syntax:

COBANIMOPT=directive-list 
export COBANIMOPT

Parameters:

Example:

COBANIMOPT="MIXEDLANGDEBUG MULTITHREAD"
export COBANIMOPT

Comments:

When you invoke Animator, it first reads the directives you have specified in COBANIMOPT and then uses any directives you specify in the command line (which might override some of the directives you set in COBANIMOPT). For details on the format for specifying directives, see the chapter Starting Animator in your Debugging Handbook.

COBANIMSRV

Identifies which COBOL program a waiting Animator process should attach to.

Syntax:

COBANIMSRV=progid 
export COBANIMSRV

Parameters:

Example:

In one console session:

export COBANIMSRV=myid

myid is now a unique identifier that you can use to match Animator to a program. Type the command to start Animator:

cobanimsrv

The Animator waits for a COBOL program to start that has a matching identifier. In another console session:

export COBANIMSRV=myid
cobrun prog1.int

When prog1.int starts the unique identifier myid matches that of Animator; therefore, Animator attaches to this process. In console session 1, the Animator main screen is displayed and the cursor placed on the first line of prog1.int.

Comments:

This environment variable is particularly useful for starting cross-session debugging. See the chapter Starting Animator in your Debugging Handbook.

COBATTR

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 can be discontinued at some future date.

Syntax:

COBATTR=n
export COBATTR

Parameters:

See the chapter Terminfo Database and Terminal Devices for details on terminfo entries.

Example:

COBATTR=1
export COBATTR 

COBCONFIG

Specifies a run-time configuration file that tailors the run-time configurable options in some way. See the chapter Run-time Configuration for information on available run-time configurable options.

Syntax:

COBCONFIG=pathname
export COBCONFIG

Parameters:

Example:

COBCONFIG=/home/mydir/cobconfig
export COBCONFIG 

Comments:

If $COBCONFIG is not set then the file $COBDIR/etc/cobconfig is searched for instead.

COBCPY

Specifies the directory or directories that the Compiler and Animator should search for copyfiles.

Syntax:

COBCPY=pathname[:pathname]...
export COBCPY

Parameters:

Example:

COBCPY=/home/group/sharedcopy::mydir/mycpy
export COBCPY

causes the Compiler to search for a copyfile in /home/group/sharedcopy, then in the current directory and finally in ./mydir/mycpy until either the copyfile is found or it can be considered not found.

COBDATA

Specifies the directory or directories that the run-time system is to search for data files. Provides you with the facility to map data files globally, thus enabling you to put working data files in a directory whose name is not known until run time.

Syntax:

COBDATA=pathname[:pathname]...
export COBDATA

Parameters:

Example:

COBDATA=:demo:/home/data:progs
export COBDATA

causes COBDATA to be set to instruct the run-time system to search for data files in the current directory, then in the directory ./demo, then in the directory /home/data and finally in ./progs.

Comments:

COBDATA affects the compiler and other utilities. During compilation, for example, program source is regarded as a data file by the compiler. If you intend to use any COBOL development system utilities, we recommend that the COBDATA value starts with a colon (:).

COBDATA is considered set if there is an environment variable of this name in your environment space, and its value is non-empty.

The full mapping order for files is:

1. Any dd_ environment mappings
   
   
2. Any ASSIGN TO EXTERNAL mappings
   
   
3. Any COBDATA environment variable mappings

For multiple directory paths specified either in the COBDATA environment variable or a dd_ environment variable, the system searches the first directory specified followed by a slash (/) as a prefix to the user name.

If the filename is not found, or is not readable, the search continues with the next directory until the final directory has been searched. If no file is found, the first directory is used if a file is to be created.

Any dd_ and COBDATA mappings are ignored for any filename that starts with a hyphen (-) or a slash (/). In addition, it is illegal to have a hyphen in an environment variable name.

When using this facility, you should not use a filename that starts with "COB... "(these are reserved for the COBOL system).

You can use the COBDATA environment variable for files open in any mode (including OUTPUT) and for fixed or variable length files. If you are using indexed files, both the data and index files must be in the same directory.

The COBDATA environment variable affects file deletes, using the rules given here, as well as file opens.

If you intend to use COBOL development system programs, we recommend that you first unset COBDATA, as many of these programs open data files and are thus affected by the value of COBDATA.

If you do need to use COBDATA, you should add :$COBDIR//dynload/helptbox.lbr: to the start of the COBDATA path.

COBDIR

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 /usr/lpp/cobol on AIX, or /opt/lib/cobol on other UNIX systems.

Syntax:

COBDIR=pathname
export COBDIR

Parameters:

Example:

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.

Comments:

The Micro Focus COBOL system is normally installed in the default COBOL system directory (see above) 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.

See Also:

LD_LIBRARY_PATH
LIBPATH
PATH
SHLIB_PATH

COBIDY

Specifies the directory that Animator is to search for the information (.idy) file for the program being animated if it is not found in the same directory as the intermediate code (.int) file. Animator can update the information file to record information held between sessions. There is also a Compiler directive COBIDY, see the chapter Directives for Compiler for details.

Syntax:

COBIDY=pathname
export COBIDY

Parameters:

COBEXTFHBUF

Specifies that fixed-length sequential files are buffered.

Syntax:

COBEXTFHBUF=buffer-size 
export COBEXTFHBUF

Parameters:

COBKEYTIMEOUT

Specifies the maximum elapsed time, in tenths of a second, for the connected terminal to transmit any valid escape sequence to the run-time system.

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.

Syntax:

COBKEYTIMEOUT=n 
export COBKEYTIMEOUT

Parameters:

COBOPT

Specifies user default options to the Cob utility.

Syntax:

COBOPT="[set environment-variable=value]
[options] ...
[cobextn: .ext [.ext] ... ]"
export COBOPT

or:

COBOPT=[pathname/]filename
export COBOPT

Parameters:

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="-C ANS85
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.

COBPATH

Specifies the directory or directories that the run-time system is to search for dynamically loadable .int and .gnt files, or callable shared objects.

Syntax:

COBPATH=pathname[:pathname]...
export COBPATH

Parameters:

Example:

COBPATH=u:/home/mydir/srclib:otherlib
export COBPATH 

See Also:

program_search_order run-time tunable.

COBPRINTER

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:

COBPRINTER=command-line
export COBPRINTER

Parameters:

Example:

COBPRINTER="myspooler -a $TMPDIR/spoolfile"
export COBPRINTER

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.

COBSES

Specifies the UNIX Session Recorder functions you want to perform.

Syntax:

COBSES={option[filename]}...
export COBSES

Parameters:

Comments:

For detailed information on the UNIX Session Recorder and the COBSES environment variable, see the chapter UNIX Session Recorder in your Utilities Handbook.

Warning: You must unset COBSES when you have finished using the UNIX Session Recorder, or it will interfere with the running of your COBOL programs. To do this, set COBSES to spaces, then export this setting to the shell.

COBSW

Specifies run-time system switch settings for the run-time system to observe when running an application.

Syntax:

export COBSW

Parameters:

	Enables (+) or disables (-) the following switch.
switch	One of the switches described in the chapter Descriptions of Run-time Switches.

Example:

COBSW=+0+D
export COBSW

This enables run-time switch 0 and the ANSI COBOL debug switch.

COBTERMINFO

Specifies the directory or directories to be searched by the run-time system for a terminfo database of terminal information tailored to the needs of COBOL applications. This enables COBOL applications to use different terminfo settings to those used by non-COBOL applications, such as vi, when using the same terminal.

Syntax:

COBTERMINFO=pathname[:pathname]...
export COBTERMINFO

Parameters:

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 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.

If COBTERMINFO is not set, the run-time system acts as if it had been set to $COBDIR/terminfo.

We 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 non-portable details. See the chapter Terminfo Database and Terminal Devices for further details on using the terminfo database.

Example:

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

See Also:

TERM
TERMINFO

COLUMNS

Specifies the column width of the terminal screen or window, overriding the specified terminal default.

Syntax:

COLUMNS=n
export COLUMNS

Parameters:

Example:

COLUMNS=100
export COLUMNS

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. See the chapter Terminfo Database and Terminal Devices for further details on using the terminfo database. 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.

Most system software, for example sde, does not function correctly using widths of more or less than 80 columns. Adis functions correctly with any screen size.

See Also:

TERM
LINES

EXTFH

Specifies a configuration file to be used by the Callable File Handler.

Syntax:

EXTFH=filename.cfg 
export EXTFH

Parameters:

Example:

EXTFH=/home/mydir/myconfig.cfg
export EXTFH

Comments:

See the chapter File Handler API in your File Handling book for more details.

FHREDIR

Specifies a configuration file to be used by the Fileshare Client.

Syntax:

FHREDIR=filename.cfg 
export FHREDIR

Parameters:

Example:

FHREDIR=/home/mydir/myconfig.cfg
export FHREDIR

Comments:

See your Fileshare User's Guide for more details.

FS

Specifies a configuration file to be used by the Fileshare Server.

Syntax:

FS=filename.cfg 
export FS

Parameters:

Example:

FS=myconfig.cfg
export FS

Comments:

See your Fileshare User's Guide for more details.

FSCOMMS

Specifies that the Fileshare System is to run in single user mode.

Syntax:

FSCOMMS="\$local" 
export FSCOMMS

Parameters:

Comments:

See your Fileshare User's Guide for more details.

GNTANLZ

Specifies a configuration file for use by the GNT Analyzer utility.

Syntax:

GNTANLZ="filename" 
export GNTANLZ

Parameters:

Comments:

The configuration file specifies the GNT Analyzer options to be used for a file at run time. A default configuration file called gntanlz.cfg is supplied with the GNT Analyzer. For more information on GNT Analyzer and the configuration file, see the chapter GNT Analyzer in your Utilities Handbook.

LANG

Defines the locale.

Syntax:

LANG=language[_territory[.codepage]]
export LANG

Parameters:

Example:

LANG=fr_FR
export LANG

Comments:

For a full description of this environment variable, see the chapter Internationalization Support in your Programmer's Guide to Writing Programs

LD_LIBRARY_PATH

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 and HP/UX, which use a different environment variable. 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

Parameters:

Comments:

The list of directories must include $COBDIR/lib. The COBDIR environment variable is described earlier in this appendix.

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

See Also:

COBDIR
SHLIB_PATH
LIBPATH

LIBLIST

The COBOL system file $COBDIR/lib/liblist contains the list of libraries to be used by the Cob utility when it produces executable program files. LIBLIST specifies an alternative file for Cob to use; you should should not use it unless a Technical Support representative asks you to.

Syntax:

LIBLIST=pathname
export LIBLIST

Parameters:

LIBPATH

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 is only available on AIX-based systems and must be set to include $COBDIR/lib. It should also include any directories that contain callable shared objects used by your application.

Syntax:

LIBPATH=pathname[:pathname]...
export LIBPATH

Parameters:

Comments:

The list of directories must include $COBDIR/lib. The COBDIR environment variable is described earlier in this appendix. See the AIX documentation for more information.

Example:

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

See Also:

COBDIR
LD_LIBRARY_PATH
SHLIB_PATH

LINES

Specifies the depth of the terminal screen or window, overriding the specified terminal default.

Syntax:

LINES=n
export LINES

Parameters:

Example:

LINES=50
export 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. See the chapter Terminfo Database and Terminal Devices for further details on using the terminfo database. 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.

See Also:

TERM
COLUMNS

MFCODESET

Specifies which ASCII/EBCDIC translation table to use.

Syntax:

MFCODESET=nnnn
export MFCODESET

Parameters:

Example:

MFCODESET=2001
export MFCODESET

Comments:

You can modify _CODESET so that it uses ASCII/EBCDIC translation table that you have created. The value you supply to MFCODESET specifies which translation table to use.

See Also:

Configuring _CODESET with the Codecomp Utility in the chapter Internationalization Support in your Programmer's Guide to Writing Programs.

PATH

Specifies the directories to be searched by all UNIX programs, including the run-time system, when finding executables to be run.

Syntax:

PATH=pathname[:pathname]...
export PATH

Parameters:

Comments:

The list of directories should include $COBDIR/bin. The COBDIR environment variable is described earlier in this appendix.

Example:

PATH=$COBDIR/bin:$PATH
export PATH

See Also:

COBDIR
LD_LIBRARY_PATH
LIBPATH
SHLIB_PATH

SHLIB_PATH

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 is only available on HP/UX and must be set to include $COBDIR/lib. It should also include any directories that contain callable shared objects used by your application.

Syntax:

SHLIB_PATH=pathname[:pathname]...
export SHLIB_PATH

Parameters:

Comments:

The list of directories should include $COBDIR/lib. The COBDIR environment variable is described earlier in this appendix.

See your HP/UX documentation for more information.

Example:

SHLIB_PATH=$COBDIR/lib:/home/mydir/myapp:$SHLIB_PATH
export SHLIB_PATH

See Also:

COBDIR
LD_LIBRARY_PATH
LIBPATH

TERM

Defines the type of terminal being used.

Syntax:

TERM=name
export TERM

Parameters:

Example:

TERM=at386
export TERM

See Also:

COBTERMINFO
TERMINFO
LINES
COLUMNS
Terminfo Database and Terminal Devices

TERMINFO

Specifies the directory to be searched by all UNIX programs, including the run-time system, for the UNIX system terminfo database.

Syntax:

TERMINFO=pathname
export TERMINFO

Parameters:

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 as described earlier in this appendix.

See Also:

COBTERMINFO
TERM
Terminfo Database and Terminal Devices

TMPDIR

Specifies a directory in which to store temporary files in place of the UNIX system default.

Syntax:

TMPDIR=pathname
export TMPDIR

Parameters:

Comments:

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

Terminfo Database and Terminal Devices

EBCDIC/ASCII Translation Tables