aboutsummaryrefslogtreecommitdiff
path: root/bpkg/rep-create.cli
blob: be4cc421e9d1bbdacc0e8c580f85657e7b2b608f (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
// file      : bpkg/rep-create.cli
// license   : MIT; see accompanying LICENSE file

include <bpkg/common.cli>;

"\section=1"
"\name=bpkg-rep-create"
"\summary=create repository"

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

    "\h|SYNOPSIS|

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

     \h|DESCRIPTION|

     The \cb{rep-create} command regenerates the \cb{packages.manifest} file
     based on the files present in the repository directory. If the
     \cb{repositories.manifest} file contains a certificate, then the
     \cb{signature.manifest} file is regenerated as well. In this case the
     \cb{--key} option must be used to specify the certificate's private
     key. If <dir> is not specified, then the current working directory is
     used as the repository root."
  }

  class rep_create_options: common_options
  {
    "\h|REP-CREATE OPTIONS|"

    bool --ignore-unknown
    {
      "Ignore unknown manifest entries."
    }

    string --key
    {
      "<name>",
      "Private key to use to sign the repository. In most cases <name> will
       be a path to the key file but it can also be a key id when a custom
       \cb{openssl} cryptographic engine is used."
    }
  };

  "
   \h|DEFAULT OPTIONS FILES|

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

   \
   bpkg.options
   bpkg-rep-create.options
   \

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

   \
   --key
   \
  "
}