From ad257079568746d71d913c6fca96852da6fe3bd6 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Mon, 11 Jan 2016 10:04:02 +0200
Subject: Reorganize .cli files, add man/xhtml page generation (via script for
 now)

---
 bpkg/pkg-unpack.cli | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 bpkg/pkg-unpack.cli

(limited to 'bpkg/pkg-unpack.cli')

diff --git a/bpkg/pkg-unpack.cli b/bpkg/pkg-unpack.cli
new file mode 100644
index 0000000..847ecb2
--- /dev/null
+++ b/bpkg/pkg-unpack.cli
@@ -0,0 +1,55 @@
+// file      : bpkg/pkg-unpack.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license   : MIT; see accompanying LICENSE file
+
+include <bpkg/configuration.cli>;
+
+"\section=1"
+"\name=bpkg-pkg-unpack"
+"\summary=unpack package archive"
+
+/*
+"\h{SYNOPSIS}
+
+bpkg pkg-unpack [<options>] <pkg>|(-e <dir>)"
+
+"\h{DESCRIPTION}
+
+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.
+
+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."
+*/
+
+namespace bpkg
+{
+  class pkg_unpack_options: configuration_options
+  {
+    bool --existing|-e
+    {
+      "Treat the argument as an existing package directory path rather than
+       package name to unpack."
+    }
+
+    bool --purge|-p
+    {
+      "Remove the existing package directory when the package is purged."
+    }
+
+    bool --replace|-r
+    {
+      "Replace the source directory if the package is already unpacked or
+       fetched. Can only be specified together with \cb{-e|--existing}."
+    }
+  };
+}
-- 
cgit v1.1