aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-fetch.cli
diff options
context:
space:
mode:
Diffstat (limited to 'bpkg/pkg-fetch.cli')
-rw-r--r--bpkg/pkg-fetch.cli54
1 files changed, 54 insertions, 0 deletions
diff --git a/bpkg/pkg-fetch.cli b/bpkg/pkg-fetch.cli
new file mode 100644
index 0000000..ba1d5d9
--- /dev/null
+++ b/bpkg/pkg-fetch.cli
@@ -0,0 +1,54 @@
+// file : bpkg/pkg-fetch.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bpkg/configuration.cli>;
+
+"\section=1"
+"\name=bpkg-pkg-fetch"
+"\summary=fetch package archive"
+
+/*
+"\h{SYNOPSIS}
+
+bpkg pkg-fetch [<options>] (<pkg>/<ver>)|(-e <file>)"
+
+"\h{DESCRIPTION}
+
+The \cb{pkg-fetch} command fetches the archive for the specified package
+name and version from one of the configuration's repositories. If the
+\cb{-r|--replace} option is specified, then \cb{pkg-fetch} will replace the
+archive of a package that is already in the \cb{fetched} or \cb{unpacked}
+state. Otherwise, \cb{pkg-fetch} expects the package to not exist in the
+configuration's database.
+
+If the \cb{-e|--existing} option is used, then instead of the name and
+version argument, \cb{pkg-fetch} expects a local path to the existing
+package archive. In this case, \cb{bpkg} will use the archive 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 the archive when the package is purged with the
+\cb{pkg-purge} command."
+*/
+
+namespace bpkg
+{
+ class pkg_fetch_options: configuration_options
+ {
+ bool --replace|-r
+ {
+ "Replace the archive if the package is already fetched or unpacked."
+ }
+
+ bool --existing|-e
+ {
+ "Treat the argument as an existing package archive path rather than
+ package name/version to fetch."
+ }
+
+ bool --purge|-p
+ {
+ "Remove the existing package archive when the package is purged."
+ }
+ };
+}