PEMDATA_DICT

Section: File Formats (5)
Updated: November 2000
Index Return to Main Contents
 

NAME

pem_data_dictionary - XPAT Data Dictionary file format for pem databases  

DESCRIPTION

Each pem database has a Data Dictionary containing information to
- specify the hosts on which the databases are located
- specify the databases to use
- specify the locations of relevant files, such as the thesaurus and initialization files

A pem Data Dictionary is made up of several sections. Each section is delimited by ``tags'' - short labels enclosed by angle brackets: ``<'' and ``>''. For example, information about each host is preceeded by a <Host> start tag and is followed by a </Host> end tag. The slash (``/'') character is used to distinguish between end tags and start tags.

The following is an example pem Data Dictionary. Each of the sections used is explained after the example. Note that the sections, subsections, and fields are all enclosed by tags.  

EXAMPLE

This pem Data Dictionary will search four different databases. Three of these databases are on a host with the name textrine and one database is on a host with the name context. 


<InitFile>/usr/ot/pem/initfile</InitFile>
<Thesaurus>/usr/ot/pem/thesaurus</Thesaurus>
<Host>
    <Name>textrine</Name>

    <PatHandler>/usr/xpat/bin/XPatHandler</PatHandler>
    <File>
        <Name>/usr/xpat/business/bus.dd</Name>
        <Label>bus</Label>
        <Program>/usr/xpat/bin/xpat</Program>
    </File>
    <File>
        <Name>/usr/xpat/cps/cps.dd</Name>
        <Label>cps</Label>
        <Program>/usr/xpat/bin/xpat</Program>
    </File>
    <File>
        <Name>/usr/xpat/lis/lis.dd</Name>
        <Label>lis</Label>
        <Program>/usr/xpat/bin/xpat</Program>
    </File>
</Host>
<Host>
    <Name>context</Name>
    <File>
        <Name>/usr/xpat/ubs/ubs.dd</Name>
        <Label>ubs</Label>
        <Program>/usr/xpat/bin/xpat</Program>
    </File>
</Host>

 

InitFile FIELD

The InitFile field is enclosed by <InitFile> and </InitFile> tags. It contains the name of the file which is read by pem during initialization. Any legal pem command may be contained in the initialization file.

 

Thesaurus FIELD

The Thesaurus field is enclosed by <Thesaurus> and </Thesaurus> tags. It contains the name of the file with thesaurus definitions. The format of this file is described in the thesaurus section of the XPat Reference Manual and Tutorial.

 

Host SECTION

The Host section is enclosed by <Host> and </Host> tags. It contains a number of subsections which describe a host and the database(s) that are to be used on that host. There can be more than one host section, but there is usually only one host section per physical host.

 

Name FIELD

The Name field is enclosed by <Name> tags and contains the name of the host on which the databases are located. There may be only one Name field per Host section.

 

User FIELD

The User field is contained between <User> tags. It specifies the userid to use on the host specified by the Name field. This user is known as the `target user'. For pem to work properly, each pem user on the initiating machine must be able to rsh(1) to the machine specified in the Name field, under the target user's account and without a password. This means that either the target user's `.rhosts' file or the target machine's `/etc/hosts.equiv' file must be set up to allow this. There may be only one User field per Host section. If no target user is specified, the current user's userid is used.

 

PatHandler FIELD

The PatHandler field is enclosed by <PatHandler> tags and contains the name of the program that handles communication between pem and the various underlying xpat processes. There must be one and only one PatHandler field per Host section.

 

File SUBSECTION

The File subsection is contained within <File> and </File> tags. It specifies all the information for one underlying database. It contains subsections which describe the xpat Data Dictionary to use, the xpat program, the label to use, and which index to use in the Data Dictionary. There may be more than one File subsection per Host section.

 

Name FIELD

The Name field is enclosed by <Name> and </Name> tags. It specifies the xpat Data Dictionary or pem Data Dictionary for this database. There may be only one Name field per File subsection.

 

Index FIELD

The Index field is enclosed by <Index> and </Index> tags. It specifies the index to use. The specified index must be declared in the database's Data Dictionary. There may be only one Index field per File subsection. If no index is specified, the first index in the Data Dictionary is used.

 

Label FIELD

The Label field is enclosed by <Label> tags. There may be only one Label field per File subsection. This field must contain only alphanumerics, and begin with an alphabetic character. All labels within a single pem Data Dictionary must be unique.

 

Program FIELD

The Program field is enclosed by <Program> tags. It contains the name of the program that pem will execute. Generally, this will be xpat, but may be another instance of pem. There may be only one Program field per File subsection.  

SEE ALSO

xpat(1), xpatbld(1), xpatrgn(1), multirgn(1), pemdata_dict(5), xpat_export(5), regions(5)

 

Index

NAME
DESCRIPTION
EXAMPLE
InitFile FIELD
Thesaurus FIELD
Host SECTION
Name FIELD
User FIELD
PatHandler FIELD
File SUBSECTION
Name FIELD
Index FIELD
Label FIELD
Program FIELD
SEE ALSO
This document was created by man2html, using the manual pages.
Time: 18:03:38 GMT, March 26, 2001