Introduction

This chapter deals with the setup of the FML environment. Before you can begin to work with FML fielded buffers, or use the VIEWS functions that move fields between structures and fielded buffers, you have to take care of such details as setting environment variables appropriate for your application. These activities are described in this chapter.

Directory Structure

The delivered FML software will reside in a subtree of the local file system. Several of the FML modules assume that the structure of this subtree is as described in this section. It is assumed that the environment variable for the root directory is set.

The following directories exist under the root directory:

• include - contains header files needed by writers of C application code

• cobinclude - contains COPY files needed by writers of COBOL application code (this directory is named cobinclu for operating systems with an 8.3 file name limitation)

• bin - contains the executable commands of FML

• lib - contains subroutine packages of FML; when compiling a program that uses FML functions, $TUXDIR/lib/libfml.<suffix> and $TUXDIR/lib/libgp.<suffix> should be included on the C compiler command line to resolve external references; libfml32.<suffix> contains the FML32 and VIEW32 functions. (The suffix is .a for POSIX operating systems without shared objects, .so.release for use of shared objects, .lib for Windows95, Windows NT and OS/2; it is part of the BEA TUXEDO System DLL for platforms that use dynamic link libraries).

C application software using FML must include the following header files in this order:

#include <stdio.h>   
#include "fml.h"

The file fml.h or fml32.h contains definitions for structures, symbolic constants, and macros used by the FML software.

Environment Variables

Several environment variables are used by FML and VIEWS. This section gives a summary of their use.

The following variable is used in FML to search for system supplied files:

• TUXDIR: this variable should be set to the topmost node of the installed FML software.

The following variables are used throughout FML to access field table files (described in Chapter 4):

• FIELDTBLS: this variable should contain a comma separated list of field table files for the application. Files given as full path names are used as is; files listed as relative path names are searched for through the list of directories specified by the FLDTBLDIR variable. FIELDTBLS32 is used for FML32. If FIELDTBLS is not set, then the single file name fld.tbl is used (FLDTBLDIR still applies; see below).

• FLDTBLDIR: this variable specifies a colon separated list of directories to be used to find field table files with relative file names. Its usage is similar to the PATH environment variable. If FLDTBLDIR is not set or is null, then its value is taken to be the current directory. FLDTBLDIR32 is used for FML32.

In addition to the ones needed by FML (FLDTBLDIR and FIELDTBLS), two environment variables are used by VIEWS functions:

• VIEWFILES: this variable should contain a comma separated list of object viewfiles for the application. Files given as full pathnames are used as is; files listed as relative path names are searched for through the list of directories specified by the VIEWDIR variable (see below). VIEWFILES32 is used for VIEW32.

• VIEWDIR: this variable specifies a colon separated list of directories to be used to find view object files with relative file names. Its usage is similar to the PATH environment variable. If VIEWDIR is not set or is null, then its value is taken to be the current directory. VIEWDIR32 is used for VIEW32.