UPS/UPD Doc Home page | Computing Division| Fermilab at Work | Fermilab Home View/print PDF file
	Complete Guide and Reference Manual for UPS, UPD and UPP v4

Chapter Contents

Chapter 31: The UPS Configuration File
  31.1 dbconfig File Organization
  31.2 Keywords Used in dbconfig
  31.3 Sample dbconfig File

Chapter 31: The UPS Configuration File

---

A UPS database can be configured and customized using the file dbconfig, described in this chapter. This file is usually maintained in the location $PRODUCTS/.upsfiles/dbconfig. It is used to define keywords which control quantities such as:

• which nodes can access products maintained in the database
• the directory under which products are installed
• which products will have usage statistics collected
• the directories for product man pages and Info files
• the directory containing the UPS initialization files
• the directory containing the UPD configuration file
• the UPS database version

A template dbconfig file is available in $UPS_DIR/ups/dbconfig.template.

31.1 dbconfig File Organization

The dbconfig file consists of keyword definitions. It always has as its first line:

File = dbconfig

to identify itself to the system. The additional keywords can be in any order.

31.2 Keywords Used in dbconfig

Keyword	Description and Notes
AUTHORIZED_NODES	nodes authorized to access the database (set value to "*" to allow all nodes access; for a list of nodes, separate nodes with colons)
CATMAN_TARGET_DIR	directory into which catman files are to be copied
FILE	type of file (must be set to DBCONFIG)
HTML_TARGET_DIR	directory into which html files are to be copied Not yet supported.
INFO_TARGET_DIR	directory into which Info files are to be copied
MAN_TARGET_DIR	directory into which formatted man pages are to be copied
NEWS_TARGET_DIR	directory into which news files are to be copied (for posting to a newsgroup) Not yet supported.
PROD_DIR_PREFIX	product root directory prefix (directory under which all or most product instances are maintained); must be an absolute path
SETUPS_DIR	location of setups.[c]sh files and other UPS initialization files (note that "courtesy links" in /usr/local/etc should be created to point to this directory; see section 2.7.1 Initializing the UPS Environment)
STATISTICS	flag to record statistics for specified products (see section 28.6.3 STATISTICS for usage information)
UPD_USERCODE_DIR	directory where UPD configuration file is maintained (usually $PRODUCTS/.updfiles/)
UPS_DB_VERSION	UPS database version

31.3 Sample dbconfig File

FILE = DBCONFIG 
 
# all nodes can read/use the products declared in this db 
AUTHORIZED_NODES = * 
 
# all product roots are under /fnal/ups/prd 
PROD_DIR_PREFIX = /fnal/ups/prd 
 
# keep statistics about the following products: 
#   (uncomment to get stats!) 
# STATISTICS = ups:upd:perl 
 
# manpages, info files, get copied here: 
MAN_TARGET_DIR = /fnal/ups/man 
CATMAN_TARGET_DIR = /fnal/ups/catman 
# INFO_TARGET_DIR = /fnal/ups/Info 
 
#  automatic html and news processing not yet supported 
#  HTML_TARGET_DIR = /dev/null 
#  NEWS_TARGET_DIR = /dev/null 
 
#  setups.[c]sh scripts are copied here 
#  ('courtesy links' in /usr/local/etc should point here): 
SETUPS_DIR = /fnal/ups/etc 
 
#   upd configuration for this db are here: 
UPD_USERCODE_DIR = /fnal/ups/db/.updfiles 
 

UPS/UPD Doc Home page | Computing Division| Fermilab at Work | Fermilab Home View/print PDF file

This page generated on: 10/15/02 14:09:24