PURPOSE

environment - a list of environment variables in the TUXEDO System

DESCRIPTION

In order to compile application clients and servers, and run the TUXEDO System, it is important that the proper environment variables be set and exported. This manual page provides a list of the most frequently used variables.

The environment variables are grouped in the following sections:

Operating System Variables

Key TUXEDO System Variables

Variables for Field Table Files, View Files and MIO

File System and TLOG Variables

/WS Variables

System/Q Variables

COBOL Variables

DEBUG Variables

Additional Miscellaneous Variables

Operating System Variables

CC

standard C compiler for use by buildserver and other TUXEDO commands.

CFLAGS

contains flags to be used by the C compiler.

EDITOR

specifies the editor to be invoked by TUXEDO.

LANG

used to set the locale for language specification. See nl_types(5).

LOGNAME

specifies the user name for use in error messages.

LD_LIBRARY_PATH

must be set to the pathname for runtime shared libraries.

NLSPATH

specifies the pathname for the message catalog. If not specified, a default path is used. See nl_paths(5).

PAGER

specifies the paging command used for paging output in qmadmin(1), tmadmin(1). This overrides the system default ( pg(1) on UNIX operating systems).

PATH

contains pathnames to be searched for executables.

SHELL

the shell program to be invoked by TUXEDO.

TERM

specifies terminal type, if a terminal is used.

TMPDIR

the pathname of the directory where all temporary files should be written.

TZ

on systems where the ANSI C mktime functions does not exist, TZ must be set to use the TUXEDO gp_mktime(3c) function.

More information on these variables is available in the UNIX System man page environ(5).

Key TUXEDO System Variables

In general, the following environment variables should be set and exported:

APPDIR

full pathname of the base directory for application files.

APP_PW

may be used to specify a password for system clients that prompt for an application password (when security is on). Setting the password in a variable allows the password to be provided from a script, rather than demanding manual entry.

ENVFILE

this variable is used by tmloadcf(1). It customarily contains setting for other TUXEDO System environment variable, which are set automatically by the system.

TLOGDEVICE

the pathname for the transaction log. This should be the same as the TLOGDEVICE specified in the configuration file for the application.

TUXCONFIG

the pathname of the binary configuration file to be loaded by tmloadcf(1).

ULOGPFX

prefix of the filename of the central event log; default, ULOG.

TUXDIR

specifies the base directory where the TUXEDO System software is installed.

More information about these variables can be found in the BEA TUXEDO Programmer's Guide and the BEA TUXEDO Administrator's Guide.

Variables for Field Table Files, View Files and MIO

The following environment variables are used by FML and VIEWS and by mio(1) clients:

FIELDTBLS

comma-separated list of field table files.

VIEWFILES

comma-separated list of binary view files.

FLDTBLDIR

colon-separated list of directories to search for FIELDTBLS files.

VIEWDIR

colon-separated list of directories to search for VIEWFILES files.

MASKPATH

list of directories for mio(1) to search for binary masks.

MSKIPCKEY

the IPC key for shared memory for a mask cache.

NGXACTS

a comma-separated list of masks the current user is not permitted to use.

OKXACTS

a comma-separated list of masks the current user is permitted to use.

More information about these variables can be found in the BEA TUXEDO Administrator's Guide, the BEA TUXEDO Programmer's Guide, and the BEA TUXEDO FML Programmer's Guide.

File System and TLOG Variables

The following variables are used by the TUXEDO System file system and the transaction log.

FSCONFIG

the pathname for the Universal Device List.

FSMAXCOMMIT

sets the maximum size of the commit buffer.

FSMAXUPDATE

sets the size of the update list and the maximum number of updates.

FSMSGREP

sets the message repetition interval.

FSOFFSET

specifies an offset into the Universal Device List.

/WS Variables

The following variables are used on /WS client machines:

WSBUFFERS

the number of packets per application.

WSDEVICE

the network device to be used for network access. For workstation clients in Release 6.4 and higher, this variable is no longer needed.

WSENVFILE

pathname of a file containing /WS client environment variables.

WSNADDR

the network address of the native site network listener.

WSRPLYMAX

the maximum message size before a message is dumped to a file for transfer.

WSTYPE

the machine type of the workstation machine.

More information on these variable can be found in the BEA TUXEDO /Workstation Guide.

System/Q Variables

The following environment variable is used by TUXEDO System/Q:

QMCONFIG

sets the device where queue space is available to System/Q.

There is more information on this in the BEA TUXEDO /Q Guide.

COBOL Variables

The following environment variables are used with COBOL:

ALTCC

specifies the compiler for use with COBOL compilations.

ALTCFLAGS

flags to be passed to the COBOL compiler.

COBCPY

directories to be searched for COBOL Copy files.

COBDIR

specifies the directory where COBOL compiler software is located.

COBOPT

contains command line arguments for the COBOL compiler.

There is more information on these variables in the BEA TUXEDO COBOL Guide.

Additional Miscellaneous Variables

The following additional environment variables may be of use:

MHSCACHE

specifies the number of message catalog handles to keep open (TUXEDO System messages only). The default is 3.

PMID

in MP mode, can be used to specify the physical machine id.

TAGENTLOG

used to set the pathname for the tlisten(1) log.

TMCMPLIMIT

used to specify whether compression should be used on messages and to set thresholds for both local and remote messages. The syntax of the variable is:

	TMCMPLIMIT=[remote_threshold[,local_threshold]]

A threshold is a number in the range 0 to MAXLONG. It sets the minimum byte size for a message on which data compression will be performed.

TMCMPPRFM

This variable sets the compression level for any process that picks it up. Valid values are the integers 1 through 9; 1 results in somewhat less compression than the higher levels, but takes place faster. An informational ULOG message is written when a process reads TMCMPPRFM.

TMNETLOAD

used to establish load balancing over a network. The value is an arbitrary number of units to be added to the load factor of remote services. Use of this variable tends to force the use of a local service.

UIMMEDSIGS

to override deferral of signals, set this variable to "Y".

USPOOLDIR

names a directory to be used by the FRMPRT(5) server for temporary files. It defaults to /tmp.

SEE ALSO

buildclient(1),
buildserver(1),
viewc(1)
cc(1), environ(5) in a UNIX System reference manual