aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-unpack-options.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-unpack-options.cli
parent302834a875804ff943dfb005682949fd3d404d01 (diff)
Reorganize .cli files, add man/xhtml page generation (via script for now)
Diffstat (limited to 'bpkg/pkg-unpack-options.cli')
-rw-r--r--bpkg/pkg-unpack-options.cli55
1 files changed, 0 insertions, 55 deletions
diff --git a/bpkg/pkg-unpack-options.cli b/bpkg/pkg-unpack-options.cli
deleted file mode 100644
index f5f2fd5..0000000
--- a/bpkg/pkg-unpack-options.cli
+++ /dev/null
@@ -1,55 +0,0 @@
-// file : bpkg/pkg-unpack-options.cli
-// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
-// license : MIT; see accompanying LICENSE file
-
-include <bpkg/configuration-options.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}."
- }
- };
-}