aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-unpack.cli
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2018-02-19 21:47:04 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2018-02-21 17:42:43 +0300
commit89dd478de7cf075beac69d0145df46f914cf35cf (patch)
treebe960f2406d087135c6456cff654de1f24a91557 /bpkg/pkg-unpack.cli
parentd75d1d9e1c5b03b17fdea1fa3638db2bfe5e8d12 (diff)
Add support for pkg-checkout
Diffstat (limited to 'bpkg/pkg-unpack.cli')
-rw-r--r--bpkg/pkg-unpack.cli21
1 files changed, 12 insertions, 9 deletions
diff --git a/bpkg/pkg-unpack.cli b/bpkg/pkg-unpack.cli
index 87ac6e4..f4da2c2 100644
--- a/bpkg/pkg-unpack.cli
+++ b/bpkg/pkg-unpack.cli
@@ -19,19 +19,22 @@ namespace bpkg
\h|DESCRIPTION|
- The \cb{pkg-unpack} command unpacks the archive for the previously fetched
- (\l{bpkg-pkg-fetch(1)}) package. If the \cb{--existing|-e} option is used,
- then instead of the package name, \cb{pkg-unpack} expects a local path to
- an existing package directory. In this case, \cb{bpkg} will use the
- directory in place, without copying it to the configuration or package
- cache directories. Also, unless the \cb{--purge|-p} option is specified,
- \cb{bpkg} will not attempt to remove this directory when the package is
- later purged with the \l{bpkg-pkg-purge(1)} command.
+ The \cb{pkg-unpack} command unpacks the archive for the previously
+ fetched (\l{bpkg-pkg-fetch(1)}) package. The resulting package state is
+ \cb{unpacked} (\l{bpkg-pkg-status(1)}).
+
+ If the \cb{--existing|-e} option is used, then instead of the package
+ name, \cb{pkg-unpack} expects a local path to an existing package
+ directory. In this case, \cb{bpkg} will use the directory in place,
+ without copying it to the configuration or package cache directories.
+ Also, unless the \cb{--purge|-p} option is specified, \cb{bpkg} will not
+ attempt to remove this directory when the package is later purged with
+ the \l{bpkg-pkg-purge(1)} command.
If \cb{--existing|-e} is specified together with the \cb{--replace|-r}
option, then \cb{pkg-unpack} will replace the archive and/or source
directory of a package that is already in the \cb{unpacked} or
- \cb{fetched} state (\l{bpkg-pkg-status(1)})."
+ \cb{fetched} state."
}
class pkg_unpack_options: configuration_options