cave perform
Name
cave-perform — Perform an action upon a package.
Synopsis
cave perform config spec
cave perform fetch | pretend-fetch [ --exclude-unmirrorable ] [ --fetch-unneeded ] [ --ignore-unfetched ] spec
cave perform info spec
cave perform install --destination repo [ --replacing spec … ] spec
cave perform pretend --destination repo [ --replacing spec … ] spec
cave perform pretend-fetch spec
cave perform uninstall [ --config-protect values ] spec
DESCRIPTION
Perform an action upon a package. Not suitable for direct use, although it may be useful in some more complex scripts.
OPTIONS
Global Options
Global options, used by every subcommand.
- -h , --help
- display help message
General Options
General options for all actions
- --if-supported (--no-if-supported)
- If the action is not supported, exit silently with success rather than erroring.
- --hooks (--no-hooks)
- Also execute the appropriate hooks for the action.
- --x-of-y
- Specify the value of the X_OF_Y variable that is passed to hooks.
- --no-terminal-titles
- Do not change terminal titles
- --managed-output
- Specify that our output is being managed by another process. Used by 'cave execute-resolution'; not for end user use.
- --output-exclusivity
Specify the exclusivity of our output. Should not be changed unless --managed-output is also specified
- exclusive
- Exclusive output (default)
- with-others
- With others
- background
- Backgrounded
Fetch Action Options
Options for if the action is 'fetch' or 'pretend-fetch'
- --exclude-unmirrorable (--no-exclude-unmirrorable)
- Do not include unmirrorable components
- --fetch-unneeded (--no-fetch-unneeded)
- Also fetch components that aren’t needed (e.g. because they are conditional upon disabled options
- --ignore-unfetched (--no-ignore-unfetched)
- Do not fetch any component that has not already been downloaded (but do verify components that have already been downloaded
- --ignore-manual-fetch-errors (--no-ignore-manual-fetch-errors)
- Ignore any errors that say that manual fetching is required for a component
- --regulars-only (--no-regulars-only)
- Only fetch regular components. If this option is not specified, the job cannot safely be backgrounded or run in parallel with installs
Install Action Options
Options for if the action is 'install' or (for --destination and --replacing) 'pretend'
- --destination
- The name of the repository to which the install should take place
- --replacing
- A spec that uniquely identifies an ID to be replaced as part of the install. May be specified multiple times.
- --skip-phase
- Skip the named phases
- --abort-at-phase
- Abort when a named phase is encounted
- --skip-until-phase
- Skip every phase until a named phase is encounted
Uninstall Action Options
Options for if the action is 'uninstall'
- --config-protect
- Specify additional items to include in the config protection list
IMPORT OPTIONS
Import Options
Options controlling additional imported packages. These options should not be specified manually; they are for use by 'cave import'.
- --unpackaged-repository-params
- Specifies the parameters used to construct an unpackaged repository, for use by 'cave import'.