bpkg/pkg-purge-options.cli


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

// file      : bpkg/pkg-purge-options.cli
// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <bpkg/configuration-options.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."
    }
  };
}