aboutsummaryrefslogtreecommitdiff
path: root/bpkg/rep-list.cli
blob: 50c6373128ee423e0672fd5d52b5005e12d075ea (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
56
57
58
59
60
61
62
63
64
65
66
// file      : bpkg/rep-list.cli
// license   : MIT; see accompanying LICENSE file

include <libbpkg/manifest.hxx>;

include <bpkg/configuration.cli>;

"\section=1"
"\name=bpkg-rep-list"
"\summary=list repositories in configuration"

namespace bpkg
{
  {
    "<options>",

    "\h|SYNOPSIS|

     \c{\b{bpkg rep-list}|\b{list} [<options>]}

     \h|DESCRIPTION|

     The \cb{rep-list} command lists the repositories in the configuration.

     For each repository a line containing the repository name and location is
     printed to \cb{stdout}. If the \cb{--complements|-c} and/or
     \cb{--prerequisites|-p} options are specified, then it is followed by
     the list of complement and/or prerequisite repositories, recursively."
  }

  class rep_list_options: configuration_options
  {
    "\h|REP-LIST OPTIONS|"

    bool --complements|-c
    {
      "List complement repositories."
    }

    bool --prerequisites|-p
    {
      "List prerequisite repositories."
    }
  };

  "
   \h|DEFAULT OPTIONS FILES|

   See \l{bpkg-default-options-files(1)} for an overview of the default
   options files. For the \cb{rep-list} command the search start
   directory is the configuration directory. The following options files are
   searched for in each directory and, if found, loaded in the order listed:

   \
   bpkg.options
   bpkg-rep-list.options
   \

   The following \cb{rep-list} command options cannot be specified in the
   default options files:

   \
   --directory|-d
   \
  "
}