Complete Guide and Reference Manual for UPS, UPD and UPP v4

Manual intro page - Contents - Index - Quick Reference Card
Table File Chapter - UPS product page

List of Supported Keywords to Use in Table Files

Links in the table have not been made to work. To access the links, go to the complete keyword table in section 27.4 List of Supported Keywords.

Keyword and Default Value (if any)	Description and Notes (if any)
ACTION	defines an action (described in Chapter 33: Actions and ACTION Keyword Values), i.e., groups together a list of functions associated with a command (e.g., ACTION=SETUP)
CATMAN_SOURCE_DIR Default: under the ${UPS_UPS_DIR}/ toman/catman directory	location of catman files (formatted man page files) included with instance
COMMON:	groups together actions that apply to all instances represented in "GROUP:"; COMMON: is only valid within a GROUP:
DESCRIPTION	product description
END:	marks the end of a "GROUP:" or "COMMON:"; one "END:" marker is used to jointly end a "GROUP:" and an included "COMMON:"
FILE	type of file (possible values: DBCONFIG, UPDCONFIG, CHAIN, VERSION, TABLE)
FLAVOR	product instance flavor Note: To easily accommodate flavor-neutral setup functions in a table file, FLAVOR can take the value ANY, but only in a table file.
GROUP:	groups together multiple instances; all entries subsequent to this "GROUP:" are part of it until an "END:" marker is reached
HTML_SOURCE_DIR Default: under the ${UPS_UPS_DIR}/ tohtml directory	location of html files included with instance not supported in UPS v4
INFO_SOURCE_DIR Default: under the ${UPS_UPS_DIR}/ toInfo directory	location of Info files included with instance
MAN_SOURCE_DIR Default: under the ${UPS_UPS_DIR}/ toman/man directory	location of unformatted man page files included with instance
NEWS_SOURCE_DIR Default: under the ${UPS_UPS_DIR}/ tonews directory	location of news files included with instance not supported in UPS v4
PRODUCT	product name
QUALIFIERS	additional instance specification information often used to indicate compilation options used by developer Notes: appears immediately after a FLAVOR in these files, and is coupled with it to complete the instance identification (see 26.2.3 Qualifiers: Use in Instance Matching)
UPS_DB_VERSION	UPS database version
USER	current username
VERSION	product version
_UPD_OVERLAY	main product name for overlaid product Note: This keyword is user-defined from UPS's point of view. It is included here because it is configured and used by UPD. Its use with overlaid products is described in section 27.6.6 _UPD_OVERLAY.

Usage Notes on Particular Keywords

_UPD_OVERLAY

The _UPD_OVERLAY keyword defined in UPD is provided for inclusion in the table file of each overlaid product. Overlaid products are introduced in section 1.3.7 Product Overlays and discussed again for developers in section 16.2.4 Overlaid Products. _UPD_OVERLAY takes as its value the main product name in double quotes. Its presence indicates that the product is an overlaid product maintained in the root directory of the main product listed as the keyword's value. For example, the table files for the products cern_bin, cern_ups, and cern_lib would contain the following keyword line:

_UPD_OVERLAY="cern"

UPD would then use cern as the product name when determining the root directory.