diff options
Diffstat (limited to 'bpkg/pkg-unpack.cli')
-rw-r--r-- | bpkg/pkg-unpack.cli | 47 |
1 files changed, 25 insertions, 22 deletions
diff --git a/bpkg/pkg-unpack.cli b/bpkg/pkg-unpack.cli index 847ecb2..67f37b7 100644 --- a/bpkg/pkg-unpack.cli +++ b/bpkg/pkg-unpack.cli @@ -8,37 +8,40 @@ include <bpkg/configuration.cli>; "\name=bpkg-pkg-unpack" "\summary=unpack package archive" -/* -"\h{SYNOPSIS} +namespace bpkg +{ + { + "<options> <pkg> <dir>", -bpkg pkg-unpack [<options>] <pkg>|(-e <dir>)" + "\h|SYNOPSIS| -"\h{DESCRIPTION} + \c{\b{bpkg pkg-unpack} [<options>] <pkg> | (-e <dir>)} -The \cb{pkg-unpack} command unpacks the archive for the previously -fetched (\cb{pkg-fetch}) package. If the \cb{-e|--existing} option -is used, then instead of the package name, \cb{pkg-unpack} expects -a local path to the existing package source 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{-p|--purge} option is specified, \cb{bpkg} will not attempt to -remove this directory when the package is purged with the \cb{pkg-purge} -command. + \h|DESCRIPTION| -If \cb{-e|--existing} is specified together with the \cb{-r|--replace} -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." -*/ + 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. + + 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)})." + } -namespace bpkg -{ class pkg_unpack_options: configuration_options { + "\h|PKG-UNPACK OPTIONS|" + bool --existing|-e { "Treat the argument as an existing package directory path rather than - package name to unpack." + the package name to unpack." } bool --purge|-p @@ -49,7 +52,7 @@ namespace bpkg bool --replace|-r { "Replace the source directory if the package is already unpacked or - fetched. Can only be specified together with \cb{-e|--existing}." + fetched. Can only be specified together with \cb{--existing|-e}." } }; } |