DEPOT.PREF(5)

NAME
depot.pref - depot customization instructions

SYNOPSIS
[targetdir]/depot/depot.pref

DESCRIPTION
The file depot.pref contains user-specified values for resources which may be used to tailor the behavior of depot(1). Resources are specified as strings of the form:

preferencefunction operand value or preferencefunction value or preferencefunction operand

one on each line, in the depot.pref file.

The first form, preferencefunction operand value, is used to specify resources which are to be applied on a per collection basis, per target basis or to a command label. If the resource is to be applied to a collection, an asterisk (*) may be used in place of the collection-name to instruct depot(1) to apply the preference to all collections.

The second form, preferencefunction value, is used for resources which apply to the depot(1) program in general.

The third form, preferencefunction operand, is used for resources which apply to a collection or target path without further modifiers.

Lines in depot.pref starting with a # are treated as comments and are ignored by depot(1).

Depot(1) recognizes the following resources:

command commandlabel commandname argumentlist specifies the
    actual command and list of arguments to be associated with the given commandlabel. If the commandname does not start with a /, it is assumed that it is either a file to be installed by depot(1) or an executable to be searched for using the PATH environment variable. As with most lists in depot(1), the list of arguments in argumentlist must be separated commas.

filter  filterlabel filtername argumentlist Specifies the actual
    filter and list of arguments to be associated with the given filterlabel. If the filtername does not start with a /, it is assumed that it is either a file to be installed by depot(1) or an executable to be searched for using the PATH environment variable. Unlike most lists in depot(1), the list of arguments in argumentlist are separated by one or more white spaces instead of commas. When the filter is executed, its standard in and standard out will be directed to the respective input and output files, and the standard error will go to depot(1)'s standard error. For the convenience of filters that need to know the name of the file they're running on, the symbols %from and %to will be replaced with the respective from and to paths. The default filterlabels defined for installing files are copy, link, delete, noop, and default.

target.command commandlabel targetpath
    specifies that depot(1) is to execute the command specified by the commandlabel whenever anything is installed into the given targetpath.

hintfile collectionname filename
    specifies a file from which depot(1) may obtain information about the date of the last modification of the named collection. By default, the hintfile used is [targetdir]/depot/depot.hint. Hintfiles are optional.

ignore collectionlist
    specifies a list of collections that should not be installed by depot(1).

collection.installmethod  filterlabel  collectionlist
    specifies the method that depot(1) will use to install software from the specified list of collections. If an installmethod has not been specified for the collection, the default installmethod is link.

target.installmethod  filterlabel targetpathlist
    specifies the method that depot(1) will use to install the specified list of files or directories under [targetdir]. This preference overrides any collection-specific installmethod preference for these files.

target.modemask mask targetpathlist
    specifies that depot(1) is to install the paths in targetpathlist. If the path specifies a directory, depot(1) will install the files under the given path with the file's mode bits masked by the given mask.

override collectionname collectionlist
    specifies a list of collections whose software contributions may be overwritten by the named collection if a conflict occures during installation. depot(1) may not function correctly if there are conflicting overrides.

path collectionname collectionpath
    specifies the directory where software for the named collection resides. The collectionpath must be either an absolute pathname or a path relative to the [targetdir]. For this resource, the use of * for the collection name is invalid.

searchpath collectionname pathlist
    specifies a list of directories under which depot(1) will search for the named collection if a path has not been specified for the collection. The pathnames must be either absolute pathnames or paths relative to the targetdir. By default, a collection for which a searchpath has not been specified will be searched for under [targetdir]/depot.

target.owner username targetpathlist
    specifies that when depot(1) installs files into the directories given by targetpathlist, the files will then be set to the given username.

target.group groupname targetpathlist
    specifies that when depot(1) installs files into the directories given by targetpathlist, the files will then be set to the given groupname.

target.setuid username targetpathlist
    specifies that depot(1) is to install paths in the given targetpathlist under targetdir as an executable. This sets the user-id to that of the given username upon execution.

target.setgid groupname targetpathlist
    specifies that depot(1) is to install paths in the given targetpathlist under targetdir as an executable. This sets the group-id to that of the given groupname upon execution.

specialfile targetpathlist
    specifies a list of files or directories under targetdir which should not be updated or modified in any way by depot(1) during its operation. Any attempt by a collection to modify a file or directory tree specified in the targetpathlist will cause depot(1) to exit with an error message. specialfile can also be used to "hide" files and directories in a collection.

usemodtimes true|false
    specifies whether or not depot(1) should use modification time information when performing installations by copy. This option is not used on files which use the default installmethod of link.. By default, the value is set to TRUE.

keepcopiedfileattributes true|false
    If this option is set to true, depot(1) will copy a file exactly. That is, the mode bits, the owner, and the gid will be copied. If this option is set to be false, then the owner and gid will be the owner and gid of the process doing the copy. The mode bits will also be masked by 0777 so that any setuid/setgid bits will be eliminated. This option is not used on files which use the default installmethod of link. By default, the value is set to TRUE.

compresstargetdb true|false
    specifies whether or not depot(1) should compress the target database. Compression of the target database can save a significant amount of disk space, but doing so currently requires depot(1) to consume more swap space. By default, the value is set to TRUE.

version collectionname versionnumber
    specifies the version of the named collection which depot(1) is to use during installation. If no version is specified, the version found with the highest version number is used by depot(1). Versions for collections are specified by appending a version number following a delimiter to the collection name. For example, with the default version delimiter of ~, version 11 of a collection named foo would be specified as
    foo~11

versiondelimiter character
    specifies the character used to delimit version numbers. The default delimiter is a tilde (~).

AUTHOR
Sohan C. Ramakrishna-Pillai

SEE ALSO
depot(1)