|
Option
|
Description
|
|
-?
|
Prints help on screen. For csh: use "-?" with quotes.
|
|
-a
|
Operates on all instances that match the other options given.
|
|
-f <flavorList>
|
Specifies flavor. Multiple values can usually be specified. See also -H and the
number options -0, -1, -2, and -3.
|
|
-g <chain> or
-c, -d, -n, -o, -t
|
Specifies products associated with the given chain (chain flags pre-defined for
c
urrent,
d
evelopment,
n
ew,
o
ld,
t
est).
|
|
-G "<declareOpts>"
|
Used by
ups
copy,
upd
cloneproduct, and
upd
install, specifies options to pass to the internally-run
ups
declare to customize local declaration.
|
|
-h <host>
|
Used in UPD commands only. Specifies distribution host. Can specify plain host
name, host and Webserver port, or full URL to the ups.cgi cgi script. Default:
fnkits.fnal.gov.
|
|
-H <flavorList>
|
Specifies flavor and builds a flavor list starting at the level specified.
Multiple values accepted. Used without -0, -1, -2, or -3, finds best match.
Used with -0, -1, -2, or -3, finds specified level of flavor. E.g., -2H
IRIX+6.2 is like -f IRIX+6.
|
|
-j
|
Ignores dependencies, operates just on top level product.
|
|
-K <keywordList>
|
Returns values of specified keywords only.
|
|
-m <tableFileName>
|
Specifies table file name.
|
|
-M <tableFileDir>
|
Specifies table file directory.
|
|
-q <qualifierList>
|
Specifies required or optional qualifiers.
|
|
-r <prodRootDir>
|
Specifies the product root directory.
|
|
-R
|
Retrieves/operates on only the required dependencies.
|
|
-s
|
Lists what command would do; but does not execute the command.
|
|
-z <databaseList>
|
Specifies the local database(s).
|
|
-Z
|
Times the command.
|
|
-0, -1, -2, -3
|
Equivalent to -f or -H with zero, one, two, or three components of the local or
specified system flavor. E.g., for IRIX+6.2: -0=-f NULL, -1=-f IRIX and -1 -H
IRIX+6.2=IRIX.
|
|
Option
|
Description
|
|
-A <nodeList>
|
Specifies nodes authorized to access the product.
|
|
-b <compileFile>
|
Specifies name of the output file for the
ups
compile command.
|
|
-C
|
When initially declaring a product, -C prevents execution of CONFIGURE action.
When declaring a chain, -C prevents execution of the corresponding chain
action.
|
|
-D "<origin>"
|
Specifies the product's master source file.
|
|
-f <flavor>
|
Specifies flavor.
|
|
-g <chain> or
-c, -d, -n, -o, -t
|
Declares chain.
|
|
-O "<flags>"
|
Sets the value of $UPS_OPTIONS to <flags>.
|
|
-p "<description>"
|
Specifies product description.
|
|
-q <qualifiers>
|
When initially declaring a product, -q specifies qualifiers to include in the
declaration. When adding a chain, -q specifies qualifiers to identify the
instance.
|
|
-r <prodRootDir>
|
Specifies the product root directory.
|
|
-T <path or URL>
|
Specifies archive file path or URL. Used only when adding products to archive
distribution databases.
|
|
-z <databaseList>
|
Specifies the local database in which to declare the product; or, if adding a
chain, that in which product is declared.
|
|
-0, -1, -2, -3
|
See -0, -1, -2, -3 under
Commonly
Used Options (General).
|
|
Keyword
|
Description
|
|
ARCHIVE_FILE
|
archive (e.g., tar) file name/location
|
|
AUTHORIZED_NODES
|
nodes authorized to use product; "*" used for all nodes
|
|
CATMAN_SOURCE_DIR
|
location of catman files included with instance
|
|
CATMAN_TARGET_DIR
|
directory into which catman files are to be copied
|
|
CHAIN
|
chain name
|
|
COMPILE_DIR
|
directory containing compile file
|
|
COMPILE_FILE, @COMPILE_FILE
|
name of the file containing compiled functions (with @, entire path to compile
file)
|
|
DECLARED
|
date/time that the instance was declared to UPS or declared with a chain
|
|
DECLARER
|
userid of user that performed the declaration
|
|
DESCRIPTION
|
product description
|
|
FLAVOR
|
product instance flavor
|
|
INFO_SOURCE_DIR
|
location of Info files included with instance
|
|
INFO_TARGET_DIR
|
directory into which Info files are to be copied
|
|
MAN_SOURCE_DIR
|
location of unformatted man page files included with instance
|
|
MAN_TARGET_DIR
|
directory into which formatted man pages are to be copied
|
|
MODIFIED
|
date/time of most recent time change
|
|
MODIFIER
|
userid of user that modified the instance
|
|
ORIGIN
|
master source file
|
|
PRODUCT
|
product name
|
|
PROD_DIR, @PROD_DIR
|
product root directory (with @, entire path to root directory)
|
|
PROD_DIR_PREFIX
|
product root directory prefix (dir containing PROD_DIR)
|
|
QUALIFIERS
|
additional instance specification information often used to indicate
compilation options used by developer
|
|
SETUPS_DIR
|
location of setups.[c]sh files and other UPS init files
|
|
STATISTICS
|
flag to record statistics for specified products
|
|
TABLE_DIR
|
location of table file
|
|
TABLE_FILE, @TABLE_FILE
|
name of table file (with @, entire path for table file)
|
|
UPD_USERCODE_DIR
|
Directory where UPD configuration files are maintained
|
|
UPS_DIR, @UPS_DIR
|
location of
ups
directory (with @, entire path to
ups
directory)
|
|
VERSION
|
product version
|
|
+
|
equivalent to "PRODUCT:VERSION:FLAVOR:QUALIFIERS:CHAIN"
|
|
Function
|
Description (R=Reversible)
|
|
addAlias(<NAME>, <VALUE>)
|
Add an alias (csh) or function (sh). R
|
|
doDefaults([<ACTION>])
|
Perform default functions (valid for only SETUP and UNSETUP). R
|
|
envAppend(<VARIABLE>, <value>
[, <delimiter>])
|
Append <value> to existing variable. R
|
|
envPrepend(<VARIABLE>, <value>
[, <delimiter>])
|
Prepend <value> to existing variable. R
|
|
envRemove(<VARIABLE>, <value>
[, <delimiter>])
|
Remove the string <value> from existing variable.
|
|
envSet(<VARIABLE>, <value>)
|
Set a new variable. R
|
|
envSetIfNotSet(<VARIABLE>, <value>)
|
Set a new variable, if not already set.
|
|
envUnset(<VARIABLE>)
|
Unset existing variable.
|
|
exeAccess(<executable>)
|
Check for access to executable through the $PATH. If not found, exit with
error.
|
|
exeActionOptional("<newaction>")
|
Process the functions associated with action. Do not fail if action not found.
R
|
|
exeActionRequired("<newaction>")
|
Process the functions associated with action. Fail if action doesn't exist. R
|
|
execute("<command>", <UPS_ENV_FLAG>, [,
<VARIABLE>])
|
Execute a shell-independent command and (opt.) assign output to a variable.
|
|
fileTest(<file>, <test> [, <errormessage>])
|
Run a shell test on <file>, fail if not true
|
|
pathAppend(<VARIABLE>, <value> [, <delimiter>])
|
Append <value> to existing $PATH-like variable. R
|
|
pathPrepend(<VARIABLE>, <value> [, <delimiter>])
|
Prepend <value> to existing $PATH-like variable. R
|
|
pathRemove(<VARIABLE>, <value> [, <delimiter>])
|
Remove the string <value> from existing $PATH-like variable. R
|
|
pathSet(<VARIABLE>, <value>)
|
Set a $PATH-like variable. R
|
|
prodDir()
|
Set the $<PRODUCT>_DIR variable. R
|
|
setupEnv()
|
Set the $SETUP_<PRODUCT> variable so that product can later be unsetup. R
|
|
setupOptional("[<options>] <product> [<version>]")
|
Setup a UPS product as a dependency, do not fail if the product doesn't exist.
R
|
|
setupRequired("[<options>] <product> [<version>]")
|
Setup a UPS product as a dependency; fail if product not found. R
|
|
sourceCompileOpt("<fileName>")
|
If <fileName> exists, source it and skip remaining functions; else
continue.
|
|
sourceCompileReq("<fileName>")
|
Source <fileName> and skip all remaining functions; fail if file not
found.
|
|
sourceOptCheck(<SCRIPT>.${UPS_SHELL}, UPS_ENV_FLAG [, EXIT_FLAG])
|
Check if specified script exists and if so, source it and check return status
for error. If error, abort script and return. R
|
|
sourceOptional(<SCRIPT>.${UPS_SHELL}, UPS_ENV_FLAG [,EXIT_FLAG])
|
Check if <SCRIPT> exists and if so, source it. If script not found,
continue. R
|
|
sourceReqCheck(<SCRIPT>.${UPS_SHELL}, UPS_ENV_FLAG [, EXIT_FLAG])
|
Source <SCRIPT> and check return status for error; fail if script not
found. R
|
|
sourceRequired(<SCRIPT>.${UPS_SHELL}, UPS_ENV_FLAG [, EXIT_FLAG])
|
Source <SCRIPT>; fail if script not found. Return status not checked. R
|
|
unAlias(<NAME>)
|
Remove specified alias/function.
|
|
unProdDir()
|
Unset $<PRODUCT>_DIR. R
|
|
unsetupEnv()
|
Unset $SETUP_<PRODUCT>. R
|
|
unsetupOptional("[<options>] <product>
[<version>]")
|
Run unsetup on a product; if unable, do not fail. R
|
|
unsetupRequired("<options>] <product> [<version>]")
|
Run unsetup on a product; fail if product not found. R
|
|
writeCompileScript("<fileName>", "<ACTION>" [,
OLD|DATE])
|
Write a file of compiled functions for the given ACTION keyword value.
|
|
Variable
|
Description
|
|
${PRODUCTS}
|
List of UPS databases; like $PRODUCTS
|
|
${UPS_COMPILE}.
|
Location and name of file with compiled functions
|
|
${UPS_EXTENDED}
|
Set to 1 if the -e (extended) option given in setup
|
|
${UPS_OPTIONS}
|
Option string passed with -O (upper case o) flag
|
|
${UPS_ORIGIN}
|
Location of the master source files
|
|
${UPS_OS_FLAVOR}
|
OS flavor as obtained from
ups
flavor
|
|
${UPS_PROD_DIR}
|
Product root directory; like $<PRODUCT>_DIR
|
|
${UPS_PROD_FLAVOR}
|
Product flavor chosen during instance matching
|
|
${UPS_PROD_NAME}
|
Product name as declared in the UPS database
|
|
${UPS_PROD_QUALIFIERS}
|
Product qualifiers declared with instance
|
|
${UPS_PROD_VERSION}
|
Product version as declared in the UPS database
|
|
${UPS_SHELL}
|
The shell family, sh or csh
|
|
${UPS_SOURCE}
|
Either "." or "source", as per ${UPS_SHELL}
|
|
${UPS_THIS_DB}
|
Database in which product instance is declared
|
|
${UPS_UPS_DIR}
|
Path to the product instance's
ups
directory
|
|
${UPS_VERBOSE}
|
Set to 1 if the -v (verbose) option specified
|
