DEPOT(1)

NAME
depot - manages software collections

SYNOPSIS
depot [ options ] [ -T targetdir ]

DESCRIPTION
depot manages the unified installation of diverse software collections into a single location.

Software collections may be any combination of files under a common location, but are usually composed of files associated with a single application. depot can be used to control the mapping of software from a diverse set of such collections onto the target location, [targetdir], specified by the -T option. This provides a consistent view of software at the target location. In the absence of a -T option, the [targetdir] defaults to one directory level above the current working directory.

Mapping of software from collections to the [targetdir] may be achieved by either making the appropriate symbolic links or by appropriately copying files from the collections to the target location. This and other aspects used to customize the installation of software by depot may be specified in a file called depot.pref in a special directory called depot under the [targetdir]. A description of possible customizations is available in depot.pref(5).

For each collection, the manner in which software under the collection's directory tree is mapped onto the software tree at the [targetdir] is specified in a file called depot.conf. This file is located at the top level of the collection's directory tree. If no depot.conf file exists, the entire directory tree of the collection is mapped onto the software tree at the [targetdir]. The depot.conf file is described in further detail in depot.conf(5).

OPTIONS

-T targetdir
    sets the target location onto which depot maps collections. This location is the [targetdir]. Defaults to one level above the current working directory. The targetdir value should be set to the top level of the environment (e.g. -T /usr/local)

-h  prints a help message

-n  causes depot to print out update actions, without actually doing any updating, no update mode.

-v  causes depot to send messages to the standard output describing its actions; verbose mode.

-x  prints a help and usage message.

-Q  trades off consistency of the target directory for speed. As a result, it does not detect if files are removed in the [targetdir]. This option may only be used after a successful run of depot without the -Q option.

PREFERENCE OPTIONS

The following command line arguments can override the values specified in the depot.pref preference file. The preference is specified by using the full preference name after two dashes (--). The value of the preference option is specified after an equal sign (=).

A description of the preference options can be found in the depot.pref(5) man page.

For BOOLEAN preference options, the value after the equal sign can be either 'TRUE' or 'FALSE'.

Only the following preference options are supported from the command line:

--usemodtimes=BOOLEAN
    The default value is TRUE.

--keepcopiedfileattributes=BOOLEAN
    The default value is TRUE.

--compresstargetdb=BOOLEAN
    The default value is TRUE.

LOCKING OPTIONS

-l  locks the [targetdir], thereby inhibiting further depot updates on the [targetdir].

-i  implicitly locked mode; enables the user to perform depot updates on [targetdir], even if a previous lock by that user is in place.

-u  unlocks the [targetdir], if and only if it was previously locked by the same user.

-U  breaks a lock on [targetdir] set by another user.

-L  breaks a lock on [targetdir] however, unlike -U above, it replaces the lock with a new one for the current user.

After a successful depot run has finished the lock file is removed from the environment, unless -n was specified.

COMPRESSION OPTIONS

The following options deal with changing the default compression behavior the target database (targetdb) in the depot.db file. These environment variables are NOT mandatory. Compression of this section of the depot database usually results in a 50% to 80% savings in disk space but is not required.

If present at compile time, the GNU zip (gzip) suite will be used. Otherwise, the stock UNIX compress suite is used. If neither is present, no compression will be done by default.

DEPOT_COMPRESS
    specifies the full path to the compression program to be used and any flags necessary to read the input from standard in and send the output to standard out.

DEPOT_DECOMPRESS
    specifies the full path to the decompression program to be used and any flags necessary to read the input from standard in and send the output to standard out.

Depot will exit with an error if the compression/decompression program does not understand the input so, for example, do NOT expect depot to properly decompress a targetdb compressed with gzip using uncompress.

FILES
depot.pref	environment configuration file
depot.conf	generated collection configuration file
depot.db	depot database file
depot.lock	lock file for depot

SEE ALSO
fsi_generate(1), hintservice(1), dpp(1), depot.pref(5), depot.conf(5)

AUTHOR
Sohan C. Ramakrishna-Pillai