bpkg/rep-info.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

// file      : bpkg/rep-info.cli
// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <bpkg/common.cli>;

"\section=1"
"\name=bpkg-rep-info"
"\summary=print repository information"

namespace bpkg
{
  {
    "<options> <rep>",

    "\h|SYNOPSIS|

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

     \h|DESCRIPTION|

     The \cb{rep-info} command prints various information about the specified
     repository. By default it print the repository's name and location as the
     first line followed by the list of complement and prerequisite
     repositories and the list of available packages. This default behavior,
     however, can be altered in various ways using options listed below. Note
     that the information is written to \cb{STDOUT}, not \cb{STDERR}.

     If the current working directory contains a \cb{bpkg} configuration, then
     \cb{rep-info} will use its certificate database for the repository
     authentication. That is, it will trust the repository's certificate if it
     is already trusted by the configuration. Otherwise it will add the
     certificate to the configuration if you confirm it is trusted. You can
     specify an alternative configuration directory with the
     \cb{--directory|-d} option. To disable using the configuration in the
     current working directory pass this option with an empty path."
  }

  class rep_info_options: common_options
  {
    "\h|REP-INFO OPTIONS|"

    bool --name|-n
    {
      "Print the specified repository's name and location."
    }

    bool --repositories|-r
    {
      "Print the list of complement and prerequisite repositories."
    }

    bool --packages|-p
    {
      "Print the list of available packages."
    }

    bool --manifest|-m
    {
      "Instead of printing the information in the human-readable form, dump it
       as manifest(s). Normally you would use this option in combination with
       \cb{--packages|-p} or \cb{--repositories|-r} to only dump one of the
       manifests."
    }

    string --directory|-d // String to allow empty value.
    {
      "<dir>",
      "Use configuration in <dir> for the trusted certificate database."
    }
  };
}