aboutsummaryrefslogtreecommitdiff
path: root/bdep/init.cli
blob: e293f031c3631a3ae228d8d947d466941768f261 (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
// file      : bdep/init.cli
// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

include <bdep/common.cli>;

"\section=1"
"\name=bdep-init"
"\summary=initialize project dependency management"

namespace bdep
{
  {
    "<options>
     <prj-spec> <prj-dir>
     <pkg-spec> <pkg-dir>
     <cfg-spec> <cfg-name> <cfg-dir>
     <cfg-args> <cfg-var> <module>
     <pkg-args> <pkg>",

    "\h|SYNOPSIS|

     \c{\b{bdep init} [<options>] [<pkg-spec>] [<cfg-spec>] [<pkg-args>]\n
        \b{bdep init} [<options>] [<prj-spec>] \b{--empty|-E}\n
        \b{bdep init} [<options>] [<pkg-spec>] \b{--config-add|-A} <cfg-dir> [\b{@}<cfg-name>]\n
        \b{bdep init} [<options>] [<pkg-spec>] \b{--config-create|-C} <cfg-dir> [\b{@}<cfg-name>] \\\n
        \ \ \ \ \ \ \ \ \ \ [<cfg-args>]}

     \c{<prj-spec> = \b{--directory}|\b{-d} <prj-dir>\n
        <pkg-spec> = (\b{--directory}|\b{-d} <pkg-dir>)... | <prj-spec>\n
        <cfg-spec> = (\b{@}<cfg-name> | \b{--config}|\b{-c} <cfg-dir>)... | \b{--all}|\b{-a}\n
        <pkg-args> = (<pkg> | <cfg-var>)...\n
        <cfg-args> = (<module> | <cfg-var>)...}

     \h|DESCRIPTION|

     The \cb{init} command...

     If <cfg-spec> is omitted, then the default configuration is assumed.

     If <pkg-spec> is omitted, then the current working directory is
     assumed. In this case the current directory must be either a project
     directory (<prj-dir>), a package directory (<pkg-dir>) or a subdirectory
     of package directory.

     <cfg-args> are arguments to \cb{bpkg cfg-create}. <pkg-args> are arguments
     to \cb{bpkg pkg-build}.

     In the first variant the configurations can also be specified as
     directories using the \cb{--config|-c} option.

     The second and third variants are semantically equivalent to first
     performing \cb{config add} and \cb{config create} (\l{bdep-config(1)}),
     respectively, followed by the first variant. In both cases the
     \cb{--default|-d} option can be used to make the added/created
     configuration default.
     "
  }

  class init_options: common_options
  {
    //"\h|INIT OPTIONS|"
  };
}