aboutsummaryrefslogtreecommitdiff
path: root/bpkg/bpkg-options.cli
blob: cfdf9d960463957e73b2a6baf5e1a931274b02eb (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
// file      : bpkg/bpkg-options.cli
// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <bpkg/common-options.cli>;

"\section=1"
"\name=bpkg"
"\summary=build2 package manager"

namespace bpkg
{
  {
    "<command> <topic> <common-options> <command-options> <command-args>",

    "\h|SYNOPSIS|

     \cb{bpkg --help}\n
     \cb{bpkg --version}\n
     \c{\b{bpkg help} [<command>|<topic>]}\n
     \c{\b{bpkg} [<common-options>] <command> [<command-options>] <command-args>}

     \h|DESCRIPTION|

     @@ TODO

     Note that the common options can also be specified as part of the
     command-specific options."
  }

  class commands
  {
    "\h|COMMANDS|"

    bool help
    {
      "[<topic>]",
      "Show help for a command or help topic \- \l{bpkg-help(1)}.",
      ""
    }

    bool build
    {
      "<pkg>...",
      "Build one or more packages \- \l{bpkg-build-options(1)}.",
      ""
    }

    bool drop
    {
      "<pkg>...",
      "Drop one or more packages.",
      ""
    }

    bool pkg-verify
    {
      "<archive>",
      "Verify archive is a valid package.",
      ""
    }

    bool pkg-status
    {
      "<pkg>", // [/<ver>]: 24
      "Print package status.",
      ""
    }

    bool pkg-fetch
    {
      "<pkg>/<ver>",
      "Fetch package archive.",
      ""
    }

    bool pkg-unpack
    {
      "<pkg>",
      "Unpack package archive.",
      ""
    }

    bool pkg-purge
    {
      "<pkg>",
      "Purge package.",
      ""
    }

    bool pkg-configure
    {
      "<pkg>",
      "Configure package.",
      ""
    }

    bool pkg-disfigure
    {
      "<pkg>",
      "Disfigure package.",
      ""
    }

    bool pkg-update
    {
      "<pkg>",
      "Update package.",
      ""
    }

    bool pkg-clean
    {
      "<pkg>",
      "Clean package.",
      ""
    }

    bool cfg-create
    {
      "[<conf>]",
      "Create configuration.",
      ""
    }

    bool rep-add
    {
      "<rep>",
      "Add repository to configuration.",
      ""
    }

    bool rep-fetch
    {
      "",
      "Fetch available packages list.",
      ""
    }

    bool rep-info
    {
      "<rep>",
      "Print information about repository.",
      ""
    }

    bool rep-create
    {
      "[<dir>]",
      "Create repository manifest file.",
      ""
    }
  };

  // Make sure these don't conflict with command names above.
  //
  class topics
  {
    "\h|HELP TOPICS|"

    bool common-options
    {
      "Options common for all commands \- \l{bpkg-common-options(1)}."
    }
  };

  class options: common_options
  {
    bool --help;
    bool --version;
  };
}