Project

General

Profile

TOC PREV NEXT
Fermilab CD logo Complete Guide and Reference Manual for UPS and UPD

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 Keyword Description and Notes Description and Notes
AUTHORIZED_NODES AUTHORIZED_NODES nodes authorized to access the database nodes authorized to access the database (set value to " * " to allow all nodes access; for a list of nodes, separate nodes with colons) (set value to " * " to allow all nodes access; for a list of nodes, separate nodes with colons)
CATMAN_TARGET_DIR CATMAN_TARGET_DIR directory into which catman files are to be copied directory into which catman files are to be copied
FILE FILE type of file (must be set to DBCONFIG) type of file (must be set to DBCONFIG)
INFO_TARGET_DIR INFO_TARGET_DIR directory into which Info files are to be copied directory into which Info files are to be copied
MAN_TARGET_DIR MAN_TARGET_DIR directory into which formatted man pages are to be copied directory into which formatted man pages are to be copied
PROD_DIR_PREFIX PROD_DIR_PREFIX product root directory prefix (directory under which all or most product instances are maintained); must be an absolute path product root directory prefix (directory under which all or most product instances are maintained); must be an absolute path
SETUPS_DIR SETUPS_DIR location of setups.[c]sh files and other UPS initialization files 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 ) (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 STATISTICS flag to record statistics for specified products flag to record statistics for specified products (see section 28.6.3 STATISTICS for usage information) (see section 28.6.3 STATISTICS for usage information)
UPD_USERCODE_DIR UPD_USERCODE_DIR directory where UPD configuration file is maintained (usually $PRODUCTS/.updfiles/ ) directory where UPD configuration file is maintained (usually $PRODUCTS/.updfiles/ )
UPS_DB_VERSION UPS_DB_VERSION UPS database 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 the following:
PROD_DIR_PREFIX = ${UPS_THIS_DB}/../prd

# keep statistics about the following products:
#   (uncomment to get stats!)
# STATISTICS = ups:upd:perl

#
# manpages get copied here:
MAN_TARGET_DIR = ${UPS_THIS_DB}/../man
CATMAN_TARGET_DIR = ${UPS_THIS_DB}/../catman

# this db contains the ups product; 
#   copy the setups.[c]sh and cached files to this directory:
SETUPS_DIR = ${UPS_THIS_DB}/../etc

# this db contains the upd product; 
#   look for the upd configuration and user callouts here:
UPD_USERCODE_DIR = ${UPS_THIS_DB}/../db/.updfiles

 

TOC PREV NEXT

Last revised on May 2014

TOC PREV NEXT
Fermilab CD logo Complete Guide and Reference Manual for UPS and UPD

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 Keyword Description and Notes Description and Notes
AUTHORIZED_NODES AUTHORIZED_NODES nodes authorized to access the database nodes authorized to access the database (set value to " * " to allow all nodes access; for a list of nodes, separate nodes with colons) (set value to " * " to allow all nodes access; for a list of nodes, separate nodes with colons)
CATMAN_TARGET_DIR CATMAN_TARGET_DIR directory into which catman files are to be copied directory into which catman files are to be copied
FILE FILE type of file (must be set to DBCONFIG) type of file (must be set to DBCONFIG)
INFO_TARGET_DIR INFO_TARGET_DIR directory into which Info files are to be copied directory into which Info files are to be copied
MAN_TARGET_DIR MAN_TARGET_DIR directory into which formatted man pages are to be copied directory into which formatted man pages are to be copied
PROD_DIR_PREFIX PROD_DIR_PREFIX product root directory prefix (directory under which all or most product instances are maintained); must be an absolute path product root directory prefix (directory under which all or most product instances are maintained); must be an absolute path
SETUPS_DIR SETUPS_DIR location of setups.[c]sh files and other UPS initialization files 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 ) (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 STATISTICS flag to record statistics for specified products flag to record statistics for specified products (see section 28.6.3 STATISTICS for usage information) (see section 28.6.3 STATISTICS for usage information)
UPD_USERCODE_DIR UPD_USERCODE_DIR directory where UPD configuration file is maintained (usually $PRODUCTS/.updfiles/ ) directory where UPD configuration file is maintained (usually $PRODUCTS/.updfiles/ )
UPS_DB_VERSION UPS_DB_VERSION UPS database 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 the following:
PROD_DIR_PREFIX = ${UPS_THIS_DB}/../prd

# keep statistics about the following products:
#   (uncomment to get stats!)
# STATISTICS = ups:upd:perl

#
# manpages get copied here:
MAN_TARGET_DIR = ${UPS_THIS_DB}/../man
CATMAN_TARGET_DIR = ${UPS_THIS_DB}/../catman

# this db contains the ups product; 
#   copy the setups.[c]sh and cached files to this directory:
SETUPS_DIR = ${UPS_THIS_DB}/../etc

# this db contains the upd product; 
#   look for the upd configuration and user callouts here:
UPD_USERCODE_DIR = ${UPS_THIS_DB}/../db/.updfiles

 

TOC PREV NEXT

Last revised on May 2014