aboutsummaryrefslogtreecommitdiff
path: root/bpkg/rep-remove.cli
blob: de92271c75a80e183d2ca23e515899b14353ad45 (plain)
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
47
48
49
50
51
52
53
54
55
// file      : bpkg/rep-remove.cli
// copyright : Copyright (c) 2014-2019 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <libbpkg/manifest.hxx>;

include <bpkg/configuration.cli>;

"\section=1"
"\name=bpkg-rep-remove"
"\summary=remove repository from configuration"

namespace bpkg
{
  {
    "<options> <rep-name> <rep-loc>",


    "\h|SYNOPSIS|

     \c{\b{bpkg rep-remove}|\b{remove} [<options>] (<rep-name>|<rep-loc>)...\n
        \b{bpkg rep-remove}|\b{remove} [<options>] \b{--all}|\b{-a}\n
        \b{bpkg rep-remove}|\b{remove} [<options>] \b{--clean}}


     \h|DESCRIPTION|

     The \cb{rep-remove} command removes the specified package repositories
     from the configuration. The repository to remove can be specified either
     as a repository name or as a repository location (URL or a directory
     path).

     Alternatively, the \cb{--all|-a} option can be used to remove all the
     repositories that were previously added (\l{bpkg-rep-add(1)}) to the
     configuration.

     Finally, the \cb{--clean} option can be used to revert the repositories
     to the clean state, as if they were added but never fetched."
  }

  class rep_remove_options: configuration_options
  {
    "\h|REP-REMOVE OPTIONS|"

    bool --all|-a
    {
      "Remove all the repositories."
    }

    bool --clean
    {
      "Clean the repository state."
    }
  };
}