aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-purge.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-11 10:04:02 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-11 10:04:02 +0200
commitad257079568746d71d913c6fca96852da6fe3bd6 (patch)
treed7a59392a1159c630c4fd0ccad816e9fd3acadf3 /bpkg/pkg-purge.cli
parent302834a875804ff943dfb005682949fd3d404d01 (diff)
Reorganize .cli files, add man/xhtml page generation (via script for now)
Diffstat (limited to 'bpkg/pkg-purge.cli')
-rw-r--r--bpkg/pkg-purge.cli46
1 files changed, 46 insertions, 0 deletions
diff --git a/bpkg/pkg-purge.cli b/bpkg/pkg-purge.cli
new file mode 100644
index 0000000..da618d3
--- /dev/null
+++ b/bpkg/pkg-purge.cli
@@ -0,0 +1,46 @@
+// file : bpkg/pkg-purge.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bpkg/configuration.cli>;
+
+"\section=1"
+"\name=bpkg-pkg-purge"
+"\summary=purge package"
+
+/*
+"\h{SYNOPSIS}
+
+bpkg pkg-purge [<options>] <pkg>"
+
+"\h{DESCRIPTION}
+
+The \cb{pkg-purge} command removes the package directory and archive
+from the filesystem and removes the package from the configuration's
+database. Only packages in the \cb{fetched} and \cb{unpacked} state can
+be purged plus \cb{broken} packages if the \cb{-f|--force} options is
+specified (see this option's description for details on purging broken
+packages). If the \cb{-k|--keep} option is specified, then the package
+archive is not removed (see this option's description for details on
+this mode)."
+*/
+
+namespace bpkg
+{
+ class pkg_purge_options: configuration_options
+ {
+ bool --keep|-k
+ {
+ "Keep the package archive. Note that in this mode the package is
+ still retained in the configuration's database in the \cb{fetched}
+ state."
+ }
+
+ bool --force|-f
+ {
+ "Purge a broken package. In this mode \cb{bpkg} will verify that
+ the package directory and archive no longer exist and will remove
+ the package from the configuration's database."
+ }
+ };
+}